![MailboxGUI DiscBridge](https://plugins.imagine-craft.net/assets/wiki/Release-Branding/DiscBridge-Banner-New.png) DiscBridge is an addon for MailboxGUI that connects mail delivery to Discord through DiscordSRV. Players can receive Discord notifications when new mail arrives, even while they are away from the server, and choose which notifications they want to receive. All features listed on this page are specifically for **DiscBridge Free**, designed for single-server MailboxGUI setups. ## Version Support | Platforms | Minecraft Version | Storage | Languages | | --- | --- | --- | --- | | Paper • Spigot • Purpur • Bukkit | 1.18.2–26.3 | Local YAML files for preferences and pending notifications | English • German • Spanish • French • Italian • Japanese • Korean • Dutch • Polish • Brazilian Portuguese • Russian • Swedish • Ukrainian • Simplified Chinese • Traditional Chinese • Hong Kong Traditional Chinese | ### DiscBridge Release Support | DiscBridge Version | Support Status | Upgrade Information | | --- | --- | --- | | 1.0.0–1.1.1 | Unsupported | Upgrade to DiscBridge 2.1.0 Free with MailboxGUI 6.1.0 Free if you encounter issues or need support. | | 2.0.0+ | Supported | Use the matching MailboxGUI version below. For the features listed on this page, update to DiscBridge 2.1.0 Free and MailboxGUI 6.1.0 Free. Back up plugin folders and MailboxGUI's database before updating. | ### DiscBridge Release Compatibility | DiscBridge Version | Required MailboxGUI Version | Setup | | --- | --- | --- | | 2.1.0 Free | 6.1.0 Free | Single server; DiscBridge, MailboxGUI, and DiscordSRV on the same backend. | | 2.0.0 Free | 6.0.0 Free | Features listed on this page differ from this combination. Use the [DiscBridge wiki](https://plugins.imagine-craft.net/mailboxgui-discbridge/wiki/) and select wiki version **2.0.0** for its features and setup. | --- ## Features - v2.1.0 ### Discord Mail Notifications - Direct messages for paper letters, book letters, packages, and money mail. - Attached package and money-mail messages included in notifications. - Cash-on-Delivery package notifications. - COD item-currency payment and returned COD package notifications. - Expiration-aware messages for mail with an expiration date. - Configurable Discord message templates and placeholders. - Admin/API mass-mail channel notices and optional queued direct messages. - Persistent notification outbox with retry and restart recovery for accepted work. ### Player Notification Controls - Enable or disable Discord mail notifications. - Choose whether to receive direct messages while online. - Ignore or unignore specific senders. - Manage admin/server mail direct-message preferences. - Choose a language for Discord notification messages. - Check notification settings and Discord account link status. - Access Discord settings and a setup guide directly through MailboxGUI. ### Admin Tools - View DiscBridge status. - Reload configuration and message templates. - Check for updates and stage an update for the next restart. - Configure mass-mail channel notices and direct-message delivery. - Enable or disable player access to Discord commands after checking setup readiness. In-game messages follow MailboxGUI's language and client locale settings. Discord direct messages use the player's selected Discord language, falling back to MailboxGUI's default language. Channel notices use MailboxGUI's default language. DiscBridge commands are integrated into MailboxGUI and inherit its command-syntax locale. Set `locale.command-syntax.default` in **MailboxGUI's `config.yml`** before startup to register localized command roots alongside English. Help and tab completion support localized syntax. Changing registered command roots requires a server restart. --- ## Commands and Permissions ### Player Commands All player commands require `mailboxgui.player.use` and `mailboxgui.player.discord`. Enable `player-commands.enabled` in DiscBridge's `config.yml`, or use `/mba discord playercommands on` after setup checks pass. The integrated permission supplies `mailboxguidiscbridge.use`; the additional preference permissions below are enabled by default. | Command | Additional Permission | Requirement / Action | | --- | --- | --- | | `/mb settings discord` | No additional permission | Show Discord notification help. | | `/mb settings discord guide` | No additional permission | Open the account-linking and notification setup guide. | | `/mb settings discord status` | No additional permission | Check notification settings and account link status. | | `/mb settings discord enable` / `/mb settings discord disable` | No additional permission | Enable or disable Discord mail notifications. | | `/mb settings discord online ` | `mailboxguidiscbridge.online` | Control direct messages while online. | | `/mb settings discord language ` | No additional permission | Choose the language used for Discord notifications. | | `/mb settings discord ignore ` / `/mb settings discord unignore ` | `mailboxguidiscbridge.ignore` | Ignore or allow a player's notifications. | | `/mb settings discord ignorelist` | `mailboxguidiscbridge.ignore` | View ignored senders. | | `/mb settings discord ignoreadmin` / `/mb settings discord unignoreadmin` | `mailboxguidiscbridge.ignoreadmin` | Control individual admin/server mail direct messages. | ### Admin Commands `mailboxgui.admin.discord` grants integrated access to DiscBridge administration. As an alternative, use `mailboxguidiscbridge.admin` together with the action-specific permission shown below. Players also need `mailboxgui.player.use` for the MailboxGUI command root. | Command | DiscBridge Action Permission | Requirement / Action | | --- | --- | --- | | `/mba discord` | `mailboxguidiscbridge.admin` | Show DiscBridge admin help. | | `/mba discord status` | `mailboxguidiscbridge.admin.status` | View plugin and DiscordSRV readiness status. | | `/mba discord reload` | `mailboxguidiscbridge.admin.reload` | Reload configuration and message templates. | | `/mba discord playercommands ` | `mailboxguidiscbridge.admin.playercommands` | Enable or disable player controls; enabling requires setup readiness checks to pass. | | `/mba discord updatecheck` | `mailboxguidiscbridge.admin.update` | Check for updates; requires internet access. | | `/mba discord update` | `mailboxguidiscbridge.admin.update` | Begin the update workflow; restart to load a staged update. | These examples use English syntax, which is always available. Permissions control command access; linked accounts, notification preferences, bot connectivity, and Discord delivery settings still apply to actual notifications. For the full command and permission list, use the [official wiki](https://plugins.imagine-craft.net/mailboxgui-discbridge/wiki/). ---

Installation

### Requirements - **MailboxGUI 6.1.0 Free** and **DiscordSRV** are required for **DiscBridge 2.1.0 Free**. - Install all three plugins on the same supported Spigot, Paper, or Purpur server. - Plugin bytecode requires **Java 17 or newer**. Use the Java runtime required by your Minecraft server version. - A configured DiscordSRV bot and internet access are required for Discord notifications. Folia support is not included. --- ### Basic Setup 1. Install MailboxGUI and DiscordSRV. 2. Place the DiscBridge jar in your server's `plugins` folder. 3. Start the server to generate files, then stop it and review `plugins/MailboxGUI-DiscBridge/config.yml`. 4. Configure DiscordSRV and start the server again. 5. Check `/mba discord status`, then enable player controls with `/mba discord playercommands on` when setup is ready. 6. Players can use `/mb settings discord guide` for account linking and notification setup. For upgrades, back up the DiscBridge and MailboxGUI folders and MailboxGUI's database. Keep existing player preference and pending-notification files.

Dependencies

Both plugins are required. DiscBridge is a MailboxGUI addon and does not send in-game mail itself. | Plugin | Requirement / Purpose | Download | | --- | --- | --- | | **MailboxGUI Free** | Version 6.1.0 Free provides the mail system and delivery events for DiscBridge 2.1.0 Free. | [MailboxGUI on Hangar](https://hangar.papermc.io/Rismr1/MailboxGUI) | | **DiscordSRV** | Provides Discord connectivity and account linking through your configured Discord bot. | Download [DiscordSRV on Modrinth](https://modrinth.com/plugin/discordsrv). | Players must link their Minecraft and Discord accounts through DiscordSRV to receive direct messages, and their Discord settings must allow delivery. Discord notifications require a connected bot and internet access.

--- --- ## Support - **Discord:** [Support server](https://discord.gg/kggbGwRt42) - **Wiki:** [DiscBridge documentation](https://plugins.imagine-craft.net/mailboxgui-discbridge/wiki/) ---

Contributors

- **nice** — Simplified Chinese and Hong Kong Traditional Chinese translations. - **De4d__** — Brazilian Portuguese translation. Want to contribute? Join the [Discord support server](https://discord.gg/kggbGwRt42) and post in **Plugin Discussion**. **Rismr1** will respond to you. Translation contributions, bug reports, and feature suggestions are welcome!