From 6394c1f83de6742d1e58b508969b24cbf1d20145 Mon Sep 17 00:00:00 2001 From: Thijs van Loef Date: Thu, 27 Jun 2024 14:35:58 +0200 Subject: [PATCH] Add missing configuration options --- .env.example | 3 + README.md | 195 +++++++++--------- .../configuration/game-settings.md | 3 + scripts/compile-settings.sh | 6 + scripts/files/PalWorldSettings.ini.template | 3 + 5 files changed, 114 insertions(+), 96 deletions(-) diff --git a/.env.example b/.env.example index e881cc32..b0a32082 100644 --- a/.env.example +++ b/.env.example @@ -68,8 +68,10 @@ DROP_ITEM_ALIVE_MAX_HOURS=1.000000 AUTO_RESET_GUILD_NO_ONLINE_PLAYERS=False AUTO_RESET_GUILD_TIME_NO_ONLINE_PLAYERS=72.00000 GUILD_PLAYER_MAX_NUM=20 +BASE_CAMP_MAX_NUM_IN_GUILD=4 PAL_EGG_DEFAULT_HATCHING_TIME=72.00000 WORK_SPEED_RATE=1.000000 +AUTO_SAVE_SPAN=30.000000 IS_MULTIPLAY=False IS_PVP=False CAN_PICKUP_OTHER_GUILD_DEATH_PENALTY_DROP=False @@ -78,6 +80,7 @@ ENABLE_FAST_TRAVEL=True IS_START_LOCATION_SELECT_BY_MAP=True EXIST_PLAYER_AFTER_LOGOUT=False ENABLE_DEFENSE_OTHER_GUILD_PLAYER=False +INVISIBLE_OTHER_GUILD_BASE_CAMP_AREA_FX=False COOP_PLAYER_MAX_NUM=4 REGION= USEAUTH=True diff --git a/README.md b/README.md index 1f825d57..4b352643 100644 --- a/README.md +++ b/README.md @@ -36,9 +36,9 @@ This container has also been tested and will work on both `x64` and `ARM64` base ## Sponsors -| Company | About | -|---------|-------| -|Indifferent Broccoli

indifferent broccoli \(\:\|\)

| Thank you to our sponsor indifferent broccoli. If you decide to rent a Palworld server, rather than host yourself, try indifferent broccoli's [Palword server hosting](https://indifferentbroccoli.com/palworld-server-hosting) 2-day free trial | +| Company | About | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Indifferent Broccoli

indifferent broccoli \(\:\|\)

| Thank you to our sponsor indifferent broccoli. If you decide to rent a Palworld server, rather than host yourself, try indifferent broccoli's [Palword server hosting](https://indifferentbroccoli.com/palworld-server-hosting) 2-day free trial | ### Massive shoutout to the following individual sponsors @@ -206,86 +206,86 @@ It is highly recommended you set the following environment values before startin * PGID | Variable | Info | Default Values | Allowed Values | Added in Version | -|--------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|-----| -| 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) | 0.1.0 | -| PLAYERS* | Max amount of players that are able to join the server | 16 | 1-32 | 0.1.0 | -| PORT* | UDP port that the server will expose | 8211 | 1024-65535 | 0.1.0 | -| PUID* | The uid of the user the server should run as | 1000 | !0 | 0.6.0 | -| PGID* | The gid of the group the server should run as | 1000 | !0 | 0.6.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 | 0.1.0 | -| COMMUNITY | Whether or not the server shows up in the community server browser (USE WITH SERVER_PASSWORD) | false | true/false | 0.1.0 | -| 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 | 0.1.0 | -| 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 | 0.1.0 | -| SERVER_NAME | A name for your server | | "string" | 0.1.0 | -| SERVER_DESCRIPTION | Your server Description | | "string" | 0.1.0 | -| SERVER_PASSWORD | Secure your community server with a password | | "string" | 0.1.0 | -| ADMIN_PASSWORD | Secure administration access in the server with a password | | "string" | 0.4.0 | -| 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 | 0.3.0 | -| RCON_ENABLED*** | Enable RCON for the Palworld server | true | true/false | 0.1.0 | -| RCON_PORT | RCON port to connect to | 25575 | 1024-65535 | 0.1.0 | -| REST_API_ENABLED | Enable REST API for the palworld server | false | true/false | 0.35.0 | -| REST_API_PORT | REST API port to connect to | 8212 | 1024-65535 | 0.35.0 | -| QUERY_PORT | Query port used to communicate with Steam servers | 27015 | 1024-65535 | 0.1.0 | -| ALLOW_CONNECT_PLATFORM | Specify if you are hosting a dedicated server for Steam or Xbox players | Steam | Steam/Xbox | 0.38.0 | -| BACKUP_CRON_EXPRESSION | Setting affects frequency of automatic backups. | 0 0 \* \* \* | Needs a Cron-Expression - See [Configuring Automatic Backups with Cron](#configuring-automatic-backups-with-cron) | 0.19.0 | -| BACKUP_ENABLED | Enables automatic backups | true | true/false | 0.19.0 | -| USE_BACKUP_SAVE_DATA | Enables native automatic backups | true | true/false | 0.35.0 | -| DELETE_OLD_BACKUPS | Delete backups after a certain number of days | false | true/false | 0.19.0 | -| OLD_BACKUP_DAYS | How many days to keep backups | 30 | any positive integer | 0.19.0 | -| AUTO_UPDATE_CRON_EXPRESSION | Setting affects frequency of automatic updates. | 0 \* \* \* \* | Needs a Cron-Expression - See [Configuring Automatic Backups with Cron](#configuring-automatic-backups-with-cron) | 0.20.0 | -| AUTO_UPDATE_ENABLED | Enables automatic updates | false | true/false | 0.20.0 | -| AUTO_UPDATE_WARN_MINUTES | How long to wait to update the server, after the player were informed. (This will be ignored, if no Players are connected) | 30 | Integer | 0.20.0 | -| AUTO_REBOOT_CRON_EXPRESSION | Setting affects frequency of automatic updates. | 0 0 \* \* \* | Needs a Cron-Expression - See [Configuring Automatic Backups with Cron](#configuring-automatic-reboots-with-cron) | 0.21.0 | -| AUTO_REBOOT_ENABLED | Enables automatic reboots | false | true/false | 0.21.0 | -| AUTO_REBOOT_WARN_MINUTES | How long to wait to reboot the server, after the player were informed. | 5 | Integer | 0.21.0 | -| AUTO_REBOOT_EVEN_IF_PLAYERS_ONLINE | Restart the Server even if there are players online. | false | true/false | 0.21.0 | -| TARGET_MANIFEST_ID | Locks game version to corespond with Manifest ID from Steam Download Depot. | | See [Manifest ID Table](#locking-specific-game-version) | 0.27.0 | -| INSTALL_BETA_INSIDER | Installs the latest Beta version of the Palworld dedicated server | false | true/false | 0.38.0 | -| DISCORD_WEBHOOK_URL | Discord webhook url found after creating a webhook on a discord server. | | `https://discord.com/api/webhooks/` | 0.22.0 | -| DISCORD_SUPPRESS_NOTIFICATIONS | Enables/Disables `@silent` messages for the server messages. | false | boolean | 0.34.0 | -| DISCORD_CONNECT_TIMEOUT | Discord command initial connection timeout | 30 | !0 | 0.22.0 | -| DISCORD_MAX_TIMEOUT | Discord total hook timeout | 30 | !0 | 0.22.0 | -| DISCORD_PRE_UPDATE_BOOT_MESSAGE | Discord message sent when server begins updating | Server is updating... | "string" | 0.31.0 | -| DISCORD_PRE_UPDATE_BOOT_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | -| DISCORD_PRE_UPDATE_BOOT_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | -| DISCORD_POST_UPDATE_BOOT_MESSAGE | Discord message sent when server completes updating | Server update complete! | "string" | 0.31.0 | -| DISCORD_POST_UPDATE_BOOT_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | -| DISCORD_POST_UPDATE_BOOT_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | -| DISCORD_PRE_START_MESSAGE | Discord message sent when server begins to start | Server has been started! | "string" | 0.31.0 | -| DISCORD_PRE_START_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | -| DISCORD_PRE_START_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | -| DISCORD_PRE_SHUTDOWN_MESSAGE | Discord message sent when server begins to shutdown | Server is shutting down... | "string" | 0.31.0 | -| DISCORD_PRE_SHUTDOWN_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | -| DISCORD_PRE_SHUTDOWN_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | -| DISCORD_POST_SHUTDOWN_MESSAGE | Discord message sent when server has stopped | Server is stopped! | "string" | 0.31.0 | -| DISCORD_POST_SHUTDOWN_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | -| DISCORD_POST_SHUTDOWN_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | -| DISCORD_PLAYER_JOIN_MESSAGE | Discord message sent when player joins the server | `player_name` has joined Palworld! | "string" | 0.31.0 | -| DISCORD_PLAYER_JOIN_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | -| DISCORD_PLAYER_JOIN_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | -| DISCORD_PLAYER_LEAVE_MESSAGE | Discord message sent when player leaves the server | `player_name` has left Palworld. | "string" | 0.31.0 | -| DISCORD_PLAYER_LEAVE_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | -| DISCORD_PLAYER_LEAVE_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | -| DISCORD_PRE_BACKUP_MESSAGE | Discord message when starting to create a backup | Creating backup... | "string" | 0.31.0 | -| DISCORD_PRE_BACKUP_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | -| DISCORD_PRE_BACKUP_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | -| DISCORD_POST_BACKUP_MESSAGE | Discord message when a backup has been made | Backup created at `file_path` | "string" | 0.31.0 | -| DISCORD_POST_BACKUP_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | -| DISCORD_POST_BACKUP_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | -| DISCORD_PRE_BACKUP_DELETE_MESSAGE | Discord message when starting to remove older backups | Removing backups older than `old_backup_days` days | "string" | 0.31.0 | -| DISCORD_PRE_BACKUP_DELETE_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | -| DISCORD_PRE_BACKUP_DELETE_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | -| DISCORD_POST_BACKUP_DELETE_MESSAGE | Discord message when successfully removed older backups | Removed backups older than `old_backup_days` days | "string" | 0.31.0 | -| DISCORD_POST_BACKUP_DELETE_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | -| DISCORD_POST_BACKUP_DELETE_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | -| DISCORD_ERR_BACKUP_DELETE_MESSAGE | Discord message when there has been an error removing older backups | Unable to delete old backups, OLD_BACKUP_DAYS is not an integer. OLD_BACKUP_DAYS=`old_backup_days` | "string" | 0.31.0 | -| DISCORD_ERR_BACKUP_DELETE_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | -| DISCORD_ERR_BACKUP_DELETE_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | -| DISABLE_GENERATE_SETTINGS | Whether to automatically generate the PalWorldSettings.ini | false | true/false | 0.24.0 | -| DISABLE_GENERATE_ENGINE | Whether to automatically generate the Engine.ini | true | true/false | 0.30.0 | -| ENABLE_PLAYER_LOGGING | Enables Logging and announcing when players join and leave | true | true/false | 0.31.0 | -| PLAYER_LOGGING_POLL_PERIOD | Polling period (in seconds) to check for players who have joined or left | 5 | !0 | 0.31.0 | -| ARM_COMPATIBILITY_MODE | Switches the compatibility layer from Box86 to QEMU when executing steamcmd for server updates. This setting is only applicable for ARM64 hosts. | false | true/false | 0.30.0 | +|--------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|------------------| +| 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) | 0.1.0 | +| PLAYERS* | Max amount of players that are able to join the server | 16 | 1-32 | 0.1.0 | +| PORT* | UDP port that the server will expose | 8211 | 1024-65535 | 0.1.0 | +| PUID* | The uid of the user the server should run as | 1000 | !0 | 0.6.0 | +| PGID* | The gid of the group the server should run as | 1000 | !0 | 0.6.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 | 0.1.0 | +| COMMUNITY | Whether or not the server shows up in the community server browser (USE WITH SERVER_PASSWORD) | false | true/false | 0.1.0 | +| 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 | 0.1.0 | +| 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 | 0.1.0 | +| SERVER_NAME | A name for your server | | "string" | 0.1.0 | +| SERVER_DESCRIPTION | Your server Description | | "string" | 0.1.0 | +| SERVER_PASSWORD | Secure your community server with a password | | "string" | 0.1.0 | +| ADMIN_PASSWORD | Secure administration access in the server with a password | | "string" | 0.4.0 | +| 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 | 0.3.0 | +| RCON_ENABLED*** | Enable RCON for the Palworld server | true | true/false | 0.1.0 | +| RCON_PORT | RCON port to connect to | 25575 | 1024-65535 | 0.1.0 | +| REST_API_ENABLED | Enable REST API for the palworld server | false | true/false | 0.35.0 | +| REST_API_PORT | REST API port to connect to | 8212 | 1024-65535 | 0.35.0 | +| QUERY_PORT | Query port used to communicate with Steam servers | 27015 | 1024-65535 | 0.1.0 | +| ALLOW_CONNECT_PLATFORM | Specify if you are hosting a dedicated server for Steam or Xbox players | Steam | Steam/Xbox | 0.38.0 | +| BACKUP_CRON_EXPRESSION | Setting affects frequency of automatic backups. | 0 0 \* \* \* | Needs a Cron-Expression - See [Configuring Automatic Backups with Cron](#configuring-automatic-backups-with-cron) | 0.19.0 | +| BACKUP_ENABLED | Enables automatic backups | true | true/false | 0.19.0 | +| USE_BACKUP_SAVE_DATA | Enables native automatic backups | true | true/false | 0.35.0 | +| DELETE_OLD_BACKUPS | Delete backups after a certain number of days | false | true/false | 0.19.0 | +| OLD_BACKUP_DAYS | How many days to keep backups | 30 | any positive integer | 0.19.0 | +| AUTO_UPDATE_CRON_EXPRESSION | Setting affects frequency of automatic updates. | 0 \* \* \* \* | Needs a Cron-Expression - See [Configuring Automatic Backups with Cron](#configuring-automatic-backups-with-cron) | 0.20.0 | +| AUTO_UPDATE_ENABLED | Enables automatic updates | false | true/false | 0.20.0 | +| AUTO_UPDATE_WARN_MINUTES | How long to wait to update the server, after the player were informed. (This will be ignored, if no Players are connected) | 30 | Integer | 0.20.0 | +| AUTO_REBOOT_CRON_EXPRESSION | Setting affects frequency of automatic updates. | 0 0 \* \* \* | Needs a Cron-Expression - See [Configuring Automatic Backups with Cron](#configuring-automatic-reboots-with-cron) | 0.21.0 | +| AUTO_REBOOT_ENABLED | Enables automatic reboots | false | true/false | 0.21.0 | +| AUTO_REBOOT_WARN_MINUTES | How long to wait to reboot the server, after the player were informed. | 5 | Integer | 0.21.0 | +| AUTO_REBOOT_EVEN_IF_PLAYERS_ONLINE | Restart the Server even if there are players online. | false | true/false | 0.21.0 | +| TARGET_MANIFEST_ID | Locks game version to corespond with Manifest ID from Steam Download Depot. | | See [Manifest ID Table](#locking-specific-game-version) | 0.27.0 | +| INSTALL_BETA_INSIDER | Installs the latest Beta version of the Palworld dedicated server | false | true/false | 0.38.0 | +| DISCORD_WEBHOOK_URL | Discord webhook url found after creating a webhook on a discord server. | | `https://discord.com/api/webhooks/` | 0.22.0 | +| DISCORD_SUPPRESS_NOTIFICATIONS | Enables/Disables `@silent` messages for the server messages. | false | boolean | 0.34.0 | +| DISCORD_CONNECT_TIMEOUT | Discord command initial connection timeout | 30 | !0 | 0.22.0 | +| DISCORD_MAX_TIMEOUT | Discord total hook timeout | 30 | !0 | 0.22.0 | +| DISCORD_PRE_UPDATE_BOOT_MESSAGE | Discord message sent when server begins updating | Server is updating... | "string" | 0.31.0 | +| DISCORD_PRE_UPDATE_BOOT_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | +| DISCORD_PRE_UPDATE_BOOT_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | +| DISCORD_POST_UPDATE_BOOT_MESSAGE | Discord message sent when server completes updating | Server update complete! | "string" | 0.31.0 | +| DISCORD_POST_UPDATE_BOOT_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | +| DISCORD_POST_UPDATE_BOOT_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | +| DISCORD_PRE_START_MESSAGE | Discord message sent when server begins to start | Server has been started! | "string" | 0.31.0 | +| DISCORD_PRE_START_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | +| DISCORD_PRE_START_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | +| DISCORD_PRE_SHUTDOWN_MESSAGE | Discord message sent when server begins to shutdown | Server is shutting down... | "string" | 0.31.0 | +| DISCORD_PRE_SHUTDOWN_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | +| DISCORD_PRE_SHUTDOWN_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | +| DISCORD_POST_SHUTDOWN_MESSAGE | Discord message sent when server has stopped | Server is stopped! | "string" | 0.31.0 | +| DISCORD_POST_SHUTDOWN_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | +| DISCORD_POST_SHUTDOWN_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | +| DISCORD_PLAYER_JOIN_MESSAGE | Discord message sent when player joins the server | `player_name` has joined Palworld! | "string" | 0.31.0 | +| DISCORD_PLAYER_JOIN_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | +| DISCORD_PLAYER_JOIN_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | +| DISCORD_PLAYER_LEAVE_MESSAGE | Discord message sent when player leaves the server | `player_name` has left Palworld. | "string" | 0.31.0 | +| DISCORD_PLAYER_LEAVE_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | +| DISCORD_PLAYER_LEAVE_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | +| DISCORD_PRE_BACKUP_MESSAGE | Discord message when starting to create a backup | Creating backup... | "string" | 0.31.0 | +| DISCORD_PRE_BACKUP_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | +| DISCORD_PRE_BACKUP_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | +| DISCORD_POST_BACKUP_MESSAGE | Discord message when a backup has been made | Backup created at `file_path` | "string" | 0.31.0 | +| DISCORD_POST_BACKUP_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | +| DISCORD_POST_BACKUP_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | +| DISCORD_PRE_BACKUP_DELETE_MESSAGE | Discord message when starting to remove older backups | Removing backups older than `old_backup_days` days | "string" | 0.31.0 | +| DISCORD_PRE_BACKUP_DELETE_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | +| DISCORD_PRE_BACKUP_DELETE_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | +| DISCORD_POST_BACKUP_DELETE_MESSAGE | Discord message when successfully removed older backups | Removed backups older than `old_backup_days` days | "string" | 0.31.0 | +| DISCORD_POST_BACKUP_DELETE_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | +| DISCORD_POST_BACKUP_DELETE_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | +| DISCORD_ERR_BACKUP_DELETE_MESSAGE | Discord message when there has been an error removing older backups | Unable to delete old backups, OLD_BACKUP_DAYS is not an integer. OLD_BACKUP_DAYS=`old_backup_days` | "string" | 0.31.0 | +| DISCORD_ERR_BACKUP_DELETE_MESSAGE_ENABLED | If the Discord message is enabled for this message | true | boolean | 0.31.0 | +| DISCORD_ERR_BACKUP_DELETE_MESSAGE_URL | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL) | | "string" | 0.31.0 | +| DISABLE_GENERATE_SETTINGS | Whether to automatically generate the PalWorldSettings.ini | false | true/false | 0.24.0 | +| DISABLE_GENERATE_ENGINE | Whether to automatically generate the Engine.ini | true | true/false | 0.30.0 | +| ENABLE_PLAYER_LOGGING | Enables Logging and announcing when players join and leave | true | true/false | 0.31.0 | +| PLAYER_LOGGING_POLL_PERIOD | Polling period (in seconds) to check for players who have joined or left | 5 | !0 | 0.31.0 | +| ARM_COMPATIBILITY_MODE | Switches the compatibility layer from Box86 to QEMU when executing steamcmd for server updates. This setting is only applicable for ARM64 hosts. | false | true/false | 0.30.0 | *highly recommended to set @@ -397,19 +397,19 @@ rest-cli allows you to call REST APIs directly without exposing ports outside th ### List of REST APIs -| API | Info | -|----------------------------------|-----------------------------------------------------| -| info | Get the server information. | -| players | Get player list. | -| settings | Get the server settings. | -| metrics | Get the server metrics. | -| announce | Announce message. | -| kick {SteamID} | Kick player. | -| ban {SteamID} | Ban player. | -| unban {SteamID} | Unban player. | -| save | Save the world. | -| shutdown {Seconds} {MessageText} | Shutdown the server | -| stop | Force stop the server. | +| API | Info | +|----------------------------------|-----------------------------| +| info | Get the server information. | +| players | Get player list. | +| settings | Get the server settings. | +| metrics | Get the server metrics. | +| announce | Announce message. | +| kick {SteamID} | Kick player. | +| ban {SteamID} | Ban player. | +| unban {SteamID} | Unban player. | +| save | Save the world. | +| shutdown {Seconds} {MessageText} | Shutdown the server | +| stop | Force stop the server. | For an official documents go to: [https://tech.palworldgame.com/category/rest-api](https://tech.palworldgame.com/category/rest-api) @@ -594,8 +594,10 @@ For example: | AUTO_RESET_GUILD_NO_ONLINE_PLAYERS | Automatically reset guild when no players are online | False | Bool | | AUTO_RESET_GUILD_TIME_NO_ONLINE_PLAYERS | Time to automatically reset guild when no players are online | 72.000000 | Float | | GUILD_PLAYER_MAX_NUM | Max player of Guild | 20 | Integer | +| BASE_CAMP_MAX_NUM_IN_GUILD | Max bases of Guild | 4 | Integer | | PAL_EGG_DEFAULT_HATCHING_TIME | Time(h) to incubate massive egg | 72.000000 | Float | | WORK_SPEED_RATE | Work speed muliplier | 1.000000 | Float | +| AUTO_SAVE_SPAN | Time between autosaves (minutes) | 30.000000 | Float | | IS_MULTIPLAY | Enable multiplayer | False | Boolean | | IS_PVP | Enable PVP | False | Boolean | | CAN_PICKUP_OTHER_GUILD_DEATH_PENALTY_DROP | Allow players from other guilds to pick up death penalty items | False | Boolean | @@ -604,6 +606,7 @@ For example: | IS_START_LOCATION_SELECT_BY_MAP | Enable selecting of start location | True | Boolean | | EXIST_PLAYER_AFTER_LOGOUT | Toggle for deleting players when they log off | False | Boolean | | ENABLE_DEFENSE_OTHER_GUILD_PLAYER | Allows defense against other guild players | False | Boolean | +| INVISIBLE_OTHER_GUILD_BASE_CAMP_AREA_FX | unknown | False | Boolean | | COOP_PLAYER_MAX_NUM | Maximum number of players in a guild | 4 | Integer | | REGION | Region | | String | | USEAUTH | Use authentication | True | Boolean | diff --git a/docusaurus/docs/getting-started/configuration/game-settings.md b/docusaurus/docs/getting-started/configuration/game-settings.md index 5d33f2b2..25d1afb4 100644 --- a/docusaurus/docs/getting-started/configuration/game-settings.md +++ b/docusaurus/docs/getting-started/configuration/game-settings.md @@ -72,8 +72,10 @@ For example: | AUTO_RESET_GUILD_NO_ONLINE_PLAYERS | Automatically reset guild when no players are online | False | Bool | | AUTO_RESET_GUILD_TIME_NO_ONLINE_PLAYERS | Time to automatically reset guild when no players are online | 72.000000 | Float | | GUILD_PLAYER_MAX_NUM | Max player of Guild | 20 | Integer | +| BASE_CAMP_MAX_NUM_IN_GUILD | Max bases of Guild | 4 | Integer | | PAL_EGG_DEFAULT_HATCHING_TIME | Time(h) to incubate massive egg | 72.000000 | Float | | WORK_SPEED_RATE | Work speed muliplier | 1.000000 | Float | +| AUTO_SAVE_SPAN | Time between autosaves (minutes) | 30.000000 | Float | | IS_MULTIPLAY | Enable multiplayer | False | Boolean | | IS_PVP | Enable PVP | False | Boolean | | CAN_PICKUP_OTHER_GUILD_DEATH_PENALTY_DROP | Allow players from other guilds to pick up death penalty items | False | Boolean | @@ -82,6 +84,7 @@ For example: | IS_START_LOCATION_SELECT_BY_MAP | Enable selecting of start location | True | Boolean | | EXIST_PLAYER_AFTER_LOGOUT | Toggle for deleting players when they log off | False | Boolean | | ENABLE_DEFENSE_OTHER_GUILD_PLAYER | Allows defense against other guild players | False | Boolean | +| INVISIBLE_OTHER_GUILD_BASE_CAMP_AREA_FX | unknown | False | Boolean | | COOP_PLAYER_MAX_NUM | Maximum number of players in a guild | 4 | Integer | | REGION | Region | | String | | USEAUTH | Use authentication | True | Boolean | diff --git a/scripts/compile-settings.sh b/scripts/compile-settings.sh index 449dd8a6..107c284c 100755 --- a/scripts/compile-settings.sh +++ b/scripts/compile-settings.sh @@ -60,8 +60,10 @@ export DROP_ITEM_ALIVE_MAX_HOURS=${DROP_ITEM_ALIVE_MAX_HOURS:-1.000000} export AUTO_RESET_GUILD_NO_ONLINE_PLAYERS=${AUTO_RESET_GUILD_NO_ONLINE_PLAYERS:-False} export AUTO_RESET_GUILD_TIME_NO_ONLINE_PLAYERS=${AUTO_RESET_GUILD_TIME_NO_ONLINE_PLAYERS:-72.000000} export GUILD_PLAYER_MAX_NUM=${GUILD_PLAYER_MAX_NUM:-20} +export BASE_CAMP_MAX_NUM_IN_GUILD=${BASE_CAMP_MAX_NUM_IN_GUILD:-4} export PAL_EGG_DEFAULT_HATCHING_TIME=${PAL_EGG_DEFAULT_HATCHING_TIME:-72.000000} export WORK_SPEED_RATE=${WORK_SPEED_RATE:-1.000000} +export AUTO_SAVE_SPAN=${AUTO_SAVE_SPAN:-30.000000} export IS_MULTIPLAY=${IS_MULTIPLAY:-False} export IS_PVP=${IS_PVP:-False} export CAN_PICKUP_OTHER_GUILD_DEATH_PENALTY_DROP=${CAN_PICKUP_OTHER_GUILD_DEATH_PENALTY_DROP:-False} @@ -70,6 +72,7 @@ export ENABLE_FAST_TRAVEL=${ENABLE_FAST_TRAVEL:-True} export IS_START_LOCATION_SELECT_BY_MAP=${IS_START_LOCATION_SELECT_BY_MAP:-True} export EXIST_PLAYER_AFTER_LOGOUT=${EXIST_PLAYER_AFTER_LOGOUT:-False} export ENABLE_DEFENSE_OTHER_GUILD_PLAYER=${ENABLE_DEFENSE_OTHER_GUILD_PLAYER:-False} +export INVISIBLE_OTHER_GUILD_BASE_CAMP_AREA_FX=${INVISIBLE_OTHER_GUILD_BASE_CAMP_AREA_FX:-False} export COOP_PLAYER_MAX_NUM=${COOP_PLAYER_MAX_NUM:-4} export SERVER_PLAYER_MAX_NUM=${PLAYERS:-32} export SERVER_NAME=\"${SERVER_NAME:-"Default Palworld Server"}\" @@ -131,8 +134,10 @@ DROP_ITEM_ALIVE_MAX_HOURS = $DROP_ITEM_ALIVE_MAX_HOURS AUTO_RESET_GUILD_NO_ONLINE_PLAYERS = $AUTO_RESET_GUILD_NO_ONLINE_PLAYERS AUTO_RESET_GUILD_TIME_NO_ONLINE_PLAYERS = $AUTO_RESET_GUILD_TIME_NO_ONLINE_PLAYERS GUILD_PLAYER_MAX_NUM = $GUILD_PLAYER_MAX_NUM +BASE_CAMP_MAX_NUM_IN_GUILD = $BASE_CAMP_MAX_NUM_IN_GUILD PAL_EGG_DEFAULT_HATCHING_TIME = $PAL_EGG_DEFAULT_HATCHING_TIME WORK_SPEED_RATE = $WORK_SPEED_RATE +AUTO_SAVE_SPAN = $AUTO_SAVE_SPAN IS_MULTIPLAY = $IS_MULTIPLAY IS_PVP = $IS_PVP CAN_PICKUP_OTHER_GUILD_DEATH_PENALTY_DROP = $CAN_PICKUP_OTHER_GUILD_DEATH_PENALTY_DROP @@ -141,6 +146,7 @@ ENABLE_FAST_TRAVEL = $ENABLE_FAST_TRAVEL IS_START_LOCATION_SELECT_BY_MAP = $IS_START_LOCATION_SELECT_BY_MAP EXIST_PLAYER_AFTER_LOGOUT = $EXIST_PLAYER_AFTER_LOGOUT ENABLE_DEFENSE_OTHER_GUILD_PLAYER = $ENABLE_DEFENSE_OTHER_GUILD_PLAYER +INVISIBLE_OTHER_GUILD_BASE_CAMP_AREA_FX = $INVISIBLE_OTHER_GUILD_BASE_CAMP_AREA_FX COOP_PLAYER_MAX_NUM = $COOP_PLAYER_MAX_NUM SERVER_PLAYER_MAX_NUM = $SERVER_PLAYER_MAX_NUM SERVER_NAME = $SERVER_NAME diff --git a/scripts/files/PalWorldSettings.ini.template b/scripts/files/PalWorldSettings.ini.template index 15c6956b..0cf8e44a 100644 --- a/scripts/files/PalWorldSettings.ini.template +++ b/scripts/files/PalWorldSettings.ini.template @@ -38,8 +38,10 @@ DropItemAliveMaxHours=$DROP_ITEM_ALIVE_MAX_HOURS, bAutoResetGuildNoOnlinePlayers=$AUTO_RESET_GUILD_NO_ONLINE_PLAYERS, AutoResetGuildTimeNoOnlinePlayers=$AUTO_RESET_GUILD_TIME_NO_ONLINE_PLAYERS, GuildPlayerMaxNum=$GUILD_PLAYER_MAX_NUM, +BaseCampMaxNumInGuild=$BASE_CAMP_MAX_NUM_IN_GUILD, PalEggDefaultHatchingTime=$PAL_EGG_DEFAULT_HATCHING_TIME, WorkSpeedRate=$WORK_SPEED_RATE, +AutoSaveSpan=$AUTO_SAVE_SPAN, bIsMultiplay=$IS_MULTIPLAY, bIsPvP=$IS_PVP, bCanPickupOtherGuildDeathPenaltyDrop=$CAN_PICKUP_OTHER_GUILD_DEATH_PENALTY_DROP, @@ -48,6 +50,7 @@ bEnableFastTravel=$ENABLE_FAST_TRAVEL, bIsStartLocationSelectByMap=$IS_START_LOCATION_SELECT_BY_MAP, bExistPlayerAfterLogout=$EXIST_PLAYER_AFTER_LOGOUT, bEnableDefenseOtherGuildPlayer=$ENABLE_DEFENSE_OTHER_GUILD_PLAYER, +bInvisibleOtherGuildBaseCampAreaFX=$INVISIBLE_OTHER_GUILD_BASE_CAMP_AREA_FX, CoopPlayerMaxNum=$COOP_PLAYER_MAX_NUM, ServerPlayerMaxNum=$SERVER_PLAYER_MAX_NUM, ServerName=$SERVER_NAME,