diff --git a/README.md b/README.md index f9adca4..e8d5c42 100644 --- a/README.md +++ b/README.md @@ -28,15 +28,15 @@ With this image it is possible to update the game to the latest version - see `G The only mandatory requirement for Sunkeland to be able to run is to pass the WorlGUID as a start parameter. Additionally, to gain more control about some of the Sunkenland Dedicated Server configuration parameter, you can set some more specific environment variables. You can find the full documentation of all parameters [here](https://www.sunkenlandgame.com/post/dedicated-server-user-manual). -| Parameter name | Description | Default value | Mandatory | -|:-----------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|--------------:|----------:| -| GAME_WORLD_GUID | Set the WorldGUID for Sunkenland. Without this parameter Sunkenland is not able to start. Will be checked if set during startup and logs an error message if not set | - | yes | -| GAME_PASSWORD | Set the game password. Maximum allowed password length is 8 | - | no | -| GAME_REGION | Set the region for Sunkenland Dedicated Server.see [official documentation](https://www.sunkenlandgame.com/post/dedicated-server-user-manual) for more information | eu | no | -| GAME_MAX_PLAYER | Set the maximum of allowed player for your instance. Max is 15. | 3 | no | -| GAME_SESSION_INVISIBLE | Set the game session to invisible. If set to "true", game will not be visible in the dedicated server overview within the game. You must either invite your friends or join by ServerID which is posted to the console after startup | false | no | -| GAME_UPDATE | As this image already contains a pre-installed version of Sunkenland, with this parameter you are able to update to the latest available version | false | no | -| GAME_BETA_VERSION | With this parameter you're able to pass a beta version (if it is available). This only is considered in combination with parameter `GAME_UPDATE: true`. Example: `GAME_BETA_VERSION: publictest` | false | no | +| Parameter name | Description | Default value | Mandatory | +|:-----------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|--------------:|----------:| +| GAME_WORLD_GUID | Set the WorldGUID for Sunkenland. Without this parameter Sunkenland is not able to start. Will be checked if set during startup and logs an error message if not set | - | yes | +| GAME_PASSWORD | Set the game password. Maximum allowed password length is 8 | - | no | +| GAME_REGION | Set the region for Sunkenland Dedicated Server.see [official documentation](https://www.sunkenlandgame.com/post/dedicated-server-user-manual) for more information | eu | no | +| GAME_MAX_PLAYER | Set the maximum of allowed player for your instance. Max is 15. | 3 | no | +| GAME_SESSION_INVISIBLE | Set the game session to invisible. If set to "true", game will not be visible in the dedicated server overview within the game. You must either invite your friends or join by ServerID which is posted to the console after startup | false | no | +| GAME_UPDATE | As this image already contains a pre-installed version of Sunkenland, with this parameter you are able to update to the latest available version | false | no | +| GAME_BETA_VERSION | With this parameter you're able to pass a beta version (if it is available). This only is considered in combination with parameter `GAME_UPDATE: true`. Example: `GAME_BETA_VERSION: publictest`. Do not set this value if you want to run the latest public release. | false | no | ### Docker Example (minimal) docker exec command: diff --git a/startSunkenland.sh b/startSunkenland.sh index 3c62948..69bc4ba 100644 --- a/startSunkenland.sh +++ b/startSunkenland.sh @@ -31,7 +31,7 @@ if ${GAME_SESSION_INVISIBLE} = true; then fi if ${GAME_UPDATE} = true; then - if [ -z "${GAME_BETA_VERSION}" ]; then + if [ -n "${GAME_BETA_VERSION}" ]; then BETA_VERSION="-beta ${GAME_BETA_VERSION}" echo "Updating to beta version ${GAME_BETA_VERSION}" fi