MatrixSpigotBridge -----
[Abandoned] Link your minecraft chat with a Matrix roomDescription
MatrixSpigotBridge is a plugin that uses Matrix (an instant messaging protocol https://matrix.org) to let interact with the players without being connected on Minecraft.
This will let players the ability to chat with people on your Matrix server as well as having people on the Matrix server be able to chat with people on the server
The plugin could be useful for example in the situation of someone not being at their computer and wanting to talk to in-game players.
If you like placeholders, we do too!
PlaceholderAPI is supported so if you have it, you can add fancy placeholders in all plugin's messages
(for example to display in which server / faction / ... the player sending the message in)
Screenshots
Screenshot from a Matrix client (Element used here) showering how various events on the server are sent as messages in the matrix room (my example bot user is named "mcserver")
Discussion between a Matrix user and a Minecraft player (First screen is from Element and the second one is in Minecraft)
Prerequisites
- A Matrix room (can be on any homeserver)
- A Matrix user (AKA the "Bot") that can read/write in that room
Installation
- Put the plugin in your plugins directory
- Edit the generated config.yml file to fit your needs (shown below for reference)
- Reboot your server and that's all!
Configuration
In the example configuration, we have a user @mcbot:example.com whose password is y0urPa55w0rd (the user is registered at home server example.com:8448) we want to bind it the room !fdsgfdKJHGKujys:example.com to the minecraft chat
Code (YAML):
# MatrixSpigotBridge configuration file
# Note: if you want to use symbols / emojis, please save this file as UTF-8
# Matrix server / bot account configuration
matrix :
# Matrix homeserver base url
server : 'https://example.com:8448'
# Matrix room used to communicate with players
# Note: Do not use room alias (#roomname:example.com)
room_id : '!fdsgfdKJHGKujys:example.com'
# Automatic account used to post and read messages in the room
# Once access token have been generated after first start in access.yml,
# you can safely set the password here to '' value if you don't want password stored in clear
user_id : '@mcbot:example.com'
password : 'y0urPa55w0rd'
# Seconds to wait between polls to get messages from matrix server
poll_delay : 2
# Message formats
# You can have many more placeholders than those provided
# if you use PlaceholderAPI and have set common.usePlaceholderApi to true
#
# An empty value won't send messages for the related event
format :
# Players related events (join, quit, chat, death)
# {PLAYERNAME} is the displayed player name, {MESSAGE} is the default event message
# For chat, {MESSAGE} is the message sent by user
player:
join : '+ {MESSAGE }'
quit : '- {MESSAGE }'
death : 'X {MESSAGE }'
chat : '> {PLAYERNAME } : {MESSAGE }'
# Message sent from matrix room
# {MATRIXNAME} is the matrix user name, {MESSAGE} is the message sent
matrix_chat : ' [Matrix ] {MATRIXNAME } : {MESSAGE }'
# Server events (start stop)
server:
start : 'Server start'
stop : 'Server stop'
common :
# Set this value to false if you want the plugin to always fetch displaynames from matrix server
# True will let the server remember fetched diplaynames until Spigot restart
cacheMatrixDisplaynames : true
# If you like placeholders, we do too!
# Set this value to true to use placeholders in all formats messages
# requires PlaceholderApi if set to true!
usePlaceholderApi : false
# Note: if you want to use symbols / emojis, please save this file as UTF-8
# Matrix server / bot account configuration
matrix :
# Matrix homeserver base url
server : 'https://example.com:8448'
# Matrix room used to communicate with players
# Note: Do not use room alias (#roomname:example.com)
room_id : '!fdsgfdKJHGKujys:example.com'
# Automatic account used to post and read messages in the room
# Once access token have been generated after first start in access.yml,
# you can safely set the password here to '' value if you don't want password stored in clear
user_id : '@mcbot:example.com'
password : 'y0urPa55w0rd'
# Seconds to wait between polls to get messages from matrix server
poll_delay : 2
# Message formats
# You can have many more placeholders than those provided
# if you use PlaceholderAPI and have set common.usePlaceholderApi to true
#
# An empty value won't send messages for the related event
format :
# Players related events (join, quit, chat, death)
# {PLAYERNAME} is the displayed player name, {MESSAGE} is the default event message
# For chat, {MESSAGE} is the message sent by user
player:
join : '+ {MESSAGE }'
quit : '- {MESSAGE }'
death : 'X {MESSAGE }'
chat : '> {PLAYERNAME } : {MESSAGE }'
# Message sent from matrix room
# {MATRIXNAME} is the matrix user name, {MESSAGE} is the message sent
matrix_chat : ' [Matrix ] {MATRIXNAME } : {MESSAGE }'
# Server events (start stop)
server:
start : 'Server start'
stop : 'Server stop'
common :
# Set this value to false if you want the plugin to always fetch displaynames from matrix server
# True will let the server remember fetched diplaynames until Spigot restart
cacheMatrixDisplaynames : true
# If you like placeholders, we do too!
# Set this value to true to use placeholders in all formats messages
# requires PlaceholderApi if set to true!
usePlaceholderApi : false
Security tip: Once the bot user have successfully connected at least once, an access token will be generated in access.yml to avoid using password anymore, so you can safely set the password to empty value if you don't want password stored in clear in your config file
Contact
For comments, suggestions or bugs feel free to ask in "Discuss This Resource"
If you have a problem, please discuss it first before leaving a bad review
Resource Information
Author:
----------
Total Downloads:
543
First Release:
Oct 9, 2021
Last Update:
Oct 9, 2021
Category:
---------------
All-Time Rating:
3 ratings
Version
-----
Released:
--------------------
Downloads:
------
Version Rating:
----------------------
-- ratings