From 2f4291f07706d52a1e9f8a62c6ea16d8b62f9bdd Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Sun, 28 Jan 2024 11:09:18 -0500 Subject: [PATCH 1/7] Changed overridden to overwritten --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 731e94a..bb3f0ca 100644 --- a/README.md +++ b/README.md @@ -264,7 +264,7 @@ The server will run a save before the backup if rcon is enabled. When the server starts, a `PalWorldSettings.ini` file will be created in the following location: `/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini` -Any changes made while the server is live will be overridden. +Any changes made while the server is live will be overwritten. Please keep in mind that the ENV variables will always overwrite the changes made to `PalWorldSettings.ini`. From 01813b31f01bdb9c68278bccacbe14d0af86e15d Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Sun, 28 Jan 2024 11:12:57 -0500 Subject: [PATCH 2/7] Added clarification --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bb3f0ca..7cbeab1 100644 --- a/README.md +++ b/README.md @@ -264,7 +264,7 @@ The server will run a save before the backup if rcon is enabled. When the server starts, a `PalWorldSettings.ini` file will be created in the following location: `/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini` -Any changes made while the server is live will be overwritten. +Any changes made while the server is live will be overwritten when the server stops. Please keep in mind that the ENV variables will always overwrite the changes made to `PalWorldSettings.ini`. From 791fc6cb119b9e80252905a1b4059b15f888c530 Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Sun, 28 Jan 2024 11:13:34 -0500 Subject: [PATCH 3/7] Moved line to important element --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 7cbeab1..1476078 100644 --- a/README.md +++ b/README.md @@ -264,12 +264,11 @@ The server will run a save before the backup if rcon is enabled. When the server starts, a `PalWorldSettings.ini` file will be created in the following location: `/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini` -Any changes made while the server is live will be overwritten when the server stops. - Please keep in mind that the ENV variables will always overwrite the changes made to `PalWorldSettings.ini`. > [!IMPORTANT] > Changes can only be made to `PalWorldSettings.ini` while the server is off. +> Any changes made while the server is live will be overwritten when the server stops. For a more detailed list of explanations of server settings go to: [shockbyte](https://shockbyte.com/billing/knowledgebase/1189/How-to-Configure-your-Palworld-server.html) From 2ecf26d79247f230ca278db2cc84c29d9a16489b Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Sun, 28 Jan 2024 11:14:59 -0500 Subject: [PATCH 4/7] Added new line --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 1476078..87a4dd7 100644 --- a/README.md +++ b/README.md @@ -268,6 +268,7 @@ Please keep in mind that the ENV variables will always overwrite the changes mad > [!IMPORTANT] > Changes can only be made to `PalWorldSettings.ini` while the server is off. +> > Any changes made while the server is live will be overwritten when the server stops. For a more detailed list of explanations of server settings go to: [shockbyte](https://shockbyte.com/billing/knowledgebase/1189/How-to-Configure-your-Palworld-server.html) From 000163195119511d22d22c061e6d1a1a80afe181 Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Sun, 28 Jan 2024 11:19:25 -0500 Subject: [PATCH 5/7] Removed space --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 87a4dd7..3bb677c 100644 --- a/README.md +++ b/README.md @@ -268,7 +268,7 @@ Please keep in mind that the ENV variables will always overwrite the changes mad > [!IMPORTANT] > Changes can only be made to `PalWorldSettings.ini` while the server is off. -> +> > Any changes made while the server is live will be overwritten when the server stops. For a more detailed list of explanations of server settings go to: [shockbyte](https://shockbyte.com/billing/knowledgebase/1189/How-to-Configure-your-Palworld-server.html) From 783e2c4130c78712ef71392d1be065292ccc0782 Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Sun, 28 Jan 2024 11:40:46 -0500 Subject: [PATCH 6/7] Changed to superscript for notes --- README.md | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 3bb677c..3a5ec95 100644 --- a/README.md +++ b/README.md @@ -120,11 +120,11 @@ It is highly recommended you set the following environment values before startin | Variable | Info | Default Values | Allowed Values | |--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|------------------------------------------------------------------------------------------------------------| | TZ | Timezone used for time stamping backup server | UTC | See [TZ Identifiers](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#Time_Zone_abbreviations) | -| PLAYERS* | Max amount of players that are able to join the server | 16 | 1-32 | -| PORT* | UDP port that the server will expose | 8211 | 1024-65535 | -| PUID* | The uid of the user the server should run as | 1000 | !0 | -| PGID* | The gid of the group the server should run as | 1000 | !0 | -| MULTITHREADING** | Improves performance in multi-threaded CPU environments. It is effective up to a maximum of about 4 threads, and allocating more than this number of threads does not make much sense. | false | true/false | +| PLAYERS1 | Max amount of players that are able to join the server | 16 | 1-32 | +| PORT1 | UDP port that the server will expose | 8211 | 1024-65535 | +| PUID1 | The uid of the user the server should run as | 1000 | !0 | +| PGID1 | The gid of the group the server should run as | 1000 | !0 | +| MULTITHREADING2 | Improves performance in multi-threaded CPU environments. It is effective up to a maximum of about 4 threads, and allocating more than this number of threads does not make much sense. | false | true/false | | COMMUNITY | Whether or not the server shows up in the community server browser (USE WITH SERVER_PASSWORD) | false | true/false | | PUBLIC_IP | You can manually specify the global IP address of the network on which the server running. If not specified, it will be detected automatically. If it does not work well, try manual configuration. | | x.x.x.x | | PUBLIC_PORT | You can manually specify the port number of the network on which the server running. If not specified, it will be detected automatically. If it does not work well, try manual configuration. | | 1024-65535 | @@ -132,16 +132,14 @@ It is highly recommended you set the following environment values before startin | SERVER_DESCRIPTION | Your server Description | | "string" | | SERVER_PASSWORD | Secure your community server with a password | | "string" | | ADMIN_PASSWORD | Secure administration access in the server with a password | | "string" | -| UPDATE_ON_BOOT** | Update/Install the server when the docker container starts (THIS HAS TO BE ENABLED THE FIRST TIME YOU RUN THE CONTAINER) | true | true/false | -| RCON_ENABLED*** | Enable RCON for the Palworld server | true | true/false | +| UPDATE_ON_BOOT2 | Update/Install the server when the docker container starts (THIS HAS TO BE ENABLED THE FIRST TIME YOU RUN THE CONTAINER) | true | true/false | +| RCON_ENABLED3 | Enable RCON for the Palworld server | true | true/false | | RCON_PORT | RCON port to connect to | 25575 | 1024-65535 | | QUERY_PORT | Query port used to communicate with Steam servers | 27015 | 1024-65535 | -*highly recommended to set - -** Make sure you know what you are doing when running this option enabled - -*** Required for docker stop to save and gracefully close the server +1 highly recommended to set +2 Make sure you know what you are doing when running this option enabled +3 Required for docker stop to save and gracefully close the server > [!IMPORTANT] > Boolean values used in environment variables are case sensitive because they are used in the shell script. From 20a486bac248313675e5bfafe6c246c3bd3293ab Mon Sep 17 00:00:00 2001 From: "Carlos M. Martinez" Date: Sun, 28 Jan 2024 11:19:25 -0500 Subject: [PATCH 7/7] Reverted to pure markdown. --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 3a5ec95..3bb677c 100644 --- a/README.md +++ b/README.md @@ -120,11 +120,11 @@ It is highly recommended you set the following environment values before startin | Variable | Info | Default Values | Allowed Values | |--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|------------------------------------------------------------------------------------------------------------| | TZ | Timezone used for time stamping backup server | UTC | See [TZ Identifiers](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#Time_Zone_abbreviations) | -| PLAYERS1 | Max amount of players that are able to join the server | 16 | 1-32 | -| PORT1 | UDP port that the server will expose | 8211 | 1024-65535 | -| PUID1 | The uid of the user the server should run as | 1000 | !0 | -| PGID1 | The gid of the group the server should run as | 1000 | !0 | -| MULTITHREADING2 | Improves performance in multi-threaded CPU environments. It is effective up to a maximum of about 4 threads, and allocating more than this number of threads does not make much sense. | false | true/false | +| PLAYERS* | Max amount of players that are able to join the server | 16 | 1-32 | +| PORT* | UDP port that the server will expose | 8211 | 1024-65535 | +| PUID* | The uid of the user the server should run as | 1000 | !0 | +| PGID* | The gid of the group the server should run as | 1000 | !0 | +| MULTITHREADING** | Improves performance in multi-threaded CPU environments. It is effective up to a maximum of about 4 threads, and allocating more than this number of threads does not make much sense. | false | true/false | | COMMUNITY | Whether or not the server shows up in the community server browser (USE WITH SERVER_PASSWORD) | false | true/false | | PUBLIC_IP | You can manually specify the global IP address of the network on which the server running. If not specified, it will be detected automatically. If it does not work well, try manual configuration. | | x.x.x.x | | PUBLIC_PORT | You can manually specify the port number of the network on which the server running. If not specified, it will be detected automatically. If it does not work well, try manual configuration. | | 1024-65535 | @@ -132,14 +132,16 @@ It is highly recommended you set the following environment values before startin | SERVER_DESCRIPTION | Your server Description | | "string" | | SERVER_PASSWORD | Secure your community server with a password | | "string" | | ADMIN_PASSWORD | Secure administration access in the server with a password | | "string" | -| UPDATE_ON_BOOT2 | Update/Install the server when the docker container starts (THIS HAS TO BE ENABLED THE FIRST TIME YOU RUN THE CONTAINER) | true | true/false | -| RCON_ENABLED3 | Enable RCON for the Palworld server | true | true/false | +| UPDATE_ON_BOOT** | Update/Install the server when the docker container starts (THIS HAS TO BE ENABLED THE FIRST TIME YOU RUN THE CONTAINER) | true | true/false | +| RCON_ENABLED*** | Enable RCON for the Palworld server | true | true/false | | RCON_PORT | RCON port to connect to | 25575 | 1024-65535 | | QUERY_PORT | Query port used to communicate with Steam servers | 27015 | 1024-65535 | -1 highly recommended to set -2 Make sure you know what you are doing when running this option enabled -3 Required for docker stop to save and gracefully close the server +*highly recommended to set + +** Make sure you know what you are doing when running this option enabled + +*** Required for docker stop to save and gracefully close the server > [!IMPORTANT] > Boolean values used in environment variables are case sensitive because they are used in the shell script.