Go to file
Jitse Boonstra b8a7dcaddb More fiddling around with Sonatype.... 2019-06-03 23:30:50 +02:00
commons Making NPCLib ready for Sonatype 2019-06-03 12:26:15 +02:00
nms More fiddling around with Sonatype.... 2019-06-03 23:30:50 +02:00
plugin More fiddling around with Sonatype.... 2019-06-03 23:30:50 +02:00
.gitignore Few Maven changes and added a build script. 2018-05-06 17:20:12 +02:00
.travis.yml Attempt to make Travis CI config faster. 2019-02-21 12:47:16 +01:00
CREDITS.md Added DOCUMENTATION, CREDITS and changed README. 2019-02-19 22:55:24 +01:00
DOCUMENTATION.md Added DOCUMENTATION, CREDITS and changed README. 2019-02-19 22:55:24 +01:00
LICENSE.md Added a proper license (MIT license). 2018-04-19 18:00:24 +02:00
README.md Update README. 2019-05-02 18:01:31 +02:00
build.sh Updates for v1.3. 2018-11-25 14:10:56 +01:00
pom.xml More fiddling around with Sonatype.... 2019-06-03 23:30:50 +02:00
release.properties More fiddling around with Sonatype.... 2019-06-03 23:30:50 +02:00

README.md

Banner NPCLib Basic non-player character library.
Release Build Status JDK Versions Resource

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. 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)

YouTube Video

Donate

PayPal

Alternatively, you can help the project by starring the repository or telling others about NPCLib. 😄

Roadmap

  • ✔️ Spawn and destroy NPC (version 1.8 - latest).
  • ✔️ Autohide NPC when out of range.
  • ✔️ Add support for 1.7.10 (1.7 R4).
  • ✔️ Documentation material.
  • 🚧 Option to rotate head to player (when nearby).
  • 🚧 Add support for animated text (update-able holograms).
  • Give NPC armor and items in hand.
  • Multi-line text support for 1.7.10 (1.7 R4).

Roadmad Legend

✔️ Feature is fully implemented and functional.
🚧 Feature is still in development (or experimental).
Development of feature has yet to be started.

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 to download the latest release.

Click here for an elaborate explanation on how to use NPCLib in your next project.

Building your own version

  1. Download 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. 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:

Acknowledgement

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

Please view the credits here.

Copyright (c) Jitse Boonstra 2018 All rights reserved.