84 lines
3.3 KiB
Markdown
Executable File
84 lines
3.3 KiB
Markdown
Executable File
|
||
NPCLib – Basic non-player character library.<br>
|
||
[](https://github.com/JitseB/NPCLib/releases)
|
||
[](https://travis-ci.com/JitseB/NPCLib)
|
||
[](http://jdk.java.net/8/)
|
||
[](https://github.com/JitseB/NPCLib/releases)
|
||
=
|
||
|
||
This is an API made specifically for spigot servers (Minecraft). Current supported versions: **1.8 - 1.13.2**. Lightweight replacement for Citizens. NPCLib only uses packets instead of registering the entity in the actual Minecraft server.
|
||
|
||
**SpigotMC Resource** https://www.spigotmc.org/resources/npclib.55884/
|
||
**SpigotMC Thread** https://www.spigotmc.org/threads/npclib-–-basic-non-player-character-library.314460/
|
||
|
||
**Preview** (click to play video)
|
||
|
||
[](http://www.youtube.com/watch?v=LqwdqIxPIvE "NPCLib – Basic non-player character library (Minecraft).")
|
||
|
||
## Donate
|
||
|
||
[](https://paypal.me/jitseboonstra)
|
||
|
||
Alternatively, you can help the project by starring the repository or telling others about NPCLib. :smile:
|
||
|
||
## Developers
|
||
|
||
### Usage
|
||
|
||
It is recommended to shade `npclib-api-v*.jar` into your plugin.
|
||
Alternatively, you can put `npclib-plugin-v*.jar` under your `plugins` folder. By doing this, you no longer need to shade the API JAR. Though, do not forget to add `NPCLib` as a dependency in your `plugin.yml`!
|
||
|
||
|
||
[Click here](https://github.com/JitseB/NPCLib/releases/latest) to download the latest release.
|
||
|
||
```Java
|
||
// First we define our (global) library variable.
|
||
// This is usually done in the onEnable method.
|
||
NPCLib lib = new NPCLib(plugin);
|
||
```
|
||
|
||
```Java
|
||
|
||
// Creating a new NPC instance.
|
||
NPC npc = lib.createNPC(skin, lines);
|
||
|
||
// Then let the library generate the necessary packets.
|
||
npc.create(location);
|
||
|
||
// You are all set! You can now show/hide it to/from players.
|
||
npc.show(player);
|
||
npc.hide(player);
|
||
|
||
// If you do not wish to use the NPC anymore, destroy it accordingly.
|
||
npc.destroy();
|
||
```
|
||
|
||
### Events
|
||
|
||
Events you may want to use are `NPCSpawnEvent`, `NPCDestroyEvent` and `NPCInteractEvent`.
|
||
|
||
### Building your own version
|
||
|
||
1. [Download](https://github.com/JitseB/NPCLib/archive/master.zip) or clone this repository.
|
||
2. Build the plugin using `sh build.sh`. Alternatively, you can build the API JAR manually using `mvn clean install`.
|
||
|
||
You can build the plugin using `mvn clean install -pPlugin`.
|
||
|
||
## License and plugins using NPCLib
|
||
|
||
NPCLib is licensed under the [MIT license](https://github.com/JitseB/NPCLib/blob/master/LICENSE.md).
|
||
Developers are free to use NPCLib for both private and commercial use. However, 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](https://www.spigotmc.org/resources/premiumhub-a-new-recode-is-soon-here.32110/) (by Vouchs).
|
||
|
||
## Acknowledgement
|
||
|
||
We thank all those who have [contributed](https://github.com/JitseB/NPCLib/graphs/contributors) to the creation of what NPCLib is today.
|
||
|
||
## Copyright
|
||
|
||
Copyright (c) Jitse Boonstra 2018 All rights reserved.
|