Build and install

1. Build the module with Gradle.

   ./gradlew build

2. The JAR is in build/libs/. Copy it into the plugins/Plex/modules/ folder on your server.

3. Restart the server. Plex reads the new module and enables it.

On Paper, you can also run /plex modules reload in game. Do not use reload if the module needs new libraries, because Plex downloads libraries only when the server starts. On Folia, you must restart the server.

You can also manage modules in game.

Command	Description
/plex modules	Lists the loaded modules.
/plex modules install <name>	Downloads and installs an official module by name.
/plex modules update	Updates every module that the updater manages.
/plex modules reload	Reloads all modules from disk.
/plex modules uninstall <name> [-rmdir]	Removes a module. Add -rmdir to also delete its data folder.

Updater metadata

By default, Plex updates a module through its first-party updater, which serves the official modules. A third-party module should set its own updater.url or turn updates off. You control this behavior with an optional updater block in module.yml.

module.yml

updater:
  enabled: true
  url: https://updates.example.com/module-example

Set enabled to false to remove the module from /plex modules update. Set url to serve updates from your own location instead of the first-party updater. Use urls with a list if you serve from more than one location.

module.yml

updater:
  enabled: false

Need help

If you get stuck, join the Plex Discord and ask in the development channels.