Host a bridge between Minecraft and Matrix

Go to file

Bram van den Heuvel a1a7bf69ff Config refactor part 2		2023-10-01 14:07:13 +02:00
.gitignore	Initial commit	2021-06-27 21:11:55 +02:00
Dockerfile	Add Docker example	2021-07-31 15:28:26 +02:00
LICENSE.md	Update license with personal name	2021-06-27 21:18:12 +02:00
README.md	Add instructions to how to run Minecraft server	2021-07-31 15:32:41 +02:00
build_server.py	Config refactor	2023-10-01 03:05:53 +02:00
config.py	Config refactor part 2	2023-10-01 14:07:13 +02:00
config.yaml	Config refactor part 2	2023-10-01 14:07:13 +02:00
main.py	Config refactor part 2	2023-10-01 14:07:13 +02:00
mc_wrapper.py	Config refactor part 2	2023-10-01 14:07:13 +02:00
nbsr.py	Add Minecraft bridge	2021-06-27 21:19:05 +02:00
requirements.txt	Update Python dependencies	2023-10-01 02:36:43 +02:00
start.sh	Add Docker example	2021-07-31 15:28:26 +02:00

README.md

Minecraft-bridge

This repository hosts a Minecraft server that is also connected to a Matrix client.

This way, communication is enabled between a Minecraft server and a Matrix room.

Setup

To create a Docker image, go to this folder and run the following command:

docker build -t matrix-mc-server ./

Then, once a Docker image has been created, you can run the following command to run a Minecraft server. In config.py, you can find additional environment variables you can insert to alter settings on the Minecraft server.

docker run --name mc-server \
-p 25565:25565 \
-v "<folder in which your store your Minecraft world>":/usr/src/app/world \
-e EULA=true \
-e MATRIX_HOMESERVER='<your matrix homeserver>' \
-e MATRIX_USERNAME='<matrix bridge client username>' \
-e MATRIX_PASSWORD='<matrix bridge client password>' \
-e MC_CHANNEL='<channel in which you communicate>' \
-e SERVER_ADDRESS='<ip address where players can connect to the server>' \
mc-bridge

This should successfully launch your bridged Minecraft server.