Reference
Plugin & config
Install
- Download the latest jar.
- Put it in your server's
pluginsfolder and restart the server. - Link it with the code from
/setup:mcbridge link <code>in the console.
Requirements
- Paper or a Paper fork (e.g. Purpur) on Minecraft 1.21.x.
- Java 21.
- Spigot and Folia aren't supported.
- Role sync needs LuckPerms or Vault (with a permissions plugin).
The bot needs these Discord permissions: View Channels, Send Messages, Embed Links, Attach Files, Read Message History, Add Reactions, Manage Webhooks, Manage Roles, Manage Channels (invite permission number 805424208).
Config reference
plugins/MCBridge/config.yml. After editing, run /mcbridge reload; no restart needed. The allow keys are checked by the plugin itself, so the bot can never do more than you allow.
| Key | Default | What it does |
|---|---|---|
| bot-url | "wss://bot.mcbridge.dev/v1/plugin" | Where the bot is. Only change it if you host your own. |
| token | "" | This server's secret. Filled in by /mcbridge link. Never share it. |
| update-check | true | Check GitHub for new versions every 6 hours and tell admins. |
| allow.chat | true | Discord chat and /msg show in-game. |
| allow.whitelist | true | /whitelist and whitelist requests. |
| allow.moderation | false | /mod kick, ban, unban, op, deop, gamemode. |
| allow.roles | true | Role sync can add and remove permission groups. |
| allow.console | false | /console and the console channel. Gives full control of the server. |
| messages.* | - | Every message the plugin shows, in MiniMessage or & colour codes. |
Permissions
| Permission | Default | Gives |
|---|---|---|
| mcbridge.admin | op | /mcbridge status, link, reload and help |
| mcbridge.link | everyone | /discord link (account linking) |
In-game commands
| Command | Permission (default) | What it does |
|---|---|---|
| /mcbridge or /mcbridge status | mcbridge.admin (op) | Connection status, and an update notice if a new version is out. |
| /mcbridge link <code> | mcbridge.admin (op) | Links this server using a code from /setup. Also works in the console. |
| /mcbridge reload | mcbridge.admin (op) | Reloads config.yml and reconnects. |
| /mcbridge help | mcbridge.admin (op) | Lists the commands. |
| /discord link <code> (alias /dlink) | mcbridge.link (everyone) | Links your account using a code from /account link. |
Messages and colour codes
Every message the plugin shows is under messages in config.yml. Use classic & colour codes, MiniMessage tags, or both in the same line. Delete a line to go back to the built-in default. Write \<code> to show a literal <code>.
| Write | Gives |
|---|---|
| &8 · &a · &7 · &f | Dark grey, green, grey, white |
| &l · &r | Bold, reset |
| ddc84 | Any hex colour |
| <gray> · <#3ddc84> | MiniMessage colours |
| <gradient:#3ddc84:#3987e5>text</gradient> | A gradient |
| <hover:show_text:'hi'>…</hover> | Text shown on hover |
| <click:suggest_command:'/cmd'>…</click> | Click to fill in a command |
Two of the defaults, as examples:
prefix: "&8[ddc84MCBridge&8] "
private-message: "&8[&9Discord&8] &7<author> &8→ &7you&8: &f<message>"Placeholders depend on the message: discord-chat and private-message use <author> and <message>; update-available uses <current> and <latest>. The full MiniMessage format is documented at docs.advntr.dev.
Update notifications
With update-check: true (the default) the plugin checks GitHub for a new version every 6 hours. Admins see a clickable “Update available” line, and /mcbridge status shows it too. Set it to false to turn it off.