search

Nukkit-coders / MobPlugin

Add animals and monsters including AI, spawning and spawners to Cloudburst Nukkit
https://nukkitx.com/resources/mobplugin.3/
87 stars 49 forks source link

Any documentation at all? #220

Open petercwallis opened 3 years ago

petercwallis commented 3 years ago

Info

This is:

Installing and using the plugin is easy, but modifying it, or creating another plugin that uses it is impossible as it is just not documented. I tried running javadoc over the source so I could at least get a set of public methods, but no, it's maven only by the looks of things. Could we have the documentation generated and put here somewhere please. This is not a feature request - it is a bug report. Perhaps with documentation others would then fix some of the other issues.

PetteriM1 commented 3 years ago

You can still check how stuff work from the code. Also javadoc with mvn javadoc:javadoc should work just fine or at least that's how I generated http://suomicraftpe.ddns.net/javadocs/mobplugin-nukkitx/

Pull requests that adds more documentation to the code are welcome.

petercwallis commented 3 years ago

Thanks - that is exactly what I was looking for. I will see how I go writing a bit of a tutorial...

On Fri, 30 Apr 2021, 10:16 PetteriM1, @.***> wrote:

You can still check how stuff work from the code. Also javadoc with mvn javadoc:javadoc should work just fine or at least that's how I generated http://suomicraftpe.tk/javadocs/mobplugin-nukkitx/

Pull requests that adds more documentation to the code are welcome.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/Nukkit-coders/MobPlugin/issues/220#issuecomment-829961033, or unsubscribe https://github.com/notifications/unsubscribe-auth/ALY3LWMYJX2472VNK4QVL43TLJYQFANCNFSM433J6P3Q .