Bram
/
Minecraft-bridge
mirror of https://github.com/BramvdnHeuvel/Minecraft-bridge/
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Host a bridge between Minecraft and Matrix
20 Commits
1 Branch
0 Tags
84 KiB
Python 93.2%
Shell 3.7%
Dockerfile 3.1%
 
 
 
Go to file
Bram van den Heuvel eb5ba196cb Fix Docker container merge 
While the Docker daemon had little trouble combining the two images on WSL, it wasn't able to do so in other environments. This approach is a little more universal.
 		2023-10-02 16:11:33 +02:00
src Allow NBSR for stderr 2023-10-02 00:36:12 +02:00
.gitignore Add project-specific ignores 2023-10-01 16:41:56 +02:00
Dockerfile Fix Docker container merge 2023-10-02 16:11:33 +02:00
LICENSE.md Update license with personal name 2021-06-27 21:18:12 +02:00
README.md Fix bugs + clean code 2023-10-01 20:49:47 +02:00
config.yaml Fix bugs + clean code 2023-10-01 20:49:47 +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
whitelist.json Fix bugs + clean code 2023-10-01 20:49:47 +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

  1. Create a Docker image using the following command:
docker build -t matrix-mc-server ./

  1. Download the latest Minecraft server jar file.

  2. 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.

  1. 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
        ports:
            - 25565:25565