From f307077636ad32ee5de1772fb76baba6986c9088 Mon Sep 17 00:00:00 2001 From: Ross Holmberg Date: Thu, 2 Sep 2021 12:21:11 +1000 Subject: [PATCH 01/14] Typo (#1027) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 45d1b375..b85dd6a6 100644 --- a/README.md +++ b/README.md @@ -823,7 +823,7 @@ The server icon which has been set doesn't get overridden by default. It can be ### Rcon -To use rcon use the `ENABLE_RCON` and `RCON_PASSORD` variables. +To use rcon use the `ENABLE_RCON` and `RCON_PASSWORD` variables. By default rcon port will be `25575` but can easily be changed with the `RCON_PORT` variable. docker run -d -e ENABLE_RCON=true -e RCON_PASSWORD=testing From 748768c771253942fc97d2e61626ec6ea006e76c Mon Sep 17 00:00:00 2001 From: itzg Date: Thu, 2 Sep 2021 02:21:29 +0000 Subject: [PATCH 02/14] docs: Auto update markdown TOC --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b85dd6a6..f7d3d452 100644 --- a/README.md +++ b/README.md @@ -129,7 +129,7 @@ By default, the container will download the latest version of the "vanilla" [Min * [Enabling Autopause](#enabling-autopause) * [Running on RaspberryPi](#running-on-raspberrypi) - + From f9ce5bce4d09728b2db330c640e7dcb69631a5b3 Mon Sep 17 00:00:00 2001 From: Geoff Bourne Date: Fri, 3 Sep 2021 16:51:00 -0500 Subject: [PATCH 03/14] docs: fixed heading level of timezone config --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f7d3d452..f8304ef5 100644 --- a/README.md +++ b/README.md @@ -1264,7 +1264,7 @@ By default the vanilla log file will grow without limit. The logger can be recon > **NOTE** this will interfere with interactive/color consoles [as described in the section above](#interactive-and-color-console) -## Timezone Configuration +### Timezone Configuration You can configure the timezone to match yours by setting the `TZ` environment variable: From 7d1d5af0974d0dd3be87c2d80e56d1f46c354dd9 Mon Sep 17 00:00:00 2001 From: itzg Date: Fri, 3 Sep 2021 21:51:18 +0000 Subject: [PATCH 04/14] docs: Auto update markdown TOC --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f8304ef5..4db2c570 100644 --- a/README.md +++ b/README.md @@ -117,7 +117,7 @@ By default, the container will download the latest version of the "vanilla" [Min * [Server Shutdown Options](#server-shutdown-options) * [OpenJ9 Specific Options](#openj9-specific-options) * [Enabling rolling logs](#enabling-rolling-logs) - * [Timezone Configuration](#timezone-configuration) + * [Timezone Configuration](#timezone-configuration) * [Enable Remote JMX for Profiling](#enable-remote-jmx-for-profiling) * [Enable Aikar's Flags](#enable-aikars-flags) * [HTTP Proxy](#http-proxy) @@ -129,7 +129,7 @@ By default, the container will download the latest version of the "vanilla" [Min * [Enabling Autopause](#enabling-autopause) * [Running on RaspberryPi](#running-on-raspberrypi) - + From 201ec3be5ae7b9d1ac56ac4652a5d908c47b88ac Mon Sep 17 00:00:00 2001 From: Geoff Bourne Date: Sat, 4 Sep 2021 11:04:23 -0500 Subject: [PATCH 05/14] docs: added SETUP_ONLY --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 4db2c570..eab2db20 100644 --- a/README.md +++ b/README.md @@ -1323,6 +1323,10 @@ disable that by passing `-e GUI=FALSE`. When the container is signalled to stop, the Minecraft process wrapper will attempt to send a "stop" command via RCON or console and waits for the process to gracefully finish. By default it waits 60 seconds, but that duration can be configured by setting the environment variable `STOP_DURATION` to the number of seconds. +### Setup only + +If you are using a host-attached data directory, then you can have the image setup the Minecraft server files and stop prior to launching the server process by setting `SETUP_ONLY` to `true`. + ## Autopause ### Description From 7bafffbd06beb6ec8f083d938f2dc1bdf91e3003 Mon Sep 17 00:00:00 2001 From: itzg Date: Sat, 4 Sep 2021 16:04:43 +0000 Subject: [PATCH 06/14] docs: Auto update markdown TOC --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index eab2db20..6d07a0fd 100644 --- a/README.md +++ b/README.md @@ -124,12 +124,13 @@ By default, the container will download the latest version of the "vanilla" [Min * [Using "noconsole" option](#using-noconsole-option) * [Explicitly disable GUI](#explicitly-disable-gui) * [Stop Duration](#stop-duration) + * [Setup only](#setup-only) * [Autopause](#autopause) * [Description](#description) * [Enabling Autopause](#enabling-autopause) * [Running on RaspberryPi](#running-on-raspberrypi) - + From f7cd34b8d862bcad55f8893d9fafcdef55236188 Mon Sep 17 00:00:00 2001 From: Geoff Bourne Date: Sat, 4 Sep 2021 19:46:08 -0500 Subject: [PATCH 07/14] Added unicode conversion for MOTD #1025 --- Dockerfile | 3 +++ start-finalSetupServerProperties | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index d2da5881..4281b814 100644 --- a/Dockerfile +++ b/Dockerfile @@ -59,6 +59,9 @@ RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \ --var version=0.1.1 --var app=maven-metadata-release --file {{.app}} \ --from https://github.com/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz +ADD https://jitpack.io/com/github/itzg/asciify/1.0.0/asciify-1.0.0.jar /usr/share/asciify/asciify.jar +RUN chmod -R a+r /usr/share/asciify + COPY mcstatus /usr/local/bin VOLUME ["/data"] diff --git a/start-finalSetupServerProperties b/start-finalSetupServerProperties index 33708461..79a45ec6 100644 --- a/start-finalSetupServerProperties +++ b/start-finalSetupServerProperties @@ -56,7 +56,7 @@ function customizeServerProps { setServerProp "server-name" "$SERVER_NAME" setServerProp "server-ip" "$SERVER_IP" setServerProp "server-port" "$SERVER_PORT" - setServerProp "motd" "$MOTD" + setServerProp "motd" "$(echo $MOTD | java -jar /usr/share/asciify/asciify.jar)" setServerProp "allow-nether" "$ALLOW_NETHER" setServerProp "announce-player-achievements" "$ANNOUNCE_PLAYER_ACHIEVEMENTS" setServerProp "enable-command-block" "$ENABLE_COMMAND_BLOCK" From 296ddbdec54ba7ae786fd3815e536f71180ec02b Mon Sep 17 00:00:00 2001 From: Geoff Bourne Date: Sun, 5 Sep 2021 14:11:26 -0500 Subject: [PATCH 08/14] docs: described unicode conversion for MOTD --- Dockerfile | 3 ++- README.md | 10 +++++++++- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/Dockerfile b/Dockerfile index 4281b814..617ee7ab 100644 --- a/Dockerfile +++ b/Dockerfile @@ -59,7 +59,8 @@ RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \ --var version=0.1.1 --var app=maven-metadata-release --file {{.app}} \ --from https://github.com/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz -ADD https://jitpack.io/com/github/itzg/asciify/1.0.0/asciify-1.0.0.jar /usr/share/asciify/asciify.jar +ARG ASCIIFY_VERSION=1.0.1 +ADD https://jitpack.io/com/github/itzg/asciify/${ASCIIFY_VERSION}/asciify-${ASCIIFY_VERSION}.jar /usr/share/asciify/asciify.jar RUN chmod -R a+r /usr/share/asciify COPY mcstatus /usr/local/bin diff --git a/README.md b/README.md index 6d07a0fd..1c30e934 100644 --- a/README.md +++ b/README.md @@ -969,7 +969,7 @@ For example: ### Message of the Day -The message of the day, shown below each server entry in the UI, can be changed with the `MOTD` environment variable, such as +The message of the day, shown below each server entry in the client UI, can be changed with the `MOTD` environment variable, such as -e MOTD="My Server" @@ -979,6 +979,14 @@ If you leave it off, a default is computed from the server type and version, suc That way you can easily differentiate between several servers you may have started. +The section symbol (§) and other unicode characters are automatically converted to allow [formatting codes](https://minecraft.fandom.com/wiki/Formatting_codes) to be used consistently with all server versions. For example, + + -e MOTD="A §l§cMinecraft§r §nserver" + +renders + +![](docs/motd-example.png) + ### PVP Mode By default, servers are created with player-vs-player (PVP) mode enabled. You can disable this with the `PVP` From d3f4a4991e0c9b8ab477cdce3ac0332998bc6b92 Mon Sep 17 00:00:00 2001 From: itzg Date: Sun, 5 Sep 2021 19:11:45 +0000 Subject: [PATCH 09/14] docs: Auto update markdown TOC --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1c30e934..1360e7ec 100644 --- a/README.md +++ b/README.md @@ -130,7 +130,7 @@ By default, the container will download the latest version of the "vanilla" [Min * [Enabling Autopause](#enabling-autopause) * [Running on RaspberryPi](#running-on-raspberrypi) - + From e1d0fe6b923547a60b998afb7e9ce8d89d37b95e Mon Sep 17 00:00:00 2001 From: Geoff Bourne Date: Mon, 6 Sep 2021 10:52:44 -0500 Subject: [PATCH 10/14] docs: added world data diagram to README --- README.md | 4 ++++ docs/motd-example.png | Bin 0 -> 985 bytes 2 files changed, 4 insertions(+) create mode 100644 docs/motd-example.png diff --git a/README.md b/README.md index 1360e7ec..404ec00b 100644 --- a/README.md +++ b/README.md @@ -746,6 +746,10 @@ read-only volume attachment to ensure the clone source remains pristine. docker run ... -v $HOME/worlds:/worlds:ro -e WORLD=/worlds/basic ``` +The following diagram shows how this option can be used in a compose deployment with a relative directory: + +![](docs/world-copy-compose-project.drawio.png) + ### Overwrite world on start The world will only be downloaded or copied if it doesn't exist already. Set `FORCE_WORLD_COPY=TRUE` to force overwrite the world on every server start. diff --git a/docs/motd-example.png b/docs/motd-example.png new file mode 100644 index 0000000000000000000000000000000000000000..265c66a61401c058890955b48386edbc262a6bb3 GIT binary patch literal 985 zcmV;~119{5P)Px#1ZP1_K>z@;j|==^1poj532;bRa{vGi!vFvd!vV){sAK>D18zw~K~#8N?VH_d zQ$ZAk^Vc@jqV)&#fdXPt@in|CQZcA_Eh-U9@WR&+m5PuD@$}-AnK?7F=VbPpIVY)JyR`YMk{FFoQmULry_QntH0t$~iVTLwDHY-Ck1J~_ z6#X~~ zD5vSa6h(*(3W~DVeim%!)r(*`qU=6;5-gM@S5W{f2RJPSVa{qq%~e(@%50=4LM)k5 zMe+D|R^fG4T#<-)*S~%a77D|8R+_C(AA;@Qy&tRvM^Z$PZ>`(GGUyi|g0R8?Zl5DK zU&r+kaamb`)xL!{FE|T=(RiFvr1g9Rw( z>rtO0s;6iiQLOQS?SrCUhdZ;|W4L|HH~S4d|9MYtDGHx8ffZ4w?>mU~_u9qwP#@s? z1i1fs6$MJd6$ Date: Mon, 6 Sep 2021 15:53:03 +0000 Subject: [PATCH 11/14] docs: Auto update markdown TOC --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 404ec00b..eec25fa5 100644 --- a/README.md +++ b/README.md @@ -130,7 +130,7 @@ By default, the container will download the latest version of the "vanilla" [Min * [Enabling Autopause](#enabling-autopause) * [Running on RaspberryPi](#running-on-raspberrypi) - + From cf31f2475244ad19a9d6c3bca09cb9bdf4113336 Mon Sep 17 00:00:00 2001 From: brutalgg Date: Fri, 10 Sep 2021 11:26:19 -0400 Subject: [PATCH 12/14] docs: Add RLCraft example (#1036) --- examples/docker-compose-rlcraft.yml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 examples/docker-compose-rlcraft.yml diff --git a/examples/docker-compose-rlcraft.yml b/examples/docker-compose-rlcraft.yml new file mode 100644 index 00000000..0bda0d9a --- /dev/null +++ b/examples/docker-compose-rlcraft.yml @@ -0,0 +1,27 @@ +version: '3.8' + +services: + rlcraft: + image: itzg/minecraft-server:java8 + container_name: rlcraft + volumes: + - rlcraft-modpack:/modpacks:ro + - rlcraft-data:/data + environment: + EULA: "true" + TYPE: "FORGE" + VERSION: "1.12.2" + FORGEVERSION: "14.23.5.2855" + DIFFICULTY: "hard" + MAX_TICK_TIME: "-1" + VIEW_DISTANCE: "6" + ALLOW_FLIGHT: "true" + MEMORY: "4G" + GENERIC_PACK: "/modpacks/RLCraft_Server_Pack_1.12.2_Beta_v2.8.2.zip" + ports: + - 25565:25565 + restart: unless-stopped + +volumes: + rlcraft-data: + rlcraft-modpack: From 6c1cd2537d09fc4818c4307ef530fcd71825b9fe Mon Sep 17 00:00:00 2001 From: Geoff Bourne Date: Sun, 12 Sep 2021 21:02:13 -0500 Subject: [PATCH 13/14] misc: created FUNDING.yml --- .github/FUNDING.yml | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .github/FUNDING.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 00000000..1c44c923 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,5 @@ + +#github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] +custom: + - https://www.buymeacoffee.com/itzg + - https://paypal.me/itzg From 0cd49c4c81e4f2e73ba3c03a1f152e45c4e88b92 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 13 Sep 2021 06:55:47 -0500 Subject: [PATCH 14/14] build(deps): bump stefanzweifel/git-auto-commit-action (#1042) --- .github/workflows/generate-toc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/generate-toc.yml b/.github/workflows/generate-toc.yml index 19e259e2..684d9a8d 100644 --- a/.github/workflows/generate-toc.yml +++ b/.github/workflows/generate-toc.yml @@ -16,6 +16,6 @@ jobs: curl https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc -o gh-md-toc chmod a+x gh-md-toc ./gh-md-toc --insert --no-backup README.md - - uses: stefanzweifel/git-auto-commit-action@v4.11.0 + - uses: stefanzweifel/git-auto-commit-action@v4.12.0 with: commit_message: "docs: Auto update markdown TOC" \ No newline at end of file