From fe266e57de5f2aaa82c37707f194749faaf1271c Mon Sep 17 00:00:00 2001 From: Jimmy Date: Tue, 5 Jan 2021 03:23:47 +1300 Subject: [PATCH] Update readme --- README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 59 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d89f0f7..89a3afa 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,60 @@ -# minecraftimage +# Docker Minecraft -Docker wrapper to run Minecraft in Docker \ No newline at end of file +Wrapper to run Minecraft in Docker + + +## Build Image + +```./build.sh``` + +## Get Minecraft Sever For Testing + +```./get_minecraft.sh``` + +## Run Server + +```docker-compose up -d``` + +```docker run -it --name minecraft -p 25565:25565 -v $PWD:/server -e MAX_MEM=1G magmise/minecraft``` + +## Get Logs + +```docker-compose logs``` + +```docker logs minecraft``` + +## Send Command to Server + +```docker-compose exec cmd say hello``` + +```docker exec minecraft cmd say hello``` + +## Attach to Container + +```docker attach minecraft``` + +To detach use ```ctrl+p ctrl+q``` + +Don't use ```ctrl+c``` to disconnect, it will kill the server + +## Varialbles + +### JAR + +Default is ```server.jar``` + +### MIN_MEM + +Default is ```512M``` + +### MAX_MEM + +Default is ```1G``` + +### STOP + +Default is ```stop``` + +This would be used for the Bungee where the stop command is ```end``` + +## Volumes