How to install and manage plugins on Cloudburst

Installing a plugin

Cloudburst keeps Nukkit's plugin system, so many Nukkit-style plugins work. Plugins written for other server software generally need to be ported first.

1. Stop the server with stop.

2. Put the plugin's .jar file in the plugins folder.

3. Start the server again.

4. Watch the console during startup. It reports each plugin as it loads and prints an error if one fails.

In the server console or in game as an operator, run plugins to list what is loaded.

Configuring a plugin

Most plugins create their own folder inside plugins/ on first load, usually containing a config file. Edit it while the server is stopped, then restart so the changes apply.

Troubleshooting

• Plugin not listed: check that the file is a .jar and sits directly in plugins, not in a subfolder.
• Error on load: the plugin is probably built for a different API than your Cloudburst build. Look for a compatible release, or check whether it needs another plugin installed first.
• Crash after adding several plugins: remove them and add them back one at a time to find the culprit.
• Back up the plugins and worlds folders before big changes.

If you want to write your own, the plugin's plugin.yml declares its name, main class, and API version. The structure is intentionally friendly to developers.