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 a91ee58547 Updated version to 2.1-SNAPSHOT. 5 years ago
.github/ISSUE_TEMPLATE Add issue template 5 years ago
api Updated version to 2.1-SNAPSHOT. 5 years ago
examples Missing setSkin method on Example 3 5 years ago
nms Updated version to 2.1-SNAPSHOT. 5 years ago
plugin Updated version to 2.1-SNAPSHOT. 5 years ago
.gitignore Few Maven changes and added a build script. 6 years ago
.travis.yml Fixed travis-ci error. 5 years ago
CREDITS.md Added DOCUMENTATION, CREDITS and changed README. 5 years ago
DOCUMENTATION.md Update DOCUMENTATION.md 5 years ago
LICENSE.md Added a proper license (MIT license). 6 years ago
README.md Small updates. 5 years ago
pom.xml Updated version to 2.1-SNAPSHOT. 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.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.0-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 (c) Jitse Boonstra 2018 All rights reserved.