MatrixSRV

A simple bridge between Minecraft and Matrix. Made with blood, sweat, and Trixnity

NOTICE: MatrixSRV does NOT work in encrypted rooms. Once encryption is enabled it cannot be disabled, and you will have to make a new room

Why MatrixSRV

This plugin connects your Minecraft server chat to a Matrix room, so messages appear in both places at the same time. Players can chat from inside Minecraft while others can join the conversation from Matrix, even when they are not in-game. It’s easy to set up and helps keep your community connected outside the server. MatrixSRV also has an optional dependancy with DiscordSRV, to keep messaging with both platforms as seamless as possible!

Who is this for?

This plugin is for Minecraft server owners who want to stay in touch with their community, moderators who want to monitor chat remotely, and players who want to keep chatting when they are not online in Minecraft.

Features!

• Listens to player chat messages
• Listens to player deaths
• Listens to player join/leave
• Listens to player advancements
• Listens to player /me commands
• Forwards most standard matrix messages (including all file types, and 3 text formats)
• RELOADABLE config, with preferences
• Copyleft FOSS project
• Broadcast command
• OPTIONAL compatability with DiscordSRV
• AND MORE!

Compilation

Although the Modrinth page is public, it is highly recommended that you compile the plugin on your own:

1. Clone the git repository
   • git clone https://git.gay/Stigstille/MatrixSRV
2. Enter the project files
   • cd ./MatrixSRV
3. Build and Compile the plugin
   • ./gradlew shadowJar
4. Find the freshly generated plugin
   • Should be located at ./build/libs/MatrixSRV-x.x.x-all.jar

Commands

• /matrixsrv: Shorthand for /matrixsrv source
• /matrixsrv source: Shows players a clickable URL to the source code, along with a copy of the license
• /matrixsrv broadcast <text>: Broadcasts a message to matrix with the content of <text>
• /matrixsrv reload: Reloads the configuration. (Server still needs a restart to change the Access Token or the Homeserver

Config

You can find the configuration file after starting the server with the plugin for the first time.

# Your Bot's Access token.
# It is not recommended to use the Access token for your own account
matrix-access-token: "CHANGEME_THISISNOT_AREALVALUE"
# The ID for the room that should be bridged
# add/remove channels however you like
# first channel will be main channel for join, leave, death, etc. messages and canned-responses
matrix-channel-link:
   global: '!somewhere:over.therain.bow'
   #nether: '!somewhere:under.therain.bow'
# Your homeserver.
# If you don't know what this is, you *probably* shouldn't touch this
matrix-homeserver: "https://matrix.org"

# Preferences
show-full-matrix-uname: false

forward-me-command: true
me-command-permission: "minecraft.command.me"

# MSCs (Matrix Spec Changes). Not all clients support these
## MSC4144: Per-message profiles
support-msc-4144: true
## Only gets used if MSC4144 is enabled.
## Supports placeholderapi and variables like {username}, {uuid}, and {uuid-no-dashes}
avatar-url: "https://crafthead.net/helm/{username}"

# !matrixsrv is always active and will show a link to the source page
canned-responses:
   '!ip': "play.example.com"
   '!seed': "The seed for this world is ..."

As of v0.1.0,

MatrixSRV now lets you change previously hardcoded text, and actually specify the text for custom advancements! in plugins/MatrixSRV/lang.json, just paste the contents of en_us.json (or other language file) from your datapack, and reload MatrixSRV! There are some default values that come built in for making it easier to control the built-in text:

{
   "matrixsrv.advancement": " has made the advancement ",
   "matrixsrv.discord_prefix": "[DSCRD] ",
   "matrixsrv.join_game": " joined the game",
   "matrixsrv.left_game": " left the game",
   "matrixsrv.matrix_prefix": "[MTRX] ",
   "matrixsrv.message_seperator": " \u003e\u003e ",
   "matrixsrv.minecraft_prefix": "[MNCRFT] ",
   "matrixsrv.reply": " in response to ",
   "matrixsrv.sent_audio": " sent audio",
   "matrixsrv.sent_file": " sent a file",
   "matrixsrv.sent_image": " sent an image",
   "matrixsrv.sent_video": " sent a video"
}