Go to file
JitseB 7cfde040da Added chunk unload event listener. 2018-04-19 15:26:42 +02:00
src Added chunk unload event listener. 2018-04-19 15:26:42 +02:00
.gitignore Added /out dir to .gitignore. 2018-04-16 07:45:36 +02:00
README.md Added chunk unload event listener. 2018-04-19 15:26:42 +02:00

README.md

NPCLib Basic non-player character library.
Release JDK Versions

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

PayPal

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

Developers are only allowed to use NPCLib if they acknowledge the author of NPCLib (JitseB) with a link to this repository in the description of their resource. NPCLib comes without warranty. I (JitseB) cannot be held responsible for any damage. You may open an issue if you are experiencing issues with NPCLib.

You (the developer) can also contact me if you wish to be added to the list below.

Plugin(s) using NPCLib:

Acknowledgement

We thank all those who have contributed to the creation of what NPCLib is today.

Copyright (c) Jitse Boonstra 2018 All rights reserved.