From 9a5292d65cf3de9f4703d43a40b89d76bc69ae3e Mon Sep 17 00:00:00 2001 From: Joey Hafner Date: Mon, 9 May 2022 21:55:42 -0700 Subject: [PATCH] Add documentation --- homelab/server/config/minecraft/README.md | 15 +++++++++++++-- homelab/server/config/minecraft/bmcp.yml | 6 +++--- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/homelab/server/config/minecraft/README.md b/homelab/server/config/minecraft/README.md index 391fc995..dc1fe5ad 100644 --- a/homelab/server/config/minecraft/README.md +++ b/homelab/server/config/minecraft/README.md @@ -1,9 +1,20 @@ ## Connecting to a server's CLI -`docker attach minecraft_e6` +`docker exec -it rcon-cli --password thanksitzg` https://github.com/itzg/docker-minecraft-server#interactive-and-color-console https://github.com/itzg/docker-minecraft-server#use-rcon-commands ## Updating MC-Router mappings MC-Router must be running for all active MC connections. Restarting it kicks everyone off their servers -To update the mappings while running, use `docker exec mc-router /mc-router --mapping ` \ No newline at end of file +To update the mappings while running, use `docker exec mc-router /mc-router --mapping ` + +## Before Starting a Server +Check the following server.properties values: +| Parameter | Value | Why | +|:--:|:--:|:--:| +| `allow-flight` | true | Many modded features trigger Minecraft's flight detection. Allow flight to prevent wrongful bans. +| `enable-rcon` | true | This overrides any rcon settings in the compose file. Enable rcon to interact with the server's command line | +| `max-tick-time` | 600 normally, 120000 when pre-genning chunks | Increase the max tick time to prevent the hang watchdog from killing the server when pregenning chunks | +| `rcon.password` | `thanksitzg` | Set a simple password to protect the rcon port | +| `rcon.port` | `25575` | Set this to what itzg's rcon-cli expects as default | +| `view-distance` | 10 for lightweight servers, 6 for heavy servers | View distance has great impact on server load | \ No newline at end of file diff --git a/homelab/server/config/minecraft/bmcp.yml b/homelab/server/config/minecraft/bmcp.yml index 2b21b283..ca973e89 100644 --- a/homelab/server/config/minecraft/bmcp.yml +++ b/homelab/server/config/minecraft/bmcp.yml @@ -11,9 +11,9 @@ services: - VERSION=1.16.5 - FORGEVERSION=36.2.28 - OPS=jafner425 - - ENABLE_RCON=true - - RCON_PORT=25575 - - RCON_PASSWORD=${RCON_PASSWORD} + - ENABLE_RCON=true # This does not override server.properties + - RCON_PORT=25575 # This does not override server.properties + - RCON_PASSWORD=${RCON_PASSWORD} # This does not override server.properties volumes: - $DOCKER_DATA/bmcp:/data:rw networks: