Developers Sharing a plugin

Publishing to the catalog

Plugins in the catalog appear on every owner's dashboard, ready to install. The catalog lives in the BedrockRelay plugins repository on GitHub.

Submitting a plugin

Open a pull request that adds one folder:

plugins/health/
  plugin.js      ← your plugin, exactly as it will be installed
  plugin.json    ← how it appears in the catalog
  discord.png    ← optional: what it looks like in Discord

Owners install exactly the file that was reviewed. To release an update, open a pull request that changes plugin.js and raises version in both files. Updates are reviewed like new plugins; once merged, owners see Update on their dashboard.

plugin.json

{
  "id": "health",
  "name": "Health",
  "version": "1.0.0",
  "author": "Your name",
  "description": "Check a player's health from Discord.",
  "privacy": "Shows a player's current health.",
  "homepage": "https://github.com/you/health",
  "minPackVersion": "0.3.0",
  "platforms": ["server", "realm"],
  "category": "players",
  "commands": ["/health <player>"],
  "screenshots": [
    { "file": "discord.png", "caption": "/health answering in Discord" }
  ]
}

Field	Required	Description
`id`	yes	Must match the folder name, and the `id` in `plugin.js`.
`name`	yes	Shown in the catalog.
`version`	yes	`major.minor.patch`. Must match the `version` in `plugin.js`.
`author`	yes	You, or your team.
`description`	yes	One or two sentences.
`privacy`	if it reveals anything about players	Shown beside the plugin's switch.
`posts`	if it posts by itself	What it posts, as in `plugin.js`. Shown in the catalog.
`homepage`	no	An `https` link to your source or docs.
`minPackVersion`	yes	The oldest dedicated server pack it works with: `0.4.2` if it uses `postKinds`, `0.4.0` if it uses `choices`, `public`, `confirm`, `posts`, `board`, `linkedPlayer` or a drawn picture, otherwise `0.3.0`.
`platforms`	no	`["server"]`, `["realm"]` or both. Leave it out for dedicated servers only. Only add `"realm"` once it has run on a Realm. See Plugins on Realms.
`minRealmPackVersion`	no	The oldest Realm pack it works with. Defaults to `1.2.0`, which every plugin feature works with.
`category`	no	Where owners find it when filtering the catalog: one of `moderation`, `players`, `stats`, `world`, `fun` or `tools`. Reviewers may suggest a better fit.
`commands`	yes	How each command is used, for the catalog card.
`screenshots`	no	Up to 4 pictures, below.

Screenshots

Up to four pictures of your plugin in Discord, shown on its catalog card. Each file sits in the plugin's folder and is a PNG, JPEG or WebP under 1 MB. Its caption says what it shows and doubles as the alt text. Crop to the message itself: the card shows the top of each picture, and a click shows it whole.

What reviewers check

It does what its description says, and nothing else.
It follows the best practices, including no network access and no secrets.
It declares privacy if it reveals anything about players, and only answers meant for everyone are public.
Anything that changes the world is in its description and asks first with confirm.
If it's marked for Realms, it uses only the stable Script API and leaves our bot out.
Its screenshots, if any, show it as it really looks, with no personal details or other people's names visible unless they agreed.
It's readable: one file, with no minified, obfuscated or generated code.

Licence

Everything in the catalog is published under the MIT licence, so anyone can use, change and share it. By submitting a plugin, or an update to one, you agree to license it under MIT and confirm you have the right to.

Running a Minecraft world rather than building for one? The help covers everything from setup to troubleshooting.

Read the help