You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Jitse Boonstra e0752c5d7e Updated the library. 5 years ago
api Updated the library. 5 years ago
nms Updated the library. 5 years ago
plugin Updated the library. 5 years ago
.gitignore Few Maven changes and added a build script. 6 years ago
.travis.yml Attempt to make Travis CI config faster. 5 years ago
CREDITS.md Added DOCUMENTATION, CREDITS and changed README. 5 years ago
DOCUMENTATION.md Added DOCUMENTATION, CREDITS and changed README. 5 years ago
LICENSE.md Added a proper license (MIT license). 6 years ago
README.md Update README. 5 years ago
build.sh Updates for v1.3. 5 years ago
pom.xml Updated the library. 5 years ago
release.properties More fiddling around with Sonatype.... 5 years ago

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.