diff --git a/README.md b/README.md index 8ed9bcd..603dd8c 100644 --- a/README.md +++ b/README.md @@ -1 +1,30 @@ -Minecraft-bridge +# 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 "":/usr/src/app/world \ +-e EULA=true \ +-e MATRIX_HOMESERVER='' \ +-e MATRIX_USERNAME='' \ +-e MATRIX_PASSWORD='' \ +-e MC_CHANNEL='' \ +-e SERVER_ADDRESS='' \ +mc-bridge +``` + +This should successfully launch your bridged Minecraft server.