Discord

Minecraft events relayed to Discord

Overview

Your server will observe any of the below events that occur in Minecraft, triggering appropriate messages to be sent to the configured channel within Discord.

There are two types of messages that can be sent to Discord, an embed and plain text (markdown).

Configuration

All the following messages - that are sent to Discord - fall under the entries[] > discord section.

Please refer to the templating guide for instructions on substituting player names, etc.

config/chatter/discord/messages.json5
"entries": [
	{
		// ...

		// Minecraft events relayed to Discord
		"discord": {
			// Add event messages here
		}

		// ...
	}
]

To disable a message, you can set it to null , e.g. "chat": null

Events

A player sent an in-game message

A player of your server sent a message to the chat.

Token

Type

Meaning

Example

${username}

String

The player's username

Axieum

${player}

String

The player's display name

Axieum

${message}

String

The formatted message contents

I am **bold** text.

${world}

String

The name of the world the player is in

Nether

${datetime[:format]}

DateTime

The current date & time

01/01/2004

/**
 * A player sent an in-game message
 * Use ${username}, ${player}, ${message}, ${world} and ${datetime[:format]}
 */
"chat": "`${world}` **${player}** > ${message}",

A player died

A player died and must respawn.

Token

Type

Meaning

Example

${username}

String

The player's username

Axieum

${player}

String

The player's display name

Axieum

${cause}

String

The reason for the player's death

tried to swim in lava

${world}

String

The name of the world the player died in

Nether

${x}

Integer

X coordinate of where the player died

-126

${y}

Integer

Y coordinate of where the player died

70

${z}

Integer

Z coordinate of where the player died

-81

${score}

Integer

The player's total score before they died

34123

${exp}

Integer

The player's experience levels

1

${lifespan[:format]}

Duration

For how long the player lived

1 day 5 minutes

${datetime[:format]}

DateTime

The current date & time

01/01/2004

/**
 * A player died
 * Use ${username}, ${player}, ${cause}, ${world}, ${x}, ${y}, ${z}, ${score}, ${exp}, ${lifespan[:format]} and ${datetime[:format]}
 */
"death": "**${player}** ${cause}!\n:skull: _${world} | ${x}, ${y}, ${z}_",

A named animal/monster (with name tag) died

An animal/monster that was previously named with a name tag, died.

This event requires the Chatter World game rule!

Token

Type

Meaning

Example

${name}

String

The entity's display name (name tag)

jeb_

${cause}

String

The reason for the entity's death

was slain by Wolf

${world}

String

The name of the world the entity died in

Overworld

${x}

Integer

X coordinate of where the entity died

-134

${y}

Integer

Y coordinate of where the entity died

68

${z}

Integer

Z coordinate of where the entity died

-87

${datetime[:format]}

DateTime

The current date & time

01/01/2004

/**
 * A named animal/monster (with name tag) died (requires Chatter World game-rule)
 * Use ${name}, ${cause}, ${world}, ${x}, ${y}, ${z} and ${datetime[:format]}
 */
"grief": "**${name}** ${cause}! :coffin:",

A player unlocked an advancement

A player made an advancement or challenge.

Token

Type

Meaning

Example

${username}

String

The player's username

Axieum

${player}

String

The player's display name

Axieum

${type}

String

The type of advancement

challenge / task / goal

${title}

String

The title of the advancement

Cover Me In Diamonds

${description}

String

A description of the advancement

Equip a full set of diamond armour

${datetime[:format]}

DateTime

The current date & time

01/01/2004

/**
 * A player unlocked an advancement
 * Use ${username}, ${player}, ${type}, ${title}, ${description} and ${datetime[:format]}
 */
"advancement": "**${player}** completed the ${type} **${title}**! :clap:\n_${description}_",

A player teleported to another dimension

A player entered a different dimension, be it through a portal or via commands. Uses plaintext to prevent chat spam.

Token

Type

Meaning

Example

${username}

String

The player's username

Axieum

${player}

String

The player's display name

Axieum

${origin}

String

The name of the world the player left

Overworld

${destination}

String

The name of the world the player entered

Nether

${datetime[:format]}

DateTime

The current date & time

01/01/2004

/**
 * A player teleported to another dimension
 * Use ${username}, ${player}, ${origin}, ${destination} and ${datetime[:format]}
 */
"teleport": "**${player}** entered ${destination}. :cyclone:",

A player joined the game

A player logged into the server.

Token

Type

Meaning

Example

${username}

String

The player's username

Axieum

${player}

String

The player's display name

Axieum

${world}

String

The name of the world the player is in

Overworld

${datetime[:format]}

DateTime

The current date & time

01/01/2004

/**
 * A player joined the game
 * Use ${username}, ${player}, ${world} and ${datetime[:format]}
 */
"join": "**${player}** joined!",

A player left the game

A player logged out of the server.

Token

Type

Meaning

Example

${username}

String

The player's username

Axieum

${player}

String

The player's display name

Axieum

${world}

String

The name of the world the player is in

Overworld

${elapsed[:format]}

Duration

For how long the player was logged in

32 minutes 7 seconds

${datetime[:format]}

DateTime

The current date & time

01/01/2004

/**
 * A player left the game
 * Use ${username}, ${player}, ${world}, ${elapsed[:format]} and ${datetime[:format]}
 */
"leave": "**${player}** left!",

The server began to start

The server is about to start.

Token

Type

Meaning

Example

${datetime[:format]}

DateTime

The current date & time

01/01/2004

/**
 * The server began to start
 * Use ${datetime[:format]}
 */
"starting": "Server is starting... :fingers_crossed:",

The server started and is accepting connections

The server started and is online.

Token

Type

Meaning

Example

${uptime[:format]}

Duration

For how long the server took to start

36 seconds

${datetime[:format]}

DateTime

The current date & time

01/01/2004

/**
 * The server started and is accepting connections
 * Use ${uptime[:format]} and ${datetime[:format]}
 */
"started": "Server started (took ${uptime:s.SSS}s) :ok_hand:",

The server began to stop

The server is preparing to stop.

Token

Type

Meaning

Example

${uptime[:format]}

Duration

For how long the server has been online

1 hour 2 minutes

${datetime[:format]}

DateTime

The current date & time

01/01/2004

/**
 * The server began to stop
 * Use ${uptime[:format]} and ${datetime[:format]}
 */
"stopping": "Server is stopping... :raised_hand:",

The server stopped and is offline

The server shutdown.

Token

Type

Meaning

Example

${uptime[:format]}

Duration

For how long the server was online

1 hour 3 minutes

${datetime[:format]}

DateTime

The current date & time

01/01/2004

/**
 * The server stopped and is offline
 * Use ${uptime[:format]} and ${datetime[:format]}
 */
"stopped": "Server stopped! :no_entry:",

The server stopped unexpectedly and is inaccessible

A server crash was detected.

Token

Type

Meaning

Example

${reason}

String

The reason behind the crash

Exception ticking world

${uptime[:format]}

Duration

For how long the server was online

5 hours 3 minutes

${datetime[:format]}

DateTime

The current date & time

01/01/2004

/**
 * The server stopped unexpectedly and is inaccessible
 * Use ${reason}, ${uptime[:format]} and ${datetime[:format]}
 */
"crashed": "Server crash detected! :warning:\n_${reason}_",

// True if a crash report is attached to the server crashed message
"uploadCrashReport": true,

You can use the uploadCrashReport option to attach the crash report to the message!

Last updated