Developers Sharing a plugin
Private plugins
A plugin you only want on your own worlds doesn't have to go in the catalog. Upload it on the dashboard and it installs like any other.
Uploading one
On any world's Plugins tab on the dashboard, 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 defaultthe plugin definition, declaringid,name,versionanddescriptionas plain strings before itscommands- use an
idthat isn't already a catalog plugin's, orindex - 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 world's 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 dedicated 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.
Realms need nothing like minPackVersion: installing a plugin on a Realm puts the newest Realm pack in with it.
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
Nobody reviews a private plugin, so it's your responsibility, like any other code you run in your world. It gets no special access: it talks to BedrockRelay exactly as a catalog plugin does. The BedrockRelay team can see private plugins' code and which worlds use them, so we can help when something goes wrong, and can block one that's harmful or abusive. A blocked plugin is switched off on all of its owner's worlds at the gateway (no commands, posts or live boards, whatever copy the world runs), can't be installed, updated or downloaded, and shows its owner why. It can still be removed and deleted. The best practices still apply.
Written something others would like? Choose Submit to the catalog on its card, or see publishing a plugin. Nothing private is ever shown to anyone else unless you submit it.
Running a Minecraft world rather than building for one? The help covers everything from setup to troubleshooting.
Read the help