Guides

Installing your plugin

Put the jar on a Paper, Purpur or Spigot server and check it loaded.

Before you start#

• Make sure the project's engine and version match your server. A plugin built for Paper 1.21 will not necessarily run on Spigot 1.16.
• Check the Java version your server runs. It must be at least the version the plugin was built for. See Engines and versions.
• Test on a copy of your server first. A green build does not prove the plugin is safe or correct.

Install#

1. Download plugin.jar from a successful build.
2. Stop your server.
3. Copy the jar into the server's plugins folder.
4. Start the server.

You can sometimes load plugins without a restart, but a restart is the reliable way and avoids half-loaded state.

Check that it loaded#

Watch the console during startup. A plugin that loads logs an "Enabling" line with its name. Then, in game or in the console:

/plugins

Your plugin should appear in green. Red means it failed to enable, and the console shows why just above.

Using your commands#

Commands and permissions are defined in the plugin's plugin.yml and code. If a command does nothing or says you lack permission:

• check the permission node the plugin uses, and grant it with your permissions plugin,
• make sure you are an operator while testing,
• check the console for an error when you ran the command.

Updating#

To update, replace the old jar with the new one and restart. If the plugin keeps data, check that the new version still reads the old format, especially after a change to storage or configuration.

If it does not load#

Start with Troubleshooting. The usual causes are a Java version that is too old, a wrong engine or version target, or a missing dependency plugin.