Messages
Effortless message configuration for seamless Minecraft -> Discord communication
Mizuki is designed to be highly customizable without sacrificing ease of use, so you can make it work best for your server's needs. With its advanced message configuration options, you can easily tailor the plugin to your specific requirements. This means you can make all the messages appear in one particular format and even filter out unwanted messages. Having this in mind allows you to make Mizuki look and function how you want it to and stand out from other Mizuki users.
How to use the configuration
Once your server is setup, head over to plugins\Mizuki\messages.toml. You'll see our starter configuration, which should guide you in the right direction.
Configuration types
join - for when a player joins the server
firstjoin - for when a player joins the server for the first time. Prevents the join message from sending.
leave - for when a player leaves the server
chat - for when a player sends a message in Minecraft chat
ingame - for when a player sends a message in the configured Discord channel
Placeholders
Each configuration type supports placeholders in each variable (except embed colour).
Player placeholders
These placeholders are only used within player events (join, firstjoin, leave, chat).
%name% - the players username
%uuid%- the players UUID
%message%- the chat message sent (only available in chat)
Discord placeholders
These placeholders are only used within the ingame event.
%message% - the message sent
%display-name% - the nickname of the user, username if not set
%name% - the username of the user
%tag% - the username and discriminator of the user (ex: User#0001)
%role% - the name of the users highest role
%coloured-role% - the users highest role, coloured with the roles colour.
%role-colour% - the colour of the users role, in a supported format for Minecraft
Embeds & Content
Mizuki supports embeds, which means you can make your in-game messages look more attractive and engaging when they are sent to a Discord channel. With the ability to customize the embeds, you can make them look exactly how you want them to, giving your server a unique and professional look. This feature will help you to stand out among other Mizuki users and enhance the overall communication experience for your players.
Each configuration type (excluding ingame) supports an "embed" variable to make this possible. You can find an example of usage below:
[join.embed]
colour = "#ffaec8"
description = "Example"
[join.embed.author]
name = "%name% joined!"
avatar = "https://crafatar.com/avatars/%uuid%"
link = "https://mizuki.astrid.sh/"The above example uses all of the Discord embed features in Mizuki, so not everything is required. You can remove whatever you want within the embed, which should still work.
Last updated