npc-lib icon indicating copy to clipboard operation
npc-lib copied to clipboard

Documentation.

Open DxsSucuk opened this issue 2 years ago • 5 comments

Asking for a documentation. For example

  • Usage of texture values in a profile (to use custom skins instead of players skin)
  • How to genuially destroy the NPCs
  • etc.

DxsSucuk avatar Jan 06 '23 12:01 DxsSucuk

@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!

DxsSucuk avatar Jan 20 '23 08:01 DxsSucuk

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

vytskalt avatar Jan 20 '23 08:01 vytskalt

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?

DxsSucuk avatar Jan 20 '23 11:01 DxsSucuk

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

SplotyCode avatar Feb 12 '23 18:02 SplotyCode

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

mybe avatar Jul 31 '23 04:07 mybe

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

derklaro avatar Aug 19 '24 16:08 derklaro