From 0a9b349b69bd2c63e125606ffb1cdab32cb019e4 Mon Sep 17 00:00:00 2001 From: okazakee Date: Tue, 24 Jan 2023 22:36:34 +0100 Subject: [PATCH] updated readme --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 16295f8..03c6e89 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ This image provides a basic Minecraft server using one of the supported provider - [x] Better logging, remove useless console outputs and give the user clear and clean messages of what is going on. - [x] Replace Openjdk with Temurin -> reduced docker image size by 57.52%! - [ ] Add flag to disable lazymc. -- [ ] Fix builds fetch if latest is not selected. +- [ ] Fix fetch when user specifies a build number. - [ ] Build a webpage for the project. - [ ] Automatically update server variables inside lazymc.toml: - [x] Jar startup command. @@ -110,7 +110,7 @@ This image has seven environment variables: - **Name:** `CPU_ARCH` - Set this to the cpu architecture you want to use. - Avaliable architectures are: `x64`, `x64-static`, `aarch64`, `armv7`. - - No default value for this, make sure to include it in the command. + - No default value for this, make sure to include it in the command or docker compose. - `-e CPU_ARCH=""` - Server Provider - **Name:** `SERVER_PROVIDER` @@ -119,20 +119,20 @@ This image has seven environment variables: - `-e SERVER_PROVIDER=""` - Lazymc Version - **Name:** `LAZYMC_VERSION` - - Set this to the version of `lazymc` you want to use. - - If not set, the [latest release](https://github.com/timvisee/lazymc/releases/latest) will be used. + - Set this to the version of Lazymc you want to use. + - Default value: `latest`. - `-e LAZYMC_VERSION=""` - Minecraft Version - **Name:** `MC_VERSION` - Set this to the Minecraft version that the server should support. - Note: there must be a PaperMC (or alternatives) release for the specified version of Minecraft. - - If this is not set, the latest version supported by PaperMC (or alternatives) will be used. + - Default value: `latest`. - Changing this on an existing server will change the version *without wiping the server*. - `-e MC_VERSION=""` - Server Build - **Name:** `SERVER_BUILD` - Set this to the number of the PaperMC (or alternatives) build that the server should use (**not the Minecraft version**). - - If this is not set, the latest PaperMC (or alternatives) build for the specified `MC_VERSION` will be used. + - Default value: `latest`. - Changing this on an existing server will change the version *without wiping the server*. - `-e SERVER_BUILD=""` - RAM