Private plugins

Uploading one

On the dashboard's Plugins page, choose Upload a plugin under Your own plugins and pick your .js file. It's listed only on your dashboard, and installs, updates and removes like a catalog plugin, on your dedicated servers and, if it says so, your Realms.

The upload is checked for format, not reviewed. It must:

• export default the plugin definition, declaring id, name, version and description as plain strings before its commands
• use an id that isn't already a catalog plugin's, or index
• be under 128 KB

Where it runs, and which pack

A private plugin has no plugin.json, so two things the catalog keeps there go in the definition, also before commands:

export default {
  id: "our-rules",
  name: "Our rules",
  version: "1.0.0",
  description: "Shows the server rules.",
  platforms: ["server", "realm"],
  minPackVersion: "0.4.0",
  commands: [ /* … */ ],
};

• platforms: add "realm" to install it on your Realms. Without it, it's for dedicated servers only. See Plugins on Realms.
• minPackVersion: the oldest server pack it works with, and the dashboard asks for a pack update before installing it on an older one. Without it, any pack from v0.3.0 is accepted. See Versions and stability.

Updating and deleting

To release a new version, raise version and upload the file again with Upload new version on its card. Your worlds are then offered the update. You can have up to 20 private plugins. Remove one from your worlds before deleting it.

Your responsibility

Written something others would like? Submit it to the catalog.