Repository navigation
Configuration
MineBridge provides a flexible YAML-based configuration system that allows server administrators to customize Discord integration, chat synchronization, player notifications, death messages, achievements and gameplay events.
All configuration options are managed through config.yml, which is generated when MineBridge starts for the first time.
- Discord Connection
- Message Formatting
- Feature Toggles
- Death Messages
- Achievements and Challenges
- Discord Events
- Placeholder Reference
- Security Best Practices
The discord section contains the credentials and default channel used for Discord integration.
discord:
bot-token: ""
channel-id: ""| Option | Description |
|---|---|
bot-token |
Discord bot authentication token |
channel-id |
Default Discord text channel ID |
MineBridge supports the MINEBRIDGE_BOT_TOKEN environment variable.
We recommend using an environment variable instead of storing your bot token directly in config.yml.
Example:
export MINEBRIDGE_BOT_TOKEN="YOUR_BOT_TOKEN"Important: Never share your Discord bot token or commit it to a public repository.
The channel-id option specifies the default Discord channel used by MineBridge.
Individual event systems can also define their own channel IDs.
MineBridge allows administrators to customize messages exchanged between Minecraft and Discord.
All message templates are configurable through the messages section.
Controls how Minecraft chat messages appear in Discord.
minecraft-to-discord: "**{player}**: {message}"Available placeholders:
| Placeholder | Description |
|---|---|
{player} |
Minecraft player name |
{message} |
Chat message |
{timestamp} |
UTC ISO-8601 timestamp |
Controls how Discord messages appear inside Minecraft.
discord-to-minecraft: "&9[Discord] &f{player}: {message}"Available placeholders:
| Placeholder | Description |
|---|---|
{player} |
Player display name |
{display_name} |
Discord display name |
{username} |
Discord username |
{message} |
Message content |
{timestamp} |
UTC ISO-8601 timestamp |
Customize player activity notifications.
player-join: "🟢 **{player}** joined the server."
player-leave: "🔴 **{player}** left the server."Available placeholders:
-
{player}— Player name. -
{timestamp}— UTC ISO-8601 timestamp.
server-status: "&7Server &8| &a{online}&7/&f{max} players online"
player-list: "&7Online players (&f{online}&7/&f{max}&7): {players}"Available placeholders:
| Placeholder | Description |
|---|---|
{online} |
Number of online players |
{max} |
Maximum player capacity |
{players} |
List of online players |
The features section controls the main MineBridge functionality.
features:
chat-relay: true
join-leave-notifications: true
server-status: true
player-list: true| Option | Description |
|---|---|
chat-relay |
Controls chat synchronization |
join-leave-notifications |
Controls player join and leave notifications |
server-status |
Controls server status functionality |
player-list |
Controls player list functionality |
Use true to enable a feature and false to disable it.
Example:
features:
chat-relay: false
join-leave-notifications: true
server-status: true
player-list: falseMineBridge provides configurable death notifications for Minecraft and Discord.
The death-messages section controls death detection, message broadcasting, Discord embeds and individual death categories.
death-messages:
enabled: true| Option | Description |
|---|---|
enabled |
Enables or disables the death message system |
minecraft:
enabled: true
broadcast: true| Option | Description |
|---|---|
enabled |
Enables Minecraft death notifications |
broadcast |
Controls death message broadcasting |
discord:
enabled: true
channel-id: ""
embed: true
title: "☠ Player death"
description: "{message}\nCategory: {category}\nCause: {cause}"
color: "#D32F2F"| Option | Description |
|---|---|
enabled |
Enables Discord death notifications |
channel-id |
Dedicated Discord channel ID |
embed |
Enables embed formatting |
title |
Discord embed title |
description |
Discord embed description |
color |
Embed color in hexadecimal format |
Leave channel-id empty to use the default discord.channel-id.
MineBridge supports individual death category controls.
categories:
player-kill: true
mob-kill: true
fall: true
lava: true
fire: true
drowning: true
void: true
explosion: true
environmental: true
other: trueSupported categories:
| Category | Description |
|---|---|
player-kill |
Death caused by another player |
mob-kill |
Death caused by a mob |
fall |
Fall damage |
lava |
Lava-related death |
fire |
Fire-related death |
drowning |
Drowning |
void |
Falling into the void |
explosion |
Explosion-related death |
environmental |
Environmental damage |
other |
Other death causes |
Administrators can customize individual death messages.
messages:
player-kill: "&c☠ {victim} was slain by {killer}"
mob-kill: "&c☠ {victim} was slain by {killer}"
fall: "&c☠ {victim} fell to their death"
lava: "&c☠ {victim} tried to swim in lava"
fire: "&c☠ {victim} burned to death"
drowning: "&c☠ {victim} drowned"
void: "&c☠ {victim} fell out of the world"
explosion: "&c☠ {victim} died in an explosion"
environmental: "&c☠ {victim} died from {cause}"
other: "&c☠ {victim} died"Available placeholders:
-
{victim}— Player who died. -
{killer}— Killer name. -
{cause}— Death cause. -
{category}— Death category.
MineBridge supports Minecraft advancement and challenge notifications.
Administrators can configure Minecraft announcements, Discord notifications, categories and custom messages.
achievements:
enabled: trueEnables or disables the achievement notification system.
minecraft:
enabled: trueControls achievement notifications in Minecraft.
discord:
enabled: true
channel-id: ""
title: "ADVANCEMENT UNLOCKED"
description: "{player} has unlocked {title}.\n{description}"
challenge-title: "CHALLENGE COMPLETED"
challenge-description: "{player} has completed {title}!\n{description}"
color: "#2196F3"| Option | Description |
|---|---|
enabled |
Enables Discord achievement notifications |
channel-id |
Dedicated Discord channel |
title |
Advancement embed title |
description |
Advancement embed description |
challenge-title |
Challenge embed title |
challenge-description |
Challenge embed description |
color |
Embed color in hexadecimal format |
Leave the channel ID empty to use the default Discord channel.
challenges:
enabled: trueControls challenge completion notifications.
categories:
story: true
nether: true
end: true
adventure: true
husbandry: true
other: true| Category | Description |
|---|---|
story |
Story advancements |
nether |
Nether advancements |
end |
End advancements |
adventure |
Adventure advancements |
husbandry |
Husbandry advancements |
other |
Other advancements |
messages:
normal: "&a✦ {player} has made the advancement [{title}]!"
challenge: "&6🏆 {player} has completed the challenge [{title}]!"Available placeholders:
-
{player}— Player name. -
{title}— Advancement title. -
{description}— Advancement description. -
{category}— Advancement category. -
{challenge}— Challenge information.
The discord-events section provides additional controls for Minecraft event notifications sent to Discord.
discord-events:
enabled: trueEnables or disables the Discord event notification system.
embeds:
enabled: true
footer: "MineBridge | Minecraft Events"| Option | Description |
|---|---|
enabled |
Controls event embeds |
footer |
Custom embed footer |
player-events:
enabled: true
channel-id: ""
join: true
leave: true
first-join: trueAvailable controls:
| Option | Description |
|---|---|
enabled |
Enables player event notifications |
channel-id |
Dedicated notification channel |
join |
Player join notifications |
leave |
Player leave notifications |
first-join |
First-time join notifications |
achievements:
enabled: true
channel-id: ""
story: true
nether: true
end: true
adventure: true
husbandry: true
challenges: trueControls Discord notifications for advancement categories and challenges.
deaths:
enabled: true
channel-id: ""
player-kill: true
mob-kill: true
environmental: trueControls Discord death event notifications.
Supported options:
enabledchannel-idplayer-killmob-killenvironmental
MineBridge supports placeholders in different message templates.
| Placeholder | Description |
|---|---|
{player} |
Player name |
{display_name} |
Display name |
{username} |
Username |
{message} |
Message content |
{timestamp} |
UTC ISO-8601 timestamp |
{online} |
Online player count |
{max} |
Maximum player capacity |
{players} |
Online player list |
{victim} |
Player who died |
{killer} |
Killer name |
{cause} |
Death cause |
{category} |
Event category |
{title} |
Advancement title |
{description} |
Advancement description |
{challenge} |
Challenge information |
Note: Placeholder availability depends on the specific configuration field. Only use placeholders supported by that field.
Follow these recommendations when configuring MineBridge:
- Never share your Discord bot token.
- Prefer the
MINEBRIDGE_BOT_TOKENenvironment variable. - Keep your configuration file private.
- Avoid committing credentials to public repositories.
- Use valid Discord channel IDs.
- Review your bot permissions and restrict access appropriately.
If you experience configuration problems:
- Check your YAML indentation.
- Verify that configuration values use the correct data types.
- Check your Minecraft server console for errors.
- Verify your Discord bot credentials and channel IDs.
For further assistance, visit the Troubleshooting page.
MineBridge Documentation Minecraft × Discord Integration GitHub Repository · Modrinth
Getting Started
Documentation
Support
Developers
[GitHub Repository](https://github.com/aridrochatterjee/Minebridge)
[Modrinth Page](https://modrinth.com/plugin/minebridge)