77 lines
3.8 KiB
Markdown
Executable File
77 lines
3.8 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)
|
||
[](https://www.spigotmc.org/resources/npclib.55884/)
|
||
=
|
||
|
||
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.
|
||
|
||
\*You can find a version of NPCLib with basic support for 1.7.10 on the [legacy branch](https://github.com/JitseB/NPCLib/tree/legacy). This branch is not (as) actively maintained as the master branch. This version does not support multi-line text (yet).
|
||
|
||
### 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:
|
||
|
||
## Roadmap
|
||
|
||
- :heavy_check_mark: Spawn and destroy NPC (version 1.8 - latest).
|
||
- :heavy_check_mark: Autohide NPC when out of range.
|
||
- :heavy_check_mark: Add support for 1.7.10 (1.7 R4).
|
||
- :heavy_check_mark: Documentation material.
|
||
- :construction: Option to rotate head to player (when nearby).
|
||
- :construction: Add support for animated text (update-able holograms).
|
||
- :x: Give NPC armor and items in hand.
|
||
- :x: Multi-line text support for 1.7.10 (1.7 R4).
|
||
|
||
### Roadmad Legend
|
||
:heavy_check_mark: Feature is fully implemented and functional. <br>
|
||
:construction: Feature is still in development (or experimental). <br>
|
||
:x: Development of feature has yet to be started. <br>
|
||
|
||
## 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.
|
||
|
||
[Click here](https://github.com/JitseB/NPCLib/blob/master/DOCUMENTATION.md) for an elaborate explanation on how to use NPCLib in your next project.
|
||
|
||
### 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.
|
||
|
||
Please view the credits [here](https://github.com/JitseB/NPCLib/blob/master/CREDITS.md).
|
||
|
||
## Copyright
|
||
|
||
Copyright (c) Jitse Boonstra 2018 All rights reserved.
|