Host a bridge between Minecraft and Matrix

Go to file

Bram van den Heuvel b3ab94ef78 Recreate Docker instructions		2023-10-01 16:53:35 +02:00
src	Move config.py	2023-10-01 16:41:00 +02:00
.gitignore	Add project-specific ignores	2023-10-01 16:41:56 +02:00
Dockerfile	Recreate Docker instructions	2023-10-01 16:53:35 +02:00
LICENSE.md	Update license with personal name	2021-06-27 21:18:12 +02:00
README.md	Recreate Docker instructions	2023-10-01 16:53:35 +02:00
config.yaml	Config refactor part 3	2023-10-01 16:20:22 +02:00
main.py	Move config.py	2023-10-01 16:41:00 +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

Create a Docker image using the following command:

docker build -t matrix-mc-server ./

Download the latest Minecraft server jar file.
Open config.yaml and adjust it to however you like.

NOTE: Make sure to set EULA to true otherwise the server will refuse to start.

Start the Docker container. You will need a few volumes:

/usr/src/app/config.yaml - Location of your custom config.yaml
/usr/src/app/whitelist.json - Location of your whitelist, if any.
/usr/src/app/world/ - Folder of your custom Minecraft world to load
/usr/src/app/server.jar - (Default) location of the server jar file. Can be changed in config.yaml.

For example, your Docker compose file could look like the following:

version: '3'

services:
    matrix-mc-server:
        image: matrix-mc-server:latest
        volumes:
            - <your config>:/usr/src/app/config.yaml
            - <your whitelist>:/usr/src/app/whitelist.json
            - <your world folder>:/usr/src/app/world
            - <your server jar file>:/usr/src/app/server.jar