juliarn / npc-lib

Asynchronous, high-performance Minecraft NPC library for 1.8-1.21 servers.
MIT License
296 stars 50 forks source link

Documentation. #87

Closed DxsSucuk closed 2 days ago

DxsSucuk commented 1 year ago

Asking for a documentation. For example

DxsSucuk commented 1 year ago

@derklaro is there documentation planned? Or is there already somesort of one that could allow newer developers to use the api easier without spending most of their time finding out how it works?

For example I would love to use it, but there is not actual documentation that could give me a lead on what I can do and what I can't so I am really looking forward to this!

vytskalt commented 1 year ago

You can see some examples here https://github.com/juliarn/NPC-Lib/releases/tag/3.0.0-beta1

DxsSucuk commented 1 year ago

There is but its not showing more information, for example how to use a skin texture value instead of an actual player skin? Is there a right or wrong way to destroy NPCs, are you even able to destroy them? Do you need to use a NPC-Pool? Are there performance gains from doing so?

SplotyCode commented 1 year ago

You can use setProperty on com.github.juliarn.npc.profile.Profile Like this: profile.setProperty(new Profile.Property("textures", texture, signature));. I believe you are forced to use a npc pool

mybe commented 1 year ago

This looks like a great resource, but how is there no documentation? A releases page with a couple examples is not documentation.

derklaro commented 2 days ago

I just added documentation and a bunch of code examples into the readme, feel free to leave feedback if something is missing.