Get Started / Installation
Installation
Three things need to be true before this plugin will start: the right server software, the right ProtocolLib build, and the jar dropped in the right folder.
1. Server software
This plugin needs Paper (or a Paper-based fork, including Folia). It will not start on plain Spigot or CraftBukkit — every command in this plugin is registered through Paper's own command system, which Spigot does not have.
See Supported platforms for the full version range.
2. ProtocolLib
ProtocolLib is required. Without it, the plugin will print an error on startup and disable itself rather than do anything broken.
- Download ProtocolLib for your server version from its official sources
- Drop the jar into your
pluginsfolder - Make sure there is only one ProtocolLib jar in that folder — two copies of the same plugin (for example
ProtocolLib.jarandProtocolLib (2).jar) will fight each other and cause confusing errors
Common mistake
If you see errors mentioning "Unable to set value of field" in your console, the first thing to check is whether you have more than one ProtocolLib jar installed. Delete the old one and restart.
3. Install this plugin
- Drop the plugin's jar into
plugins - Start (or restart) the server
- Check the console for
npcs enabled— if you see that, you're done
Optional plugins
These are not required, but the plugin will use them automatically if it finds them running:
| Plugin | What it adds |
|---|---|
| PlaceholderAPI | NPC info as placeholders for other plugins — see PlaceholderAPI |
| Citizens | Lets you run /npc migrate citizens to bring NPCs over — see Citizens migration |