Skip to content
(Minecraft) NPCLib – Basic non-player character library.
Java
Branch: master
Clone or download
JitseB Merge pull request #43 from A248/master
Update ChunkListener to fix a minor NPE bug
Latest commit 1d92363 Nov 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Add issue template Aug 8, 2019
api Update ChunkListener to fix a minor NPE bug Nov 7, 2019
examples Missing setSkin method on Example 3 Aug 7, 2019
nms
plugin Removed 1.8 R1 support (and updated version id to v2.3.1) Nov 4, 2019
.gitignore For v1.2 - Added 1.13 support. Aug 18, 2018
.travis.yml Fixed travis-ci error. Aug 3, 2019
CREDITS.md Added DOCUMENTATION, CREDITS and changed README. Feb 19, 2019
DOCUMENTATION.md Update DOCUMENTATION.md Aug 3, 2019
LICENSE.md For v1.2 - Added 1.13 support. Aug 18, 2018
README.md Updated artifact version. Oct 29, 2019
pom.xml Removed 1.8 R1 support (and updated version id to v2.3.1) Nov 4, 2019
release.properties More fiddling around with Sonatype.... Jun 3, 2019

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.14.4*. 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 actively maintained as the master branch. This version does not support multi-line text.

Preview (click to play video)

YouTube Video

Donate

PayPal

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

Developers

Usage

There are multiple ways you can make use of NPCLib.

  1. The first option is to shade npclib-plugin.jar in to your plugin.
  2. The second option is to put npclib-plugin.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!
  3. The third option (and the one I recommend most) is to shade the library using Maven. I recently added NPCLib to the OSSRH (OSS Repository Hosting) which allows you to easily import NPCLib into your project.

Maven repository

<repositories>
    <repository>
        <id>ossrh</id>
        <url>https://oss.sonatype.org/content/groups/public/</url>
    </repository>
</repositories>

Maven dependency

If you have NPCLib under your plugins folder, you may use the following:

<dependencies>
    <dependency>
        <groupId>net.jitse</groupId>
        <artifactId>npclib-api</artifactId>
        <version>2.3-SNAPSHOT</version>
        <scope>compile</scope>
    </dependency>
</dependencies>

If you do not want to have NPCLib in your plugins folder, you need to use the npclib-plugin artifact and shade it accordingly.

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. You can build the project using mvn clean install.

The API JAR will be under /api/target/ and the plugin JAR (which includes all necessary NMS code) will be under /plugins/target/.

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

Copyright (c) Jitse Boonstra 2018 All rights reserved.

You can’t perform that action at this time.