9319c291e6 | ||
---|---|---|
src | ||
.gitignore | ||
LICENSE.md | ||
README.md |
README.md
NPCLib – Basic non-player character library.
This is an API made specifically for spigot servers (Minecraft). Current supported versions: 1.8 - 1.12. Lightweight replacement for Citizens. NPCLib only uses packets instead of registering the entity in the actual Minecraft server.
Notice
If any developer out there knows how to convert this project to Maven, please consider contacting me or creating a pull request. I have yet to come up with a good solution for the (older) NMS code repositories. I would love to add a CI system to this repository for easier collaboration.
Donate
Alternatively, you can help the project by starring the repository or telling others about NPCLib 😄
Code Example
// First we define our (global) library variable.
// This is usually done in the onEnable method.
NPCLib lib = new NPCLib(plugin);
// Creating an NPC.
NPC npc = lib.createNPC(skin, lines);
// The generate the packets for the NPC.
npc.create(location);
// Then *finally* you can show/hide it to/from players.
npc.show(player);
npc.hide(player);
// If you don't use the NPC anymore, destroy the NPC accordingly.
npc.destroy();
Usable events: NPCSpawnEvent
, NPCDestroyEvent
and NPCInteractEvent
.
Usage
NPCLib is licensed under the MIT license. Developers are free to use NPCLib for both private and commercial use. Though, it would be nice to acknowledge me.
You (the developer) can also contact me if you wish to be added to the list below.
Plugin(s) using NPCLib:
- PremiumHub (by Vouchs).
Acknowledgement
We thank all those who have contributed to the creation of what NPCLib is today.
Copyright
Copyright (c) Jitse Boonstra 2018 All rights reserved.