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.

  1. Download ProtocolLib for your server version from its official sources
  2. Drop the jar into your plugins folder
  3. Make sure there is only one ProtocolLib jar in that folder — two copies of the same plugin (for example ProtocolLib.jar and ProtocolLib (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

  1. Drop the plugin's jar into plugins
  2. Start (or restart) the server
  3. 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:

PluginWhat it adds
PlaceholderAPINPC info as placeholders for other plugins — see PlaceholderAPI
CitizensLets you run /npc migrate citizens to bring NPCs over — see Citizens migration