Separate the API away from the plugin #125
Conversation
|
| You can also shade the API into your existing plugin and initialize it using | ||
| ```java | ||
| NoteBlockAPI.initializeAPI(this) | ||
| ``` |
There was a problem hiding this comment.
I personally wouldn't mind this, but strictly speaking it would be a violation of the LGPL license chosen by the original author of the NoteBlockAPI. If you shade the library and use a relocation (which you should always do in this case), then it is no longer possible to replace it with a modified version unless your plugin is open source, because Java has no mechanism that would allow that. I suggest to remove this part of the README or to mention the fact that plugins that shade the API have to be open source.
| @@ -23,9 +21,10 @@ | |||
| /** | |||
| * Main class; contains methods for playing and adjusting songs for players | |||
| */ | |||
| public class NoteBlockAPI extends JavaPlugin { | |||
| public class NoteBlockAPI { | |||
There was a problem hiding this comment.
Unfortunately, there are plugins that rely on the fact that NoteBlockAPI class is JavaPlugin. Therefore, this would be a breaking change.
|
No problem, I understand. |
Love this API, although I'm wanting to use it without installing it on the server. I shaded it and then realized you couldn't access the API due to the API being so baked into the plugin.
I've removed 0 features, only separated the API from the plugin.
I also put the jitpack url / dependency on the README for easy copy & paste.
I highly appreciate the library you've created!!