API documentation and general usability

[A248]

I and another developer were considering using the AdvancedReplay API. Specifically, we're looking to start and stop replays. However, we have some questions and concerns.

• The updates section on the SpigotMC resource page notes 'API changes' in some updates, and git history confirms some of these are breaking. Are you willing to commit to semantic versioning in order to guarantee API stability? Most prominent public libraries follow semver and therefore avoid breaking changes in the same major version.
• Will the project use a build system such as maven or gradle anytime soon? It's likely we'll use jitpack, but it is still preferable for dependencies to have build metadata.
• ReplayAPI isn't documented. Will you document public methods, including their parameters and effects?
• We want to be sure we don't advertise a hook with a plugin which might cause problems for users. Your package com.comphenix.protocolwrapper is outside the AdvancedReplay namespace, and therefore may cause conflicts with other plugins making the same mistake. Could you look into relocating this?

[Jumper251]

I will use semantic versioning for breaking api changes. Relocating the packetwrappers shouldn't be much work, so I can probably add that in the next update.

I am planning to migrate the project to maven but not sure when.

[Aldiwildan77]

Any update for this? glad to see if this concern has already been implemented 😄