From c54396a87b8efa0ce742badf9d739d00dbadb055 Mon Sep 17 00:00:00 2001 From: strawbang Date: Fri, 1 Mar 2024 14:36:38 +0100 Subject: [PATCH 1/4] docs: add french language to documentation --- README.md | 283 ++++++++++++------------ docs/fr/README.md | 551 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 693 insertions(+), 141 deletions(-) create mode 100644 docs/fr/README.md diff --git a/README.md b/README.md index 62a68a110..e6adb585d 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ [Chat with the community on Discord](https://discord.gg/UxBxStPAAE) -[English](/README.md) | [한국어](/docs/kr/README.md) | [简体中文](/docs/zh-CN/README.md) +[English](/README.md) | [한국어](/docs/kr/README.md) | [简体中文](/docs/zh-CN/README.md) | [French](/docs/fr/README.md) > [!TIP] > Unsure how to get started? Check out [this guide I wrote!](https://tice.tips/containerization/palworld-server-docker/) @@ -27,9 +27,9 @@ This is a Docker container to help you get started with hosting your own This Docker container has been tested and will work on the following OS: -* Linux (Ubuntu/Debian) -* Windows 10,11 -* MacOS (including Apple Silicon M1/M2/M3). +- Linux (Ubuntu/Debian) +- Windows 10,11 +- MacOS (including Apple Silicon M1/M2/M3). This container has also been tested and will work on both `x64` and `ARM64` based CPU architecture. @@ -53,7 +53,7 @@ Massive shoutout to the following sponsors! ## Server Requirements | Resource | Minimum | Recommended | -|----------|---------|------------------------------------------| +| -------- | ------- | ---------------------------------------- | | CPU | 4 cores | 4+ cores | | RAM | 16GB | Recommend over 32GB for stable operation | | Storage | 8GB | 20GB | @@ -68,30 +68,30 @@ This repository includes an example [docker-compose.yml](/docker-compose.yml) fi ```yml services: - palworld: - image: thijsvanloef/palworld-server-docker:latest - restart: unless-stopped - container_name: palworld-server - stop_grace_period: 30s # Set to however long you are willing to wait for the container to gracefully stop - ports: - - 8211:8211/udp - - 27015:27015/udp - environment: - PUID: 1000 - PGID: 1000 - PORT: 8211 # Optional but recommended - PLAYERS: 16 # Optional but recommended - SERVER_PASSWORD: "worldofpals" # Optional but recommended - MULTITHREADING: true - RCON_ENABLED: true - RCON_PORT: 25575 - TZ: "UTC" - ADMIN_PASSWORD: "adminPasswordHere" - COMMUNITY: false # Enable this if you want your server to show up in the community servers tab, USE WITH SERVER_PASSWORD! - SERVER_NAME: "palworld-server-docker by Thijs van Loef" - SERVER_DESCRIPTION: "palworld-server-docker by Thijs van Loef" - volumes: - - ./palworld:/palworld/ + palworld: + image: thijsvanloef/palworld-server-docker:latest + restart: unless-stopped + container_name: palworld-server + stop_grace_period: 30s # Set to however long you are willing to wait for the container to gracefully stop + ports: + - 8211:8211/udp + - 27015:27015/udp + environment: + PUID: 1000 + PGID: 1000 + PORT: 8211 # Optional but recommended + PLAYERS: 16 # Optional but recommended + SERVER_PASSWORD: 'worldofpals' # Optional but recommended + MULTITHREADING: true + RCON_ENABLED: true + RCON_PORT: 25575 + TZ: 'UTC' + ADMIN_PASSWORD: 'adminPasswordHere' + COMMUNITY: false # Enable this if you want your server to show up in the community servers tab, USE WITH SERVER_PASSWORD! + SERVER_NAME: 'palworld-server-docker by Thijs van Loef' + SERVER_DESCRIPTION: 'palworld-server-docker by Thijs van Loef' + volumes: + - ./palworld:/palworld/ ``` As an alternative, you can copy the [.env.example](.env.example) file to a new file called **.env** file. @@ -100,18 +100,18 @@ values. Modify your [docker-compose.yml](docker-compose.yml) to this: ```yml services: - palworld: - image: thijsvanloef/palworld-server-docker:latest - restart: unless-stopped - container_name: palworld-server - stop_grace_period: 30s # Set to however long you are willing to wait for the container to gracefully stop - ports: - - 8211:8211/udp - - 27015:27015/udp - env_file: - - .env - volumes: - - ./palworld:/palworld/ + palworld: + image: thijsvanloef/palworld-server-docker:latest + restart: unless-stopped + container_name: palworld-server + stop_grace_period: 30s # Set to however long you are willing to wait for the container to gracefully stop + ports: + - 8211:8211/udp + - 27015:27015/udp + env_file: + - .env + volumes: + - ./palworld:/palworld/ ``` ### Docker Run @@ -180,8 +180,8 @@ You must set user to `NUMBERICAL_UID:NUMBERICAL_GID` Below we assume your UID is 1000 and your GID is 1001 -* In docker run add `--user 1000:1001 \` above the last line. -* In docker compose add `user: 1000:1001` above ports. +- In docker run add `--user 1000:1001 \` above the last line. +- In docker compose add `user: 1000:1001` above ports. If you wish to run it with a different UID/GID than your own you will need to change the ownership of the directory that is being bind: `chown UID:GID palworld/` @@ -196,19 +196,19 @@ The official helm chart can be found in a seperate repository, [palworld-server- You can use the following values to change the settings of the server on boot. It is highly recommended you set the following environment values before starting the server: -* PLAYERS -* PORT -* PUID -* PGID +- PLAYERS +- PORT +- PUID +- PGID | 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 | +| 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 | @@ -216,8 +216,8 @@ 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_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 | | 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) | @@ -226,12 +226,12 @@ It is highly recommended you set the following environment values before startin | OLD_BACKUP_DAYS | How many days to keep backups | 30 | any positive integer | | 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) | | AUTO_UPDATE_ENABLED | Enables automatic updates | false | true/false | -| 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 | +| 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 | | 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) | | AUTO_REBOOT_ENABLED | Enables automatic reboots | false | true/false | -| AUTO_REBOOT_WARN_MINUTES | How long to wait to reboot the server, after the player were informed. | 5 | Integer | +| AUTO_REBOOT_WARN_MINUTES | How long to wait to reboot the server, after the player were informed. | 5 | Integer | | AUTO_REBOOT_EVEN_IF_PLAYERS_ONLINE | Restart the Server even if there are players online. | false | true/false | -| TARGET_MANIFEST_ID | Locks game version to corespond with Manifest ID from Steam Download Depot. | | See [Manifest ID Table](#locking-specific-game-version) | +| TARGET_MANIFEST_ID | Locks game version to corespond with Manifest ID from Steam Download Depot. | | See [Manifest ID Table](#locking-specific-game-version) | | DISCORD_WEBHOOK_URL | Discord webhook url found after creating a webhook on a discord server | | `https://discord.com/api/webhooks/` | | DISCORD_CONNECT_TIMEOUT | Discord command initial connection timeout | 30 | !0 | | DISCORD_MAX_TIMEOUT | Discord total hook timeout | 30 | !0 | @@ -241,20 +241,20 @@ It is highly recommended you set the following environment values before startin | DISCORD_PRE_SHUTDOWN_MESSAGE | Discord message sent when server begins to shutdown | Server is shutting down... | "string" | | DISCORD_POST_SHUTDOWN_MESSAGE | Discord message sent when server has stopped | Server is stopped! | "string" | | DISABLE_GENERATE_SETTINGS | Whether to automatically generate the PalWorldSettings.ini | false | true/false | -| DISABLE_GENERATE_ENGINE | Whether to automatically generate the Engine.ini | true | true/false | -| ENABLE_PLAYER_LOGGING | Enables Logging and announcing when players join and leave | true | true/false | -| PLAYER_LOGGING_POLL_PERIOD | Polling period (in seconds) to check for players who have joined or left | 5 | !0 | +| DISABLE_GENERATE_ENGINE | Whether to automatically generate the Engine.ini | true | true/false | +| ENABLE_PLAYER_LOGGING | Enables Logging and announcing when players join and leave | true | true/false | +| PLAYER_LOGGING_POLL_PERIOD | Polling period (in seconds) to check for players who have joined or left | 5 | !0 | -*highly recommended to set +\*highly recommended to set -** Make sure you know what you are doing when running this option enabled +\*\* Make sure you know what you are doing when running this option enabled -*** Required for docker stop to save and gracefully close the server +\*\*\* Required for docker stop to save and gracefully close the server ### Game Ports | Port | Info | -|-------|------------------| +| ----- | ---------------- | | 8211 | Game Port (UDP) | | 27015 | Query Port (UDP) | | 25575 | RCON Port (TCP) | @@ -279,7 +279,7 @@ This will open a CLI that uses RCON to write commands to the Palworld Server. ### List of server commands | Command | Info | -|----------------------------------|-----------------------------------------------------| +| -------------------------------- | --------------------------------------------------- | | Shutdown {Seconds} {MessageText} | The server is shut down after the number of Seconds | | DoExit | Force stop the server. | | Broadcast | Send message to all player in the server | @@ -314,6 +314,7 @@ docker exec -it palworld-server restore ``` The `RCON_ENABLED` environment variable must be set to `true` to use this command. + > [!IMPORTANT] > If docker restart is not set to policy `always` or `unless-stopped` then the server will shutdown and will need to be > manually restarted. @@ -366,8 +367,8 @@ Example Usage: If BACKUP_CRON_EXPRESSION to `0 2 * * *`, the backup script will To be able to use automatic Updates with this Server the following environment variables **have** to be set to `true`: -* RCON_ENABLED -* UPDATE_ON_BOOT +- RCON_ENABLED +- UPDATE_ON_BOOT > [!IMPORTANT] > @@ -423,72 +424,72 @@ timezone set with TZ Converting server settings to environment variables follow the same principles (with some exceptions): -* all capital letters -* split words by inserting an underscore -* remove the single letter if the setting starts with one (like 'b') +- all capital letters +- split words by inserting an underscore +- remove the single letter if the setting starts with one (like 'b') For example: -* Difficulty -> DIFFICULTY -* PalSpawnNumRate -> PAL_SPAWN_NUM_RATE -* bIsPvP -> IS_PVP - -| Variable | Description | Default Value | Allowed Value | -|-------------------------------------------|----------------------------------------------------------------|----------------------------------------------------------------------------------------------|----------------------------------------| -| DIFFICULTY | Game Difficulty | None | `None`,`Normal`,`Difficult` | -| DAYTIME_SPEEDRATE | Day time speed - Larger number means shorter days | 1.000000 | Float | -| NIGHTTIME_SPEEDRATE | Night time speed - Larger number means shorter nights | 1.000000 | Float | -| EXP_RATE | EXP earn rate | 1.000000 | Float | -| PAL_CAPTURE_RATE | Pal capture rate | 1.000000 | Float | -| PAL_SPAWN_NUM_RATE | Pal appearance rate | 1.000000 | Float | -| PAL_DAMAGE_RATE_ATTACK | Damage from pals multipiler | 1.000000 | Float | -| PAL_DAMAGE_RATE_DEFENSE | Damage to pals multipiler | 1.000000 | Float | -| PLAYER_DAMAGE_RATE_ATTACK | Damage from player multipiler | 1.000000 | Float | -| PLAYER_DAMAGE_RATE_DEFENSE | Damage to player multipiler | 1.000000 | Float | -| PLAYER_STOMACH_DECREASE_RATE | Player hunger depletion rate | 1.000000 | Float | -| PLAYER_STAMINA_DECREASE_RATE | Player stamina reduction rate | 1.000000 | Float | -| PLAYER_AUTO_HP_REGEN_RATE | Player auto HP regeneration rate | 1.000000 | Float | -| PLAYER_AUTO_HP_REGEN_RATE_IN_SLEEP | Player sleep HP regeneration rate | 1.000000 | Float | -| PAL_STOMACH_DECREASE_RATE | Pal hunger depletion rate | 1.000000 | Float | -| PAL_STAMINA_DECREASE_RATE | Pal stamina reduction rate | 1.000000 | Float | -| PAL_AUTO_HP_REGEN_RATE | Pal auto HP regeneration rate | 1.000000 | Float | -| PAL_AUTO_HP_REGEN_RATE_IN_SLEEP | Pal sleep health regeneration rate (in Palbox) | 1.000000 | Float | -| BUILD_OBJECT_DAMAGE_RATE | Damage to structure multipiler | 1.000000 | Float | -| BUILD_OBJECT_DETERIORATION_DAMAGE_RATE | Structure determination rate | 1.000000 | Float | -| COLLECTION_DROP_RATE | Getherable items multipiler | 1.000000 | Float | -| COLLECTION_OBJECT_HP_RATE | Getherable objects HP multipiler | 1.000000 | Float | -| COLLECTION_OBJECT_RESPAWN_SPEED_RATE | Getherable objects respawn interval - The smaller the number, the faster the regeneration | 1.000000 | Float | -| ENEMY_DROP_ITEM_RATE | Dropped Items Multipiler | 1.000000 | Float | -| DEATH_PENALTY | Death Penalty
None: No death penalty
Item: Drops items other than equipment
ItemAndEquipment: Drops all items
All: Drops all PALs and all items. | All | `None`,`Item`,`ItemAndEquipment`,`All` | -| ENABLE_PLAYER_TO_PLAYER_DAMAGE | Allows players to cause damage to players | False | Boolean | -| ENABLE_FRIENDLY_FIRE | Allow friendly fire | False | Boolean | -| ENABLE_INVADER_ENEMY | Enable invaders | True | Boolean | -| ACTIVE_UNKO | Enable UNKO (?) | False | Boolean | -| ENABLE_AIM_ASSIST_PAD | Enable controller aim assist | True | Boolean | -| ENABLE_AIM_ASSIST_KEYBOARD | Enable Keyboard aim assist | False | Boolean | -| DROP_ITEM_MAX_NUM | Maximum number of drops in the world | 3000 | Integer | -| DROP_ITEM_MAX_NUM_UNKO | Maximum number of UNKO drops in the world | 100 | Integer | -| BASE_CAMP_MAX_NUM | Maximum number of base camps | 128 | Integer | -| BASE_CAMP_WORKER_MAX_NUM | Maximum number of workers | 15 | Integer | -| DROP_ITEM_ALIVE_MAX_HOURS | Time it takes for items to despawn in hours | 1.000000 | Float | -| 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 | -| PAL_EGG_DEFAULT_HATCHING_TIME | Time(h) to incubate massive egg | 72.000000 | Float | -| WORK_SPEED_RATE | Work speed muliplier | 1.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 | -| ENABLE_NON_LOGIN_PENALTY | Enable non-login penalty | True | Boolean | -| ENABLE_FAST_TRAVEL | Enable fast travel | True | Boolean | -| 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 | -| COOP_PLAYER_MAX_NUM | Maximum number of players in a guild | 4 | Integer | -| REGION | Region | | String | -| USEAUTH | Use authentication | True | Boolean | -| BAN_LIST_URL | Which ban list to use | [https://api.palworldgame.com/api/banlist.txt](https://api.palworldgame.com/api/banlist.txt) | string | -| SHOW_PLAYER_LIST | Enable show player list | True | Boolean | +- Difficulty -> DIFFICULTY +- PalSpawnNumRate -> PAL_SPAWN_NUM_RATE +- bIsPvP -> IS_PVP + +| Variable | Description | Default Value | Allowed Value | +| ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------- | +| DIFFICULTY | Game Difficulty | None | `None`,`Normal`,`Difficult` | +| DAYTIME_SPEEDRATE | Day time speed - Larger number means shorter days | 1.000000 | Float | +| NIGHTTIME_SPEEDRATE | Night time speed - Larger number means shorter nights | 1.000000 | Float | +| EXP_RATE | EXP earn rate | 1.000000 | Float | +| PAL_CAPTURE_RATE | Pal capture rate | 1.000000 | Float | +| PAL_SPAWN_NUM_RATE | Pal appearance rate | 1.000000 | Float | +| PAL_DAMAGE_RATE_ATTACK | Damage from pals multipiler | 1.000000 | Float | +| PAL_DAMAGE_RATE_DEFENSE | Damage to pals multipiler | 1.000000 | Float | +| PLAYER_DAMAGE_RATE_ATTACK | Damage from player multipiler | 1.000000 | Float | +| PLAYER_DAMAGE_RATE_DEFENSE | Damage to player multipiler | 1.000000 | Float | +| PLAYER_STOMACH_DECREASE_RATE | Player hunger depletion rate | 1.000000 | Float | +| PLAYER_STAMINA_DECREASE_RATE | Player stamina reduction rate | 1.000000 | Float | +| PLAYER_AUTO_HP_REGEN_RATE | Player auto HP regeneration rate | 1.000000 | Float | +| PLAYER_AUTO_HP_REGEN_RATE_IN_SLEEP | Player sleep HP regeneration rate | 1.000000 | Float | +| PAL_STOMACH_DECREASE_RATE | Pal hunger depletion rate | 1.000000 | Float | +| PAL_STAMINA_DECREASE_RATE | Pal stamina reduction rate | 1.000000 | Float | +| PAL_AUTO_HP_REGEN_RATE | Pal auto HP regeneration rate | 1.000000 | Float | +| PAL_AUTO_HP_REGEN_RATE_IN_SLEEP | Pal sleep health regeneration rate (in Palbox) | 1.000000 | Float | +| BUILD_OBJECT_DAMAGE_RATE | Damage to structure multipiler | 1.000000 | Float | +| BUILD_OBJECT_DETERIORATION_DAMAGE_RATE | Structure determination rate | 1.000000 | Float | +| COLLECTION_DROP_RATE | Getherable items multipiler | 1.000000 | Float | +| COLLECTION_OBJECT_HP_RATE | Getherable objects HP multipiler | 1.000000 | Float | +| COLLECTION_OBJECT_RESPAWN_SPEED_RATE | Getherable objects respawn interval - The smaller the number, the faster the regeneration | 1.000000 | Float | +| ENEMY_DROP_ITEM_RATE | Dropped Items Multipiler | 1.000000 | Float | +| DEATH_PENALTY | Death Penalty
None: No death penalty
Item: Drops items other than equipment
ItemAndEquipment: Drops all items
All: Drops all PALs and all items. | All | `None`,`Item`,`ItemAndEquipment`,`All` | +| ENABLE_PLAYER_TO_PLAYER_DAMAGE | Allows players to cause damage to players | False | Boolean | +| ENABLE_FRIENDLY_FIRE | Allow friendly fire | False | Boolean | +| ENABLE_INVADER_ENEMY | Enable invaders | True | Boolean | +| ACTIVE_UNKO | Enable UNKO (?) | False | Boolean | +| ENABLE_AIM_ASSIST_PAD | Enable controller aim assist | True | Boolean | +| ENABLE_AIM_ASSIST_KEYBOARD | Enable Keyboard aim assist | False | Boolean | +| DROP_ITEM_MAX_NUM | Maximum number of drops in the world | 3000 | Integer | +| DROP_ITEM_MAX_NUM_UNKO | Maximum number of UNKO drops in the world | 100 | Integer | +| BASE_CAMP_MAX_NUM | Maximum number of base camps | 128 | Integer | +| BASE_CAMP_WORKER_MAX_NUM | Maximum number of workers | 15 | Integer | +| DROP_ITEM_ALIVE_MAX_HOURS | Time it takes for items to despawn in hours | 1.000000 | Float | +| 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 | +| PAL_EGG_DEFAULT_HATCHING_TIME | Time(h) to incubate massive egg | 72.000000 | Float | +| WORK_SPEED_RATE | Work speed muliplier | 1.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 | +| ENABLE_NON_LOGIN_PENALTY | Enable non-login penalty | True | Boolean | +| ENABLE_FAST_TRAVEL | Enable fast travel | True | Boolean | +| 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 | +| COOP_PLAYER_MAX_NUM | Maximum number of players in a guild | 4 | Integer | +| REGION | Region | | String | +| USEAUTH | Use authentication | True | Boolean | +| BAN_LIST_URL | Which ban list to use | [https://api.palworldgame.com/api/banlist.txt](https://api.palworldgame.com/api/banlist.txt) | string | +| SHOW_PLAYER_LIST | Enable show player list | True | Boolean | ### Manually @@ -527,23 +528,23 @@ send discord messages with docker compose: ## Locking Specific Game Version ->[!WARNING] ->Downgrading to a lower game version is possible, but it is unknown what impact it will have on existing saves. +> [!WARNING] +> Downgrading to a lower game version is possible, but it is unknown what impact it will have on existing saves. > ->**Please do so at your own risk!** +> **Please do so at your own risk!** If **TARGET_MANIFEST_ID** environment variable is set, will lock server version to specific manifest. The manifest corresponds to the release date/update versions. Manifests can be found using SteamCMD or websites like [SteamDB](https://steamdb.info/depot/2394012/manifests/). ### Version To Manifest ID Table -| Version | Manifest ID | -|---------|----------------------| -| 1.3.0 | 1354752814336157338 | -| 1.4.0 | 4190579964382773830 | -| 1.4.1 | 6370735655629434989 | -| 1.5.0 | 3750364703337203431 | -| 1.5.1 | 2815085007637542021 | +| Version | Manifest ID | +| ------- | ------------------- | +| 1.3.0 | 1354752814336157338 | +| 1.4.0 | 4190579964382773830 | +| 1.4.1 | 6370735655629434989 | +| 1.5.0 | 3750364703337203431 | +| 1.5.1 | 2815085007637542021 | ## Reporting Issues/Feature Requests diff --git a/docs/fr/README.md b/docs/fr/README.md new file mode 100644 index 000000000..248c52d74 --- /dev/null +++ b/docs/fr/README.md @@ -0,0 +1,551 @@ +# Palworld Serveur Dédié Docker + +[![Release](https://img.shields.io/github/v/release/thijsvanloef/palworld-server-docker)](https://github.com/thijsvanloef/palworld-server-docker/releases) +[![Docker Pulls](https://img.shields.io/docker/pulls/thijsvanloef/palworld-server-docker)](https://hub.docker.com/r/thijsvanloef/palworld-server-docker) +[![Docker Stars](https://img.shields.io/docker/stars/thijsvanloef/palworld-server-docker)](https://hub.docker.com/r/thijsvanloef/palworld-server-docker) +[![Image Size](https://img.shields.io/docker/image-size/thijsvanloef/palworld-server-docker/latest)](https://hub.docker.com/r/thijsvanloef/palworld-server-docker/tags) +[![Discord](https://img.shields.io/discord/1200397673329594459?logo=discord&label=Discord&link=https%3A%2F%2Fdiscord.gg%2FUxBxStPAAE)](https://discord.com/invite/UxBxStPAAE) + +[![CodeFactor](https://www.codefactor.io/repository/github/thijsvanloef/palworld-server-docker/badge)](https://www.codefactor.io/repository/github/thijsvanloef/palworld-server-docker) +[![Release](https://github.com/thijsvanloef/palworld-server-docker/actions/workflows/release.yml/badge.svg)](https://github.com/thijsvanloef/palworld-server-docker/actions/workflows/release.yml) +[![Linting](https://github.com/thijsvanloef/palworld-server-docker/actions/workflows/linting.yml/badge.svg)](https://github.com/thijsvanloef/palworld-server-docker/actions/workflows/linting.yml) +[![Security](https://github.com/thijsvanloef/palworld-server-docker/actions/workflows/security.yml/badge.svg)](https://github.com/thijsvanloef/palworld-server-docker/actions/workflows/security.yml) + +[![Docker Hub](https://img.shields.io/badge/Docker_Hub-palworld-blue?logo=docker)](https://hub.docker.com/r/thijsvanloef/palworld-server-docker) +[![GHCR](https://img.shields.io/badge/GHCR-palworld-blue?logo=docker)](https://github.com/thijsvanloef/palworld-server-docker/pkgs/container/palworld-server-docker) +[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/palworld-server-chart)](https://artifacthub.io/packages/search?repo=palworld-server-chart) + +[Discuter avec la communauté sur Discord](https://discord.gg/UxBxStPAAE) + +[English](/README.md) | [한국어](/docs/kr/README.md) | [简体中文](/docs/zh-CN/README.md) | [French](/docs/fr/README.md) + +> [!TIP] +> Vous ne savez pas par où commencer ? Consultez [ce guide que j'ai écrit !](https://tice.tips/containerization/palworld-server-docker/) + +Il s'agit d'un conteneur Docker pour vous aider à démarrer l'hébergement de votre propre serveur dédié [Palworld](https://store.steampowered.com/app/1623730/Palworld/). + +Ce conteneur Docker a été testé et fonctionnera sur les systèmes d'exploitation suivants : + +- Linux (Ubuntu/Debian) +- Windows 10, 11 +- MacOS (y compris Apple Silicon M1/M2/M3). + +Ce conteneur a également été testé et fonctionnera sur les architectures de processeur `x64` et `ARM64`. + +> [!IMPORTANT] +> Pour le moment, les joueurs Xbox GamePass/Xbox Console ne pourront pas rejoindre un serveur dédié. +> +> Ils devront rejoindre les joueurs en utilisant le code d'invitation et sont limités à des sessions de 4 joueurs maximum. + +## Sponsors + +Un énorme merci aux sponsors suivants ! + +

+doomhound188  AshishT112203  pabumake  stoprx  KiKoS0  inspired-by-nudes  PulsarFTW   +

+ +## Documentation Officielle + +[![Documentation](https://github.com/thijsvanloef/palworld-server-docker/assets/58031337/b92d76d1-5efb-438d-9ffd-5385544a831b)](https://palworld-server-docker.loef.dev/) + +## Configuration requise du serveur + +| Ressource | Minimum | Recommandé | +| --------- | ------- | -------------------------------------------------------- | +| CPU | 4 cœurs | 4 cœurs ou plus | +| RAM | 16 Go | Recommandé : plus de 32 Go pour un fonctionnement stable | +| Stockage | 8 Go | 20 Go | + +## Comment utiliser + +N'oubliez pas que vous devrez modifier les [variables d'environnement](#variables-denvironnement). + +### Docker Compose + +Ce référentiel comprend un exemple de fichier [docker-compose.yml](/docker-compose.yml) que vous pouvez utiliser pour configurer votre serveur. + +```yml +services: + palworld: + image: thijsvanloef/palworld-server-docker:latest + restart: unless-stopped + container_name: palworld-server + stop_grace_period: 30s # Réglez selon le temps que vous êtes prêt à attendre pour l'arrêt gracieux du conteneur + ports: + - 8211:8211/udp + - 27015:27015/udp + environment: + PUID: 1000 + PGID: 1000 + PORT: 8211 # Optionnel mais recommandé + PLAYERS: 16 # Optionnel mais recommandé + SERVER_PASSWORD: 'worldofpals' # Optionnel mais recommandé + MULTITHREADING: true + RCON_ENABLED: true + RCON_PORT: 25575 + TZ: 'UTC' + ADMIN_PASSWORD: 'adminPasswordHere' + COMMUNITY: false # Activez ceci si vous souhaitez que votre serveur apparaisse dans l'onglet des serveurs communautaires, À UTILISER AVEC LE MOT DE PASSE DU SERVEUR ! + SERVER_NAME: 'palworld-server-docker par Thijs van Loef' + SERVER_DESCRIPTION: 'palworld-server-docker par Thijs van Loef' + volumes: + - ./palworld:/palworld/ +``` + +En alternative, vous pouvez copier le fichier [.env.example](.env.example) dans un nouveau fichier appelé **.env**. +Modifiez-le selon vos besoins, consultez la section [environment variables](#environment-variables) pour vérifier les valeurs correctes. Modifiez votre fichier [docker-compose.yml](docker-compose.yml) comme suit : + +```yml +services: + palworld: + image: thijsvanloef/palworld-server-docker:latest + restart: unless-stopped + container_name: palworld-server + stop_grace_period: 30s # Réglez selon le temps que vous êtes prêt à attendre pour l'arrêt gracieux du conteneur + ports: + - 8211:8211/udp + - 27015:27015/udp + env_file: + - .env + volumes: + - ./palworld:/palworld/ +``` + +### Docker Run + +Changez chaque <> par votre propre configuration + +```bash +docker run -d \ + --name palworld-server \ + -p 8211:8211/udp \ + -p 27015:27015/udp \ + -v ./palworld:/palworld/ \ + -e PUID=1000 \ + -e PGID=1000 \ + -e PORT=8211 \ + -e PLAYERS=16 \ + -e MULTITHREADING=true \ + -e RCON_ENABLED=true \ + -e RCON_PORT=25575 \ + -e TZ=UTC \ + -e ADMIN_PASSWORD="adminPasswordHere" \ + -e SERVER_PASSWORD="worldofpals" \ + -e COMMUNITY=false \ + -e SERVER_NAME="palworld-server-docker by Thijs van Loef" \ + -e SERVER_DESCRIPTION="palworld-server-docker by Thijs van Loef" \ + --restart unless-stopped \ + --stop-timeout 30 \ + thijsvanloef/palworld-server-docker:latest +``` + +En alternative, vous pouvez copier le fichier [.env.example](.env.example) dans un nouveau fichier appelé **.env**. +Modifiez-le selon vos besoins, consultez la section [environment variables](#environment-variables) pour vérifier les valeurs correctes. Modifiez votre commande docker run comme suit : + +```bash +docker run -d \ + --name palworld-server \ + -p 8211:8211/udp \ + -p 27015:27015/udp \ + -v ./palworld:/palworld/ \ + --env-file .env \ + --restart unless-stopped \ + --stop-timeout 30 \ + thijsvanloef/palworld-server-docker:latest +``` + +### Kubernetes + +Tous les fichiers dont vous aurez besoin pour déployer ce conteneur sur Kubernetes se trouvent dans le dossier [k8s](k8s/). + +Suivez les étapes dans le [README.md ici](k8s/readme.md) pour le déployer. + +### Exécution sans les droits root + +Ceci est réservé aux utilisateurs avancés. + +Il est possible d'exécuter ce conteneur et de [remplacer l'utilisateur par défaut](https://docs.docker.com/engine/reference/run/#user) qui est root dans cette image. + +Étant donné que vous spécifiez l'utilisateur et le groupe, `PUID` et `PGID` sont ignorés. + +Si vous souhaitez trouver votre UID : `id -u` +Si vous souhaitez trouver votre GID : `id -g` + +Vous devez définir l'utilisateur sur `UID_NUMÉRIQUE:GID_NUMÉRIQUE` + +Ci-dessous, nous supposons que votre UID est 1000 et votre GID est 1001. + +- Dans la commande docker run, ajoutez `--user 1000:1001 \` au-dessus de la dernière ligne. +- Dans le fichier docker-compose, ajoutez `user: 1000:1001` au-dessus des ports. + +Si vous souhaitez l'exécuter avec un UID/GID différent du vôtre, vous devrez changer la propriété du répertoire qui est monté : `chown UID:GID palworld/` +ou en changeant les permissions pour tous les autres : `chmod o=rwx palworld/` + +#### Utilisation du chart Helm + +Le chart Helm officiel peut être trouvé dans un dépôt séparé, [palworld-server-chart](https://github.com/Twinki14/palworld-server-chart) + +### Variables d'environnement + +Vous pouvez utiliser les valeurs suivantes pour modifier les paramètres du serveur au démarrage. +Il est fortement recommandé de définir les valeurs d'environnement suivantes avant de démarrer le serveur : + +- PLAYERS +- PORT +- PUID +- PGID + +| Variable | Info | Valeurs par défaut | Valeurs autorisées | +| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| TZ | Fuseau horaire utilisé pour dater la sauvegarde du serveur | UTC | Voir [Identifiants TZ](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#Time_Zone_abbreviations) | +| PLAYERS\* | Nombre maximal de joueurs pouvant rejoindre le serveur | 16 | 1-32 | +| PORT\* | Port UDP exposé par le serveur | 8211 | 1024-65535 | +| PUID\* | UID de l'utilisateur sous lequel le serveur doit s'exécuter | 1000 | !0 | +| PGID\* | GID du groupe sous lequel le serveur doit s'exécuter | 1000 | !0 | +| MULTITHREADING\*\* | Améliore les performances dans les environnements CPU multi-threadés. Elle est efficace jusqu'à un maximum d'environ 4 threads, et allouer plus que ce nombre de threads n'a pas beaucoup de sens. | false | true/false | +| COMMUNITY | Si le serveur apparaît ou non dans le navigateur de serveurs communautaires (À UTILISER AVEC SERVER_PASSWORD) | false | true/false | +| PUBLIC_IP | Vous pouvez spécifier manuellement l'adresse IP globale du réseau sur lequel le serveur est en cours d'exécution. Sinon, elle sera détectée automatiquement. Si cela ne fonctionne pas bien, essayez une configuration manuelle. | | x.x.x.x | +| PUBLIC_PORT | Vous pouvez spécifier manuellement le numéro de port du réseau sur lequel le serveur est en cours d'exécution. Sinon, il sera détecté automatiquement. Si cela ne fonctionne pas bien, essayez une configuration manuelle. | | 1024-65535 | +| SERVER_NAME | Un nom pour votre serveur | | "chaîne" | +| SERVER_DESCRIPTION | La description de votre serveur | | "chaîne" | +| SERVER_PASSWORD | Sécurisez votre serveur communautaire avec un mot de passe | | "chaîne" | +| ADMIN_PASSWORD | Sécurisez l'accès à l'administration du serveur avec un mot de passe | | "chaîne" | +| UPDATE_ON_BOOT\*\* | Mettre à jour/Installer le serveur lorsque le conteneur Docker démarre (CELÀ DOIT ÊTRE ACTIVÉ LA PREMIÈRE FOIS QUE VOUS EXÉCUTEZ LE CONTENEUR) | true | true/false | +| RCON_ENABLED\*\*\* | Activer RCON pour le serveur Palworld | true | true/false | +| RCON_PORT | Port RCON pour se connecter | 25575 | 1024-65535 | +| QUERY_PORT | Port de requête utilisé pour communiquer avec les serveurs Steam | 27015 | 1024-65535 | +| BACKUP_CRON_EXPRESSION | Le paramètre affecte la fréquence des sauvegardes automatiques. | 0 0 \* \* \* | Nécessite une expression Cron - Voir [Configuration des sauvegardes automatiques avec Cron](#configuring-automatic-backups-with-cron) | +| BACKUP_ENABLED | Active les sauvegardes automatiques | true | true/false | +| DELETE_OLD_BACKUPS | Supprime les sauvegardes après un certain nombre de jours | false | true/false | +| OLD_BACKUP_DAYS | Combien de jours conserver les sauvegardes | 30 | tout entier positif | +| AUTO_UPDATE_CRON_EXPRESSION | Le paramètre affecte la fréquence des mises à jour automatiques. | 0 \* \* \* \* | Nécessite une expression Cron - Voir [Configuration des sauvegardes automatiques avec Cron](#configuring-automatic-backups-with-cron) | +| AUTO_UPDATE_ENABLED | Active les mises à jour automatiques | false | true/false | +| AUTO_UPDATE_WARN_MINUTES | Temps d'attente avant de mettre à jour le serveur, après que les joueurs ont été informés. (Cela sera ignoré s'il n'y a pas de joueurs connectés) | 30 | Entier | +| AUTO_REBOOT_CRON_EXPRESSION | Le paramètre affecte la fréquence des mises à jour automatiques. | 0 0 \* \* \* | Nécessite une expression Cron - Voir [Configuration des sauvegardes automatiques avec Cron](#configuring-automatic-reboots-with-cron) | +| AUTO_REBOOT_ENABLED | Active les redémarrages automatiques | false | true/false | +| AUTO_REBOOT_WARN_MINUTES | Temps d'attente avant de redémarrer le serveur, après que les joueurs ont été informés. | 5 | Entier | +| AUTO_REBOOT_EVEN_IF_PLAYERS_ONLINE | Redémarrez le serveur même s'il y a des joueurs en ligne. | false | true/false | +| TARGET_MANIFEST_ID | Verrouille la version du jeu en correspondance avec l'ID de manifeste de Steam Download Depot. | | Voir [Tableau des ID de manifeste](#locking-specific-game-version) | +| DISCORD_WEBHOOK_URL | URL du webhook Discord trouvée après la création d'un webhook sur un serveur Discord | | `https://discord.com/api/webhooks/` | +| DISCORD_CONNECT_TIMEOUT | Délai de connexion initial de la commande Discord | 30 | !0 | +| DISCORD_MAX_TIMEOUT | Délai total du webhook Discord | 30 | !0 | +| DISCORD_PRE_UPDATE_BOOT_MESSAGE | Message Discord envoyé lorsque le serveur commence à se mettre à jour | Le serveur est en cours de mise à jour... | "chaîne" | +| DISCORD_POST_UPDATE_BOOT_MESSAGE | Message Discord envoyé lorsque le serveur a terminé de se mettre à jour | Mise à jour du serveur terminée ! | "chaîne" | +| DISCORD_PRE_START_MESSAGE | Message Discord envoyé lorsque le serveur commence à démarrer | Le serveur est démarré ! | "chaîne" | +| DISCORD_PRE_SHUTDOWN_MESSAGE | Message Discord envoyé lorsque le serveur commence à s'arrêter | Le serveur est en cours d'arrêt... | "chaîne" | +| DISCORD_POST_SHUTDOWN_MESSAGE | Message Discord envoyé lorsque le serveur s'est arrêté | Le serveur est arrêté ! | "chaîne" | +| DISABLE_GENERATE_SETTINGS | S'il faut générer automatiquement le fichier PalWorldSettings.ini | false | true/false | +| DISABLE_GENERATE_ENGINE | S'il faut générer automatiquement le fichier Engine.ini | true | true/false | +| ENABLE_PLAYER_LOGGING | Active la journalisation et l'annonce des entrées et sorties de joueurs | true | true/false | +| PLAYER_LOGGING_POLL_PERIOD | Période de sondage (en secondes) pour vérifier les joueurs qui ont rejoint ou quitté | 5 | !0 | + +\* Hautement recommandé à définir + +\*\* Assurez-vous de savoir ce que vous faites lorsque vous exécutez cette option activée + +\*\*\* Nécessaire pour que `docker stop` enregistre et ferme gracieusement le serveur + +### Ports du jeu + +| Port | Info | +| ----- | --------------------- | +| 8211 | Port du jeu (UDP) | +| 27015 | Port de requête (UDP) | +| 25575 | Port RCON (TCP) | + +## Utilisation de RCON + +RCON est activé par défaut pour l'image palworld-server-docker. +Ouvrir la CLI RCON est assez simple : + +```bash +docker exec -it palworld-server rcon-cli " " +``` + +Par exemple, vous pouvez diffuser un message à tout le monde dans le serveur avec la commande suivante : + +```bash +docker exec -it palworld-server rcon-cli "Broadcast Bonjour à tous" +``` + +Cela ouvrira une interface en ligne de commande utilisant RCON pour envoyer des commandes au serveur Palworld. + +### Liste des commandes du serveur + +| Command | Info | +| ------------------------------------ | --------------------------------------------------------- | +| Shutdown {Secondes} {TexteDuMessage} | Le serveur s'arrête après le nombre de secondes spécifié | +| DoExit | Arrêt forcé du serveur. | +| Broadcast | Envoyer un message à tous les joueurs dans le serveur | +| KickPlayer {SteamID} | Expulser un joueur du serveur. | +| BanPlayer {SteamID} | Bannir un joueur du serveur. | +| TeleportToPlayer {SteamID} | Téléporter à l'emplacement actuel du joueur ciblé. | +| TeleportToMe {SteamID} | Téléporter le joueur ciblé à votre emplacement actuel | +| ShowPlayers | Afficher les informations sur tous les joueurs connectés. | +| Info | Afficher les informations du serveur. | +| Save | Sauvegarder les données du monde. | + +Pour une liste complète des commandes, consultez : [https://tech.palworldgame.com/server-commands](https://tech.palworldgame.com/server-commands) + +## Création d'une sauvegarde + +Pour créer une sauvegarde de la progression actuelle du jeu, utilisez la commande : + +```bash +docker exec palworld-server backup +``` + +Cela créera une sauvegarde dans `/palworld/backups/` + +Le serveur effectuera une sauvegarde avant la sauvegarde si RCON est activé. + +## Restauration à partir d'une sauvegarde + +Pour restaurer à partir d'une sauvegarde, utilisez la commande : + +```bash +docker exec -it palworld-server restore +``` + +La variable d'environnement `RCON_ENABLED` doit être définie sur `true` pour utiliser cette commande. + +> [!IMPORTANT] +> Si la redémarrage de Docker n'est pas configuré avec la politique `always` ou `unless-stopped` le serveur s'éteindra et devra être +> redémarré manuellement. +> +> La commande docker run exemple et le fichier docker-compose dans [Comment utiliser](#how-to-use) utilisent déjà la politique nécessaire + +## Restauration manuelle à partir d'une sauvegarde + +Localisez la sauvegarde que vous souhaitez restaurer dans `/palworld/backups/` et décompressez-la. +Vous devez arrêter le serveur avant de continuer. + +```bash +docker compose down +``` + +Supprimez l'ancien dossier de données sauvegardées situé à `palworld/Pal/Saved/SaveGames/0/`. + +Copiez le contenu du nouveau dossier de données sauvegardées décompressé `Saved/SaveGames/0/` to `palworld/Pal/Saved/SaveGames/0/`. + +Remplacez le nom DedicatedServerName à l'intérieur de `palworld/Pal/Saved/Config/LinuxServer/GameUserSettings.ini` par le nouveau nom de dossier. + +```ini +DedicatedServerName= # Remplacez-le par votre nom de dossier. +``` + +Redémarrez le jeu. (Si vous utilisez Docker Compose) + +```bash +docker compose up -d +``` + +## Configuration des Sauvegardes Automatiques avec Cron + +Le serveur est automatiquement sauvegardé chaque nuit à minuit, selon le fuseau horaire défini avec TZ. + +Définissez BACKUP_ENABLED pour activer ou désactiver les sauvegardes automatiques (par défaut, c'est activé). + +BACKUP_CRON_EXPRESSION est une expression cron, où vous définissez un intervalle pour l'exécution des tâches. + +> [!TIP] +> Cette image utilise Supercronic pour les tâches cron +> voir [supercronic](https://github.com/aptible/supercronic#crontab-format) +> ou +> [Crontab Generator](https://crontab-generator.org). + +Définissez BACKUP_CRON_EXPRESSION pour changer la planification par défaut. +Exemple d'utilisation : Si BACKUP_CRON_EXPRESSION est défini sur `0 2 * * *`, le script de sauvegarde s'exécutera tous les jours à 2h00 du matin. + +## Configuration des Mises à Jour Automatiques avec Cron + +Pour pouvoir utiliser les mises à jour automatiques avec ce serveur, les variables d'environnement suivantes **doivent** être définies sur `true`: + +- RCON_ENABLED +- UPDATE_ON_BOOT + +> [!IMPORTANT] +> +> Si le redémarrage de Docker n'est pas configuré avec la politique `always` ou `unless-stopped` le serveur s'éteindra et devra être +> redémarré manuellement. +> +> La commande docker run exemple et le fichier docker-compose dans [Comment utiliser](#how-to-use) utilisent déjà la politique nécessaire + +Définissez AUTO_UPDATE_ENABLED pour activer ou désactiver les mises à jour automatiques (par défaut, c'est désactivé). + +AUTO_UPDATE_CRON_EXPRESSION est une expression cron, où vous définissez un intervalle pour l'exécution des tâches. + +> [!TIP] +> Cette image utilise Supercronic pour les tâches cron +> voir [supercronic](https://github.com/aptible/supercronic#crontab-format) +> ou +> [Crontab Generator](https://crontab-generator.org). + +Définissez AUTO_UPDATE_CRON_EXPRESSION pour changer la planification par défaut. + +## Configuration des Redémarrages Automatiques avec Cron + +Pour pouvoir utiliser les redémarrages automatiques avec ce serveur, RCON_ENABLED doit être activé. + +> [!IMPORTANT] +> +> Si le redémarrage de Docker n'est pas configuré avec la politique `always` ou `unless-stopped` le serveur s'éteindra et devra être +> redémarré manuellement. +> +> La commande docker run exemple et le fichier docker-compose dans [Comment utiliser](#how-to-use) utilisent déjà la politique nécessaire + +Définissez AUTO_REBOOT_ENABLED pour activer ou désactiver les redémarrages automatiques (par défaut, c'est désactivé). + +AUTO_REBOOT_CRON_EXPRESSION est une expression cron, où vous définissez un intervalle pour l'exécution des tâches. + +> [!TIP] +> Cette image utilise Supercronic pour les tâches cron +> voir [supercronic](https://github.com/aptible/supercronic#crontab-format) +> ou +> [Crontab Generator](https://crontab-generator.org). + +Définissez AUTO_REBOOT_CRON_EXPRESSION pour changer la planification par défaut, qui est tous les soirs à minuit selon le +fuseau horaire défini avec TZ. + +## Modification des paramètres du serveur + +### Avec des variables d'environnement + +> [!IMPORTANT] +> +> Ces variables d'environnement/paramètres sont susceptibles de changer car le jeu est encore en version bêta. +> Consultez la [page officielle pour les paramètres pris en charge.](https://tech.palworldgame.com/optimize-game-balance) + +La conversion des paramètres du serveur en variables d'environnement suit les mêmes principes (avec quelques exceptions) : + +- toutes en majuscules +- séparation des mots par l'insertion d'un trait de soulignement +- suppression de la lettre unique si le paramètre commence par une (comme 'b') + +Par exemple : + +- Difficulty -> DIFFICULTY +- PalSpawnNumRate -> PAL_SPAWN_NUM_RATE +- bIsPvP -> IS_PVP + +| Variable | Description | Valeur par défaut | Valeur autorisée | +| ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | ---------------------------------------------- | +| DIFFICULTY | Difficulté du jeu | Aucune | `Aucune`, `Normal`, `Difficile` | +| DAYTIME_SPEEDRATE | Vitesse du jour - Un nombre plus grand signifie des journées plus courtes | 1,000000 | Flottant | +| NIGHTTIME_SPEEDRATE | Vitesse de la nuit - Un nombre plus grand signifie des nuits plus courtes | 1,000000 | Flottant | +| EXP_RATE | Taux de gain d'EXP | 1,000000 | Flottant | +| PAL_CAPTURE_RATE | Taux de capture de Pal | 1,000000 | Flottant | +| PAL_SPAWN_NUM_RATE | Taux d'apparition des Pals | 1,000000 | Flottant | +| PAL_DAMAGE_RATE_ATTACK | Multiplicateur des dégâts infligés par les Pals | 1,000000 | Flottant | +| PAL_DAMAGE_RATE_DEFENSE | Multiplicateur des dégâts subis par les Pals | 1,000000 | Flottant | +| PLAYER_DAMAGE_RATE_ATTACK | Multiplicateur des dégâts infligés par le joueur | 1,000000 | Flottant | +| PLAYER_DAMAGE_RATE_DEFENSE | Multiplicateur des dégâts subis par le joueur | 1,000000 | Flottant | +| PLAYER_STOMACH_DECREASE_RATE | Taux de déplétion de la faim du joueur | 1,000000 | Flottant | +| PLAYER_STAMINA_DECREASE_RATE | Taux de réduction de la stamina du joueur | 1,000000 | Flottant | +| PLAYER_AUTO_HP_REGEN_RATE | Taux de régénération automatique des PV du joueur | 1,000000 | Flottant | +| PLAYER_AUTO_HP_REGEN_RATE_IN_SLEEP | Taux de régénération automatique des PV du joueur pendant le sommeil | 1,000000 | Flottant | +| PAL_STOMACH_DECREASE_RATE | Taux de déplétion de la faim des Pals | 1,000000 | Flottant | +| PAL_STAMINA_DECREASE_RATE | Taux de réduction de la stamina des Pals | 1,000000 | Flottant | +| PAL_AUTO_HP_REGEN_RATE | Taux de régénération automatique des PV des Pals | 1,000000 | Flottant | +| PAL_AUTO_HP_REGEN_RATE_IN_SLEEP | Taux de régénération automatique de la santé des Pals (dans la Palbox) | 1,000000 | Flottant | +| BUILD_OBJECT_DAMAGE_RATE | Multiplicateur des dégâts aux structures | 1,000000 | Flottant | +| BUILD_OBJECT_DETERIORATION_DAMAGE_RATE | Taux de détermination de la structure | 1,000000 | Flottant | +| COLLECTION_DROP_RATE | Multiplicateur d'objets collectables | 1,000000 | Flottant | +| COLLECTION_OBJECT_HP_RATE | Multiplicateur de la santé des objets collectables | 1,000000 | Flottant | +| COLLECTION_OBJECT_RESPAWN_SPEED_RATE | Taux d'intervalle de réapparition des objets collectables - Plus le nombre est petit, plus la régénération est rapide | 1,000000 | Flottant | +| ENEMY_DROP_ITEM_RATE | Multiplicateur d'objets abandonnés par les ennemis | 1,000000 | Flottant | +| DEATH_PENALTY | Pénalité de mort
Aucune : Pas de pénalité de mort
Objet : Lâche des objets autres que l'équipement
ObjetEtÉquipement : Lâche tous les objets
Tous : Lâche tous les Pals et tous les objets | Tous | `Aucune`, `Objet`, `ObjetEtÉquipement`, `Tous` | +| ENABLE_PLAYER_TO_PLAYER_DAMAGE | Permet aux joueurs de causer des dégâts aux autres joueurs | Faux | Booléen | +| ENABLE_FRIENDLY_FIRE | Autoriser les tirs amis | Faux | Booléen | +| ENABLE_INVADER_ENEMY | Activer les envahisseurs | Vrai | Booléen | +| ACTIVE_UNKO | Activer UNKO (?) | Faux | Booléen | +| ENABLE_AIM_ASSIST_PAD | Activer l'assistance à la visée du contrôleur | Vrai | Booléen | +| ENABLE_AIM_ASSIST_KEYBOARD | Activer l'assistance à la visée du clavier | Faux | Booléen | +| DROP_ITEM_MAX_NUM | Nombre maximal de largages dans le monde | 3000 | Entier | +| DROP_ITEM_MAX_NUM_UNKO | Nombre maximal de largages UNKO dans le monde | 100 | Entier | +| BASE_CAMP_MAX_NUM | Nombre maximal de camps de base | 128 | Entier | +| BASE_CAMP_WORKER_MAX_NUM | Nombre maximal de travailleurs | 15 | Entier | +| DROP_ITEM_ALIVE_MAX_HOURS | Temps avant la disparition des objets en heures | 1,000000 | Flottant | +| AUTO_RESET_GUILD_NO_ONLINE_PLAYERS | Réinitialiser automatiquement la guilde lorsqu'aucun joueur n'est en ligne | Faux | Booléen | +| AUTO_RESET_GUILD_TIME_NO_ONLINE_PLAYERS | Temps pour réinitialiser automatiquement la guilde lorsqu'aucun joueur n'est en ligne | 72,000000 | Flottant | +| GUILD_PLAYER_MAX_NUM | Nombre maximum de joueurs dans une guilde | 20 | Entier | +| PAL_EGG_DEFAULT_HATCHING_TIME | Temps (h) pour incuber un œuf massif | 72,000000 | Flottant | +| WORK_SPEED_RATE | Multiplicateur de la vitesse de travail | 1,000000 | Flottant | +| IS_MULTIPLAY | Activer le multijoueur | Faux | Booléen | +| IS_PVP | Activer le PVP | Faux | Booléen | +| CAN_PICKUP_OTHER_GUILD_DEATH_PENALTY_DROP | Autoriser les joueurs d'autres guildes à ramasser les objets de pénalité de mort | Faux | Booléen | +| ENABLE_NON_LOGIN_PENALTY | Activer la pénalité hors connexion | Vrai | Booléen | +| ENABLE_FAST_TRAVEL | Activer le déplacement rapide | Vrai | Booléen | +| IS_START_LOCATION_SELECT_BY_MAP | Activer la sélection de l'emplacement de départ | Vrai | Booléen | +| EXIST_PLAYER_AFTER_LOGOUT | Bascule pour supprimer les joueurs lorsqu'ils se déconnectent | Faux | Booléen | +| ENABLE_DEFENSE_OTHER_GUILD_PLAYER | Permet la défense contre les joueurs d'autres guildes | Faux | Booléen | +| COOP_PLAYER_MAX_NUM | Nombre maximum de joueurs dans une guilde | 4 | Entier | +| REGION | Région | | Chaîne de caractères | +| USEAUTH | Utiliser l'authentification | Vrai | Booléen | +| BAN_LIST_URL | Liste des interdictions à utiliser | [https://api.palworldgame.com/api/banlist.txt](https://api.palworldgame.com/api/banlist.txt) | Chaîne de caractères | +| SHOW_PLAYER_LIST | Activer l'affichage de la liste des joueurs | Vrai | Booléen | + +### Manuellement + +Lorsque le serveur démarre, un fichier `PalWorldSettings.ini` sera créé à l'emplacement suivant : `/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini` + +Veuillez noter que les variables d'environnement (ENV) écraseront toujours les modifications apportées à `PalWorldSettings.ini`. + +> [!IMPORTANT] +> Les changements ne peuvent être apportés à `PalWorldSettings.ini` que lorsque le serveur est éteint. +> +> Toutes les modifications apportées pendant que le serveur est en cours d'exécution seront écrasées lors de l'arrêt du serveur. + +Pour une liste plus détaillée des paramètres du serveur, consultez : [Palworld Wiki](https://palworld.wiki.gg/wiki/PalWorldSettings.ini) + +Pour des explications plus détaillées sur les paramètres du serveur, consultez : [shockbyte](https://shockbyte.com/billing/knowledgebase/1189/How-to-Configure-your-Palworld-server.html) + +## Utilisation de webhooks Discord + +1. Générez une URL de webhook pour votre serveur Discord dans les paramètres de votre serveur Discord. + +2. Configurez la variable d'environnement avec le jeton unique à la fin de l'exemple d'URL de webhook Discord : `https://discord.com/api/webhooks/1234567890/abcde` + +Envoyez des messages Discord avec docker run : + +```sh +-e DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/1234567890/abcde" \ +-e DISCORD_PRE_UPDATE_BOOT_MESSAGE="Le serveur est en cours de mise à jour..." \ + +``` + +Envoyez des messages Discord avec docker compose : + +```yaml +- DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/1234567890/abcde +- DISCORD_PRE_UPDATE_BOOT_MESSAGE=Le serveur est en cours de mise à jour... +``` + +## Verrouiller une Version Spécifique du Jeu + +> [!WARNING] +> Rétrograder vers une version inférieure du jeu est possible, mais on ne sait pas quel impact cela aura sur les sauvegardes existantes. +> +> **Faites-le à vos propres risques !** + +Si la variable d'environnement **TARGET_MANIFEST_ID** est définie, elle verrouillera la version du serveur sur un manifeste spécifique. +Le manifeste correspond aux dates de sortie/mises à jour. Les manifestes peuvent être trouvés à l'aide de SteamCMD ou de sites web comme [SteamDB](https://steamdb.info/depot/2394012/manifests/). + +### Tableau des Versions Vers les ID de Manifeste + +| Version | ID de Manifeste | +| ------- | ------------------- | +| 1.3.0 | 1354752814336157338 | +| 1.4.0 | 4190579964382773830 | +| 1.4.1 | 6370735655629434989 | +| 1.5.0 | 3750364703337203431 | +| 1.5.1 | 2815085007637542021 | + +## Signalement de Problèmes/Demandes de Fonctionnalités + +Les problèmes/Demandes de fonctionnalités peuvent être soumis en utilisant [ce lien](https://github.com/thijsvanloef/palworld-server-docker/issues/new/choose). + +### Problèmes Connus + +Les problèmes connus sont répertoriés dans la [documentation](https://palworld-server-docker.loef.dev/known-issues/) From 9e1363688febca2ebc024fc57da0b80376d16ef7 Mon Sep 17 00:00:00 2001 From: Thijs van Loef Date: Fri, 1 Mar 2024 18:24:31 +0100 Subject: [PATCH 2/4] fix line length issues --- docs/fr/README.md | 64 +++++++++++++++++++++++++++++++---------------- 1 file changed, 42 insertions(+), 22 deletions(-) diff --git a/docs/fr/README.md b/docs/fr/README.md index 248c52d74..f294cd543 100644 --- a/docs/fr/README.md +++ b/docs/fr/README.md @@ -1,5 +1,9 @@ # Palworld Serveur Dédié Docker +## ⚠️These docs will be deprecated and removed on March 31 2024⚠️ + +Please use the official docs: [https://palworld-server-docker.loef.dev/](https://palworld-server-docker.loef.dev/) + [![Release](https://img.shields.io/github/v/release/thijsvanloef/palworld-server-docker)](https://github.com/thijsvanloef/palworld-server-docker/releases) [![Docker Pulls](https://img.shields.io/docker/pulls/thijsvanloef/palworld-server-docker)](https://hub.docker.com/r/thijsvanloef/palworld-server-docker) [![Docker Stars](https://img.shields.io/docker/stars/thijsvanloef/palworld-server-docker)](https://hub.docker.com/r/thijsvanloef/palworld-server-docker) @@ -59,11 +63,12 @@ Un énorme merci aux sponsors suivants ! ## Comment utiliser -N'oubliez pas que vous devrez modifier les [variables d'environnement](#variables-denvironnement). +N'oubliez pas que vous devrez modifier les [variables d'environnement](#variables-d-environnement). ### Docker Compose -Ce référentiel comprend un exemple de fichier [docker-compose.yml](/docker-compose.yml) que vous pouvez utiliser pour configurer votre serveur. +Ce référentiel comprend un exemple de fichier [docker-compose.yml](/docker-compose.yml) +que vous pouvez utiliser pour configurer votre serveur. ```yml services: @@ -94,7 +99,8 @@ services: ``` En alternative, vous pouvez copier le fichier [.env.example](.env.example) dans un nouveau fichier appelé **.env**. -Modifiez-le selon vos besoins, consultez la section [environment variables](#environment-variables) pour vérifier les valeurs correctes. Modifiez votre fichier [docker-compose.yml](docker-compose.yml) comme suit : +Modifiez-le selon vos besoins, consultez la section [environment variables](#variables-d-environnement) pour vérifier les +valeurs correctes. Modifiez votre fichier [docker-compose.yml](docker-compose.yml) comme suit : ```yml services: @@ -141,7 +147,8 @@ docker run -d \ ``` En alternative, vous pouvez copier le fichier [.env.example](.env.example) dans un nouveau fichier appelé **.env**. -Modifiez-le selon vos besoins, consultez la section [environment variables](#environment-variables) pour vérifier les valeurs correctes. Modifiez votre commande docker run comme suit : +Modifiez-le selon vos besoins, consultez la section [environment variables](#variables-d-environnement) pour vérifier +les valeurs correctes. Modifiez votre commande docker run comme suit: ```bash docker run -d \ @@ -165,7 +172,8 @@ Suivez les étapes dans le [README.md ici](k8s/readme.md) pour le déployer. Ceci est réservé aux utilisateurs avancés. -Il est possible d'exécuter ce conteneur et de [remplacer l'utilisateur par défaut](https://docs.docker.com/engine/reference/run/#user) qui est root dans cette image. +Il est possible d'exécuter ce conteneur et de [remplacer l'utilisateur par défaut](https://docs.docker.com/engine/reference/run/#user) +qui est root dans cette image. Étant donné que vous spécifiez l'utilisateur et le groupe, `PUID` et `PGID` sont ignorés. @@ -179,14 +187,15 @@ Ci-dessous, nous supposons que votre UID est 1000 et votre GID est 1001. - Dans la commande docker run, ajoutez `--user 1000:1001 \` au-dessus de la dernière ligne. - Dans le fichier docker-compose, ajoutez `user: 1000:1001` au-dessus des ports. -Si vous souhaitez l'exécuter avec un UID/GID différent du vôtre, vous devrez changer la propriété du répertoire qui est monté : `chown UID:GID palworld/` +Si vous souhaitez l'exécuter avec un UID/GID différent du vôtre, vous devrez changer la +propriété du répertoire qui est monté : `chown UID:GID palworld/` ou en changeant les permissions pour tous les autres : `chmod o=rwx palworld/` #### Utilisation du chart Helm Le chart Helm officiel peut être trouvé dans un dépôt séparé, [palworld-server-chart](https://github.com/Twinki14/palworld-server-chart) -### Variables d'environnement +### Variables d environnement Vous pouvez utiliser les valeurs suivantes pour modifier les paramètres du serveur au démarrage. Il est fortement recommandé de définir les valeurs d'environnement suivantes avant de démarrer le serveur : @@ -226,7 +235,7 @@ Il est fortement recommandé de définir les valeurs d'environnement suivantes a | AUTO_REBOOT_ENABLED | Active les redémarrages automatiques | false | true/false | | AUTO_REBOOT_WARN_MINUTES | Temps d'attente avant de redémarrer le serveur, après que les joueurs ont été informés. | 5 | Entier | | AUTO_REBOOT_EVEN_IF_PLAYERS_ONLINE | Redémarrez le serveur même s'il y a des joueurs en ligne. | false | true/false | -| TARGET_MANIFEST_ID | Verrouille la version du jeu en correspondance avec l'ID de manifeste de Steam Download Depot. | | Voir [Tableau des ID de manifeste](#locking-specific-game-version) | +| TARGET_MANIFEST_ID | Verrouille la version du jeu en correspondance avec l'ID de manifeste de Steam Download Depot. | | Voir [Tableau des ID de manifeste](#tableau-des-versions-vers-les-id-de-manifeste) | | DISCORD_WEBHOOK_URL | URL du webhook Discord trouvée après la création d'un webhook sur un serveur Discord | | `https://discord.com/api/webhooks/` | | DISCORD_CONNECT_TIMEOUT | Délai de connexion initial de la commande Discord | 30 | !0 | | DISCORD_MAX_TIMEOUT | Délai total du webhook Discord | 30 | !0 | @@ -311,10 +320,11 @@ docker exec -it palworld-server restore La variable d'environnement `RCON_ENABLED` doit être définie sur `true` pour utiliser cette commande. > [!IMPORTANT] -> Si la redémarrage de Docker n'est pas configuré avec la politique `always` ou `unless-stopped` le serveur s'éteindra et devra être -> redémarré manuellement. +> Si la redémarrage de Docker n'est pas configuré avec la politique `always` ou `unless-stopped` +> le serveur s'éteindra et devra être redémarré manuellement. > -> La commande docker run exemple et le fichier docker-compose dans [Comment utiliser](#how-to-use) utilisent déjà la politique nécessaire +> La commande docker run exemple et le fichier docker-compose dans [Comment utiliser](#how-to-use) +> utilisent déjà la politique nécessaire ## Restauration manuelle à partir d'une sauvegarde @@ -329,7 +339,8 @@ Supprimez l'ancien dossier de données sauvegardées situé à `palworld/Pal/Sav Copiez le contenu du nouveau dossier de données sauvegardées décompressé `Saved/SaveGames/0/` to `palworld/Pal/Saved/SaveGames/0/`. -Remplacez le nom DedicatedServerName à l'intérieur de `palworld/Pal/Saved/Config/LinuxServer/GameUserSettings.ini` par le nouveau nom de dossier. +Remplacez le nom DedicatedServerName à l'intérieur de `palworld/Pal/Saved/Config/LinuxServer/GameUserSettings.ini` +par le nouveau nom de dossier. ```ini DedicatedServerName= # Remplacez-le par votre nom de dossier. @@ -356,21 +367,25 @@ BACKUP_CRON_EXPRESSION est une expression cron, où vous définissez un interval > [Crontab Generator](https://crontab-generator.org). Définissez BACKUP_CRON_EXPRESSION pour changer la planification par défaut. -Exemple d'utilisation : Si BACKUP_CRON_EXPRESSION est défini sur `0 2 * * *`, le script de sauvegarde s'exécutera tous les jours à 2h00 du matin. +Exemple d'utilisation : Si BACKUP_CRON_EXPRESSION est défini sur `0 2 * * *`, le script de sauvegarde +s'exécutera tous les jours à 2h00 du matin. ## Configuration des Mises à Jour Automatiques avec Cron -Pour pouvoir utiliser les mises à jour automatiques avec ce serveur, les variables d'environnement suivantes **doivent** être définies sur `true`: +Pour pouvoir utiliser les mises à jour automatiques avec ce serveur, les variables d'environnement +suivantes **doivent** être définies sur `true`: - RCON_ENABLED - UPDATE_ON_BOOT > [!IMPORTANT] > -> Si le redémarrage de Docker n'est pas configuré avec la politique `always` ou `unless-stopped` le serveur s'éteindra et devra être +> Si le redémarrage de Docker n'est pas configuré avec la politique `always` ou `unless-stopped` +> le serveur s'éteindra et devra être > redémarré manuellement. > -> La commande docker run exemple et le fichier docker-compose dans [Comment utiliser](#how-to-use) utilisent déjà la politique nécessaire +> La commande docker run exemple et le fichier docker-compose dans [Comment utiliser](#how-to-use) +> utilisent déjà la politique nécessaire Définissez AUTO_UPDATE_ENABLED pour activer ou désactiver les mises à jour automatiques (par défaut, c'est désactivé). @@ -390,10 +405,12 @@ Pour pouvoir utiliser les redémarrages automatiques avec ce serveur, RCON_ENABL > [!IMPORTANT] > -> Si le redémarrage de Docker n'est pas configuré avec la politique `always` ou `unless-stopped` le serveur s'éteindra et devra être +> Si le redémarrage de Docker n'est pas configuré avec la politique `always` ou `unless-stopped` +> le serveur s'éteindra et devra être > redémarré manuellement. > -> La commande docker run exemple et le fichier docker-compose dans [Comment utiliser](#how-to-use) utilisent déjà la politique nécessaire +> La commande docker run exemple et le fichier docker-compose dans [Comment utiliser](#how-to-use) +> utilisent déjà la politique nécessaire Définissez AUTO_REBOOT_ENABLED pour activer ou désactiver les redémarrages automatiques (par défaut, c'est désactivé). @@ -417,7 +434,7 @@ fuseau horaire défini avec TZ. > Ces variables d'environnement/paramètres sont susceptibles de changer car le jeu est encore en version bêta. > Consultez la [page officielle pour les paramètres pris en charge.](https://tech.palworldgame.com/optimize-game-balance) -La conversion des paramètres du serveur en variables d'environnement suit les mêmes principes (avec quelques exceptions) : +La conversion des paramètres du serveur en variables d'environnement suit les mêmes principes (avec quelques exceptions): - toutes en majuscules - séparation des mots par l'insertion d'un trait de soulignement @@ -525,12 +542,15 @@ Envoyez des messages Discord avec docker compose : ## Verrouiller une Version Spécifique du Jeu > [!WARNING] -> Rétrograder vers une version inférieure du jeu est possible, mais on ne sait pas quel impact cela aura sur les sauvegardes existantes. +> Rétrograder vers une version inférieure du jeu est possible, mais on ne sait pas quel impact +> cela aura sur les sauvegardes existantes. > > **Faites-le à vos propres risques !** -Si la variable d'environnement **TARGET_MANIFEST_ID** est définie, elle verrouillera la version du serveur sur un manifeste spécifique. -Le manifeste correspond aux dates de sortie/mises à jour. Les manifestes peuvent être trouvés à l'aide de SteamCMD ou de sites web comme [SteamDB](https://steamdb.info/depot/2394012/manifests/). +Si la variable d'environnement **TARGET_MANIFEST_ID** est définie, elle verrouillera la version +du serveur sur un manifeste spécifique. +Le manifeste correspond aux dates de sortie/mises à jour. Les manifestes peuvent être trouvés +à l'aide de SteamCMD ou de sites web comme [SteamDB](https://steamdb.info/depot/2394012/manifests/). ### Tableau des Versions Vers les ID de Manifeste From 1599de291a1ddb73bccd1e719fbabab613ba00f5 Mon Sep 17 00:00:00 2001 From: strawbang Date: Fri, 1 Mar 2024 19:32:16 +0100 Subject: [PATCH 3/4] fix the links --- docs/fr/README.md | 92 +++++++++++++++++++++++------------------------ 1 file changed, 46 insertions(+), 46 deletions(-) diff --git a/docs/fr/README.md b/docs/fr/README.md index f294cd543..5fcc92e0e 100644 --- a/docs/fr/README.md +++ b/docs/fr/README.md @@ -205,49 +205,49 @@ Il est fortement recommandé de définir les valeurs d'environnement suivantes a - PUID - PGID -| Variable | Info | Valeurs par défaut | Valeurs autorisées | -| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| TZ | Fuseau horaire utilisé pour dater la sauvegarde du serveur | UTC | Voir [Identifiants TZ](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#Time_Zone_abbreviations) | -| PLAYERS\* | Nombre maximal de joueurs pouvant rejoindre le serveur | 16 | 1-32 | -| PORT\* | Port UDP exposé par le serveur | 8211 | 1024-65535 | -| PUID\* | UID de l'utilisateur sous lequel le serveur doit s'exécuter | 1000 | !0 | -| PGID\* | GID du groupe sous lequel le serveur doit s'exécuter | 1000 | !0 | -| MULTITHREADING\*\* | Améliore les performances dans les environnements CPU multi-threadés. Elle est efficace jusqu'à un maximum d'environ 4 threads, et allouer plus que ce nombre de threads n'a pas beaucoup de sens. | false | true/false | -| COMMUNITY | Si le serveur apparaît ou non dans le navigateur de serveurs communautaires (À UTILISER AVEC SERVER_PASSWORD) | false | true/false | -| PUBLIC_IP | Vous pouvez spécifier manuellement l'adresse IP globale du réseau sur lequel le serveur est en cours d'exécution. Sinon, elle sera détectée automatiquement. Si cela ne fonctionne pas bien, essayez une configuration manuelle. | | x.x.x.x | -| PUBLIC_PORT | Vous pouvez spécifier manuellement le numéro de port du réseau sur lequel le serveur est en cours d'exécution. Sinon, il sera détecté automatiquement. Si cela ne fonctionne pas bien, essayez une configuration manuelle. | | 1024-65535 | -| SERVER_NAME | Un nom pour votre serveur | | "chaîne" | -| SERVER_DESCRIPTION | La description de votre serveur | | "chaîne" | -| SERVER_PASSWORD | Sécurisez votre serveur communautaire avec un mot de passe | | "chaîne" | -| ADMIN_PASSWORD | Sécurisez l'accès à l'administration du serveur avec un mot de passe | | "chaîne" | -| UPDATE_ON_BOOT\*\* | Mettre à jour/Installer le serveur lorsque le conteneur Docker démarre (CELÀ DOIT ÊTRE ACTIVÉ LA PREMIÈRE FOIS QUE VOUS EXÉCUTEZ LE CONTENEUR) | true | true/false | -| RCON_ENABLED\*\*\* | Activer RCON pour le serveur Palworld | true | true/false | -| RCON_PORT | Port RCON pour se connecter | 25575 | 1024-65535 | -| QUERY_PORT | Port de requête utilisé pour communiquer avec les serveurs Steam | 27015 | 1024-65535 | -| BACKUP_CRON_EXPRESSION | Le paramètre affecte la fréquence des sauvegardes automatiques. | 0 0 \* \* \* | Nécessite une expression Cron - Voir [Configuration des sauvegardes automatiques avec Cron](#configuring-automatic-backups-with-cron) | -| BACKUP_ENABLED | Active les sauvegardes automatiques | true | true/false | -| DELETE_OLD_BACKUPS | Supprime les sauvegardes après un certain nombre de jours | false | true/false | -| OLD_BACKUP_DAYS | Combien de jours conserver les sauvegardes | 30 | tout entier positif | -| AUTO_UPDATE_CRON_EXPRESSION | Le paramètre affecte la fréquence des mises à jour automatiques. | 0 \* \* \* \* | Nécessite une expression Cron - Voir [Configuration des sauvegardes automatiques avec Cron](#configuring-automatic-backups-with-cron) | -| AUTO_UPDATE_ENABLED | Active les mises à jour automatiques | false | true/false | -| AUTO_UPDATE_WARN_MINUTES | Temps d'attente avant de mettre à jour le serveur, après que les joueurs ont été informés. (Cela sera ignoré s'il n'y a pas de joueurs connectés) | 30 | Entier | -| AUTO_REBOOT_CRON_EXPRESSION | Le paramètre affecte la fréquence des mises à jour automatiques. | 0 0 \* \* \* | Nécessite une expression Cron - Voir [Configuration des sauvegardes automatiques avec Cron](#configuring-automatic-reboots-with-cron) | -| AUTO_REBOOT_ENABLED | Active les redémarrages automatiques | false | true/false | -| AUTO_REBOOT_WARN_MINUTES | Temps d'attente avant de redémarrer le serveur, après que les joueurs ont été informés. | 5 | Entier | -| AUTO_REBOOT_EVEN_IF_PLAYERS_ONLINE | Redémarrez le serveur même s'il y a des joueurs en ligne. | false | true/false | -| TARGET_MANIFEST_ID | Verrouille la version du jeu en correspondance avec l'ID de manifeste de Steam Download Depot. | | Voir [Tableau des ID de manifeste](#tableau-des-versions-vers-les-id-de-manifeste) | -| DISCORD_WEBHOOK_URL | URL du webhook Discord trouvée après la création d'un webhook sur un serveur Discord | | `https://discord.com/api/webhooks/` | -| DISCORD_CONNECT_TIMEOUT | Délai de connexion initial de la commande Discord | 30 | !0 | -| DISCORD_MAX_TIMEOUT | Délai total du webhook Discord | 30 | !0 | -| DISCORD_PRE_UPDATE_BOOT_MESSAGE | Message Discord envoyé lorsque le serveur commence à se mettre à jour | Le serveur est en cours de mise à jour... | "chaîne" | -| DISCORD_POST_UPDATE_BOOT_MESSAGE | Message Discord envoyé lorsque le serveur a terminé de se mettre à jour | Mise à jour du serveur terminée ! | "chaîne" | -| DISCORD_PRE_START_MESSAGE | Message Discord envoyé lorsque le serveur commence à démarrer | Le serveur est démarré ! | "chaîne" | -| DISCORD_PRE_SHUTDOWN_MESSAGE | Message Discord envoyé lorsque le serveur commence à s'arrêter | Le serveur est en cours d'arrêt... | "chaîne" | -| DISCORD_POST_SHUTDOWN_MESSAGE | Message Discord envoyé lorsque le serveur s'est arrêté | Le serveur est arrêté ! | "chaîne" | -| DISABLE_GENERATE_SETTINGS | S'il faut générer automatiquement le fichier PalWorldSettings.ini | false | true/false | -| DISABLE_GENERATE_ENGINE | S'il faut générer automatiquement le fichier Engine.ini | true | true/false | -| ENABLE_PLAYER_LOGGING | Active la journalisation et l'annonce des entrées et sorties de joueurs | true | true/false | -| PLAYER_LOGGING_POLL_PERIOD | Période de sondage (en secondes) pour vérifier les joueurs qui ont rejoint ou quitté | 5 | !0 | +| Variable | Info | Valeurs par défaut | Valeurs autorisées | +| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | +| TZ | Fuseau horaire utilisé pour dater la sauvegarde du serveur | UTC | Voir [Identifiants TZ](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#Time_Zone_abbreviations) | +| PLAYERS\* | Nombre maximal de joueurs pouvant rejoindre le serveur | 16 | 1-32 | +| PORT\* | Port UDP exposé par le serveur | 8211 | 1024-65535 | +| PUID\* | UID de l'utilisateur sous lequel le serveur doit s'exécuter | 1000 | !0 | +| PGID\* | GID du groupe sous lequel le serveur doit s'exécuter | 1000 | !0 | +| MULTITHREADING\*\* | Améliore les performances dans les environnements CPU multi-threadés. Elle est efficace jusqu'à un maximum d'environ 4 threads, et allouer plus que ce nombre de threads n'a pas beaucoup de sens. | false | true/false | +| COMMUNITY | Si le serveur apparaît ou non dans le navigateur de serveurs communautaires (À UTILISER AVEC SERVER_PASSWORD) | false | true/false | +| PUBLIC_IP | Vous pouvez spécifier manuellement l'adresse IP globale du réseau sur lequel le serveur est en cours d'exécution. Sinon, elle sera détectée automatiquement. Si cela ne fonctionne pas bien, essayez une configuration manuelle. | | x.x.x.x | +| PUBLIC_PORT | Vous pouvez spécifier manuellement le numéro de port du réseau sur lequel le serveur est en cours d'exécution. Sinon, il sera détecté automatiquement. Si cela ne fonctionne pas bien, essayez une configuration manuelle. | | 1024-65535 | +| SERVER_NAME | Un nom pour votre serveur | | "chaîne" | +| SERVER_DESCRIPTION | La description de votre serveur | | "chaîne" | +| SERVER_PASSWORD | Sécurisez votre serveur communautaire avec un mot de passe | | "chaîne" | +| ADMIN_PASSWORD | Sécurisez l'accès à l'administration du serveur avec un mot de passe | | "chaîne" | +| UPDATE_ON_BOOT\*\* | Mettre à jour/Installer le serveur lorsque le conteneur Docker démarre (CELÀ DOIT ÊTRE ACTIVÉ LA PREMIÈRE FOIS QUE VOUS EXÉCUTEZ LE CONTENEUR) | true | true/false | +| RCON_ENABLED\*\*\* | Activer RCON pour le serveur Palworld | true | true/false | +| RCON_PORT | Port RCON pour se connecter | 25575 | 1024-65535 | +| QUERY_PORT | Port de requête utilisé pour communiquer avec les serveurs Steam | 27015 | 1024-65535 | +| BACKUP_CRON_EXPRESSION | Le paramètre affecte la fréquence des sauvegardes automatiques. | 0 0 \* \* \* | Nécessite une expression Cron - Voir [Configuration des sauvegardes automatiques avec Cron](#configuration-des-sauvegardes-automatiques-avec-cron) | +| BACKUP_ENABLED | Active les sauvegardes automatiques | true | true/false | +| DELETE_OLD_BACKUPS | Supprime les sauvegardes après un certain nombre de jours | false | true/false | +| OLD_BACKUP_DAYS | Combien de jours conserver les sauvegardes | 30 | tout entier positif | +| AUTO_UPDATE_CRON_EXPRESSION | Le paramètre affecte la fréquence des mises à jour automatiques. | 0 \* \* \* \* | Nécessite une expression Cron - Voir [Configuration des sauvegardes automatiques avec Cron](#configuration-des-sauvegardes-automatiques-avec-cron) | +| AUTO_UPDATE_ENABLED | Active les mises à jour automatiques | false | true/false | +| AUTO_UPDATE_WARN_MINUTES | Temps d'attente avant de mettre à jour le serveur, après que les joueurs ont été informés. (Cela sera ignoré s'il n'y a pas de joueurs connectés) | 30 | Entier | +| AUTO_REBOOT_CRON_EXPRESSION | Le paramètre affecte la fréquence des mises à jour automatiques. | 0 0 \* \* \* | Nécessite une expression Cron - Voir [Configuration des sauvegardes automatiques avec Cron](#configuration-des-redémarrages-automatiques-avec-cron) | +| AUTO_REBOOT_ENABLED | Active les redémarrages automatiques | false | true/false | +| AUTO_REBOOT_WARN_MINUTES | Temps d'attente avant de redémarrer le serveur, après que les joueurs ont été informés. | 5 | Entier | +| AUTO_REBOOT_EVEN_IF_PLAYERS_ONLINE | Redémarrez le serveur même s'il y a des joueurs en ligne. | false | true/false | +| TARGET_MANIFEST_ID | Verrouille la version du jeu en correspondance avec l'ID de manifeste de Steam Download Depot. | | Voir [Tableau des ID de manifeste](#tableau-des-versions-vers-les-id-de-manifeste) | +| DISCORD_WEBHOOK_URL | URL du webhook Discord trouvée après la création d'un webhook sur un serveur Discord | | `https://discord.com/api/webhooks/` | +| DISCORD_CONNECT_TIMEOUT | Délai de connexion initial de la commande Discord | 30 | !0 | +| DISCORD_MAX_TIMEOUT | Délai total du webhook Discord | 30 | !0 | +| DISCORD_PRE_UPDATE_BOOT_MESSAGE | Message Discord envoyé lorsque le serveur commence à se mettre à jour | Le serveur est en cours de mise à jour... | "chaîne" | +| DISCORD_POST_UPDATE_BOOT_MESSAGE | Message Discord envoyé lorsque le serveur a terminé de se mettre à jour | Mise à jour du serveur terminée ! | "chaîne" | +| DISCORD_PRE_START_MESSAGE | Message Discord envoyé lorsque le serveur commence à démarrer | Le serveur est démarré ! | "chaîne" | +| DISCORD_PRE_SHUTDOWN_MESSAGE | Message Discord envoyé lorsque le serveur commence à s'arrêter | Le serveur est en cours d'arrêt... | "chaîne" | +| DISCORD_POST_SHUTDOWN_MESSAGE | Message Discord envoyé lorsque le serveur s'est arrêté | Le serveur est arrêté ! | "chaîne" | +| DISABLE_GENERATE_SETTINGS | S'il faut générer automatiquement le fichier PalWorldSettings.ini | false | true/false | +| DISABLE_GENERATE_ENGINE | S'il faut générer automatiquement le fichier Engine.ini | true | true/false | +| ENABLE_PLAYER_LOGGING | Active la journalisation et l'annonce des entrées et sorties de joueurs | true | true/false | +| PLAYER_LOGGING_POLL_PERIOD | Période de sondage (en secondes) pour vérifier les joueurs qui ont rejoint ou quitté | 5 | !0 | \* Hautement recommandé à définir @@ -323,7 +323,7 @@ La variable d'environnement `RCON_ENABLED` doit être définie sur `true` pour u > Si la redémarrage de Docker n'est pas configuré avec la politique `always` ou `unless-stopped` > le serveur s'éteindra et devra être redémarré manuellement. > -> La commande docker run exemple et le fichier docker-compose dans [Comment utiliser](#how-to-use) +> La commande docker run exemple et le fichier docker-compose dans [Comment utiliser](#comment-utiliser) > utilisent déjà la politique nécessaire ## Restauration manuelle à partir d'une sauvegarde @@ -384,7 +384,7 @@ suivantes **doivent** être définies sur `true`: > le serveur s'éteindra et devra être > redémarré manuellement. > -> La commande docker run exemple et le fichier docker-compose dans [Comment utiliser](#how-to-use) +> La commande docker run exemple et le fichier docker-compose dans [Comment utiliser](#comment-utiliser) > utilisent déjà la politique nécessaire Définissez AUTO_UPDATE_ENABLED pour activer ou désactiver les mises à jour automatiques (par défaut, c'est désactivé). @@ -409,7 +409,7 @@ Pour pouvoir utiliser les redémarrages automatiques avec ce serveur, RCON_ENABL > le serveur s'éteindra et devra être > redémarré manuellement. > -> La commande docker run exemple et le fichier docker-compose dans [Comment utiliser](#how-to-use) +> La commande docker run exemple et le fichier docker-compose dans [Comment utiliser](#comment-utiliser) > utilisent déjà la politique nécessaire Définissez AUTO_REBOOT_ENABLED pour activer ou désactiver les redémarrages automatiques (par défaut, c'est désactivé). From a27e385a1aeacdfd2520ce8c5b1b3e23731cb5c8 Mon Sep 17 00:00:00 2001 From: Thijs van Loef Date: Sat, 2 Mar 2024 13:48:45 +0100 Subject: [PATCH 4/4] revert original readme from main --- README.md | 275 +++++++++++++++++++++++++++--------------------------- 1 file changed, 137 insertions(+), 138 deletions(-) diff --git a/README.md b/README.md index 970e983c5..cf0b20e30 100644 --- a/README.md +++ b/README.md @@ -27,9 +27,9 @@ This is a Docker container to help you get started with hosting your own This Docker container has been tested and will work on the following OS: -- Linux (Ubuntu/Debian) -- Windows 10,11 -- MacOS (including Apple Silicon M1/M2/M3). +* Linux (Ubuntu/Debian) +* Windows 10,11 +* MacOS (including Apple Silicon M1/M2/M3). This container has also been tested and will work on both `x64` and `ARM64` based CPU architecture. @@ -53,7 +53,7 @@ Massive shoutout to the following sponsors! ## Server Requirements | Resource | Minimum | Recommended | -| -------- | ------- | ---------------------------------------- | +|----------|---------|------------------------------------------| | CPU | 4 cores | 4+ cores | | RAM | 16GB | Recommend over 32GB for stable operation | | Storage | 8GB | 20GB | @@ -68,30 +68,30 @@ This repository includes an example [docker-compose.yml](/docker-compose.yml) fi ```yml services: - palworld: - image: thijsvanloef/palworld-server-docker:latest - restart: unless-stopped - container_name: palworld-server - stop_grace_period: 30s # Set to however long you are willing to wait for the container to gracefully stop - ports: - - 8211:8211/udp - - 27015:27015/udp - environment: - PUID: 1000 - PGID: 1000 - PORT: 8211 # Optional but recommended - PLAYERS: 16 # Optional but recommended - SERVER_PASSWORD: 'worldofpals' # Optional but recommended - MULTITHREADING: true - RCON_ENABLED: true - RCON_PORT: 25575 - TZ: 'UTC' - ADMIN_PASSWORD: 'adminPasswordHere' - COMMUNITY: false # Enable this if you want your server to show up in the community servers tab, USE WITH SERVER_PASSWORD! - SERVER_NAME: 'palworld-server-docker by Thijs van Loef' - SERVER_DESCRIPTION: 'palworld-server-docker by Thijs van Loef' - volumes: - - ./palworld:/palworld/ + palworld: + image: thijsvanloef/palworld-server-docker:latest + restart: unless-stopped + container_name: palworld-server + stop_grace_period: 30s # Set to however long you are willing to wait for the container to gracefully stop + ports: + - 8211:8211/udp + - 27015:27015/udp + environment: + PUID: 1000 + PGID: 1000 + PORT: 8211 # Optional but recommended + PLAYERS: 16 # Optional but recommended + SERVER_PASSWORD: "worldofpals" # Optional but recommended + MULTITHREADING: true + RCON_ENABLED: true + RCON_PORT: 25575 + TZ: "UTC" + ADMIN_PASSWORD: "adminPasswordHere" + COMMUNITY: false # Enable this if you want your server to show up in the community servers tab, USE WITH SERVER_PASSWORD! + SERVER_NAME: "palworld-server-docker by Thijs van Loef" + SERVER_DESCRIPTION: "palworld-server-docker by Thijs van Loef" + volumes: + - ./palworld:/palworld/ ``` As an alternative, you can copy the [.env.example](.env.example) file to a new file called **.env** file. @@ -100,18 +100,18 @@ values. Modify your [docker-compose.yml](docker-compose.yml) to this: ```yml services: - palworld: - image: thijsvanloef/palworld-server-docker:latest - restart: unless-stopped - container_name: palworld-server - stop_grace_period: 30s # Set to however long you are willing to wait for the container to gracefully stop - ports: - - 8211:8211/udp - - 27015:27015/udp - env_file: - - .env - volumes: - - ./palworld:/palworld/ + palworld: + image: thijsvanloef/palworld-server-docker:latest + restart: unless-stopped + container_name: palworld-server + stop_grace_period: 30s # Set to however long you are willing to wait for the container to gracefully stop + ports: + - 8211:8211/udp + - 27015:27015/udp + env_file: + - .env + volumes: + - ./palworld:/palworld/ ``` ### Docker Run @@ -180,8 +180,8 @@ You must set user to `NUMBERICAL_UID:NUMBERICAL_GID` Below we assume your UID is 1000 and your GID is 1001 -- In docker run add `--user 1000:1001 \` above the last line. -- In docker compose add `user: 1000:1001` above ports. +* In docker run add `--user 1000:1001 \` above the last line. +* In docker compose add `user: 1000:1001` above ports. If you wish to run it with a different UID/GID than your own you will need to change the ownership of the directory that is being bind: `chown UID:GID palworld/` @@ -196,19 +196,19 @@ The official helm chart can be found in a seperate repository, [palworld-server- You can use the following values to change the settings of the server on boot. It is highly recommended you set the following environment values before starting the server: -- PLAYERS -- PORT -- PUID -- PGID +* PLAYERS +* PORT +* PUID +* PGID | 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 | +| 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 | @@ -216,8 +216,8 @@ 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_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 | | 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) | @@ -226,12 +226,12 @@ It is highly recommended you set the following environment values before startin | OLD_BACKUP_DAYS | How many days to keep backups | 30 | any positive integer | | 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) | | AUTO_UPDATE_ENABLED | Enables automatic updates | false | true/false | -| 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 | +| 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 | | 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) | | AUTO_REBOOT_ENABLED | Enables automatic reboots | false | true/false | -| AUTO_REBOOT_WARN_MINUTES | How long to wait to reboot the server, after the player were informed. | 5 | Integer | +| AUTO_REBOOT_WARN_MINUTES | How long to wait to reboot the server, after the player were informed. | 5 | Integer | | AUTO_REBOOT_EVEN_IF_PLAYERS_ONLINE | Restart the Server even if there are players online. | false | true/false | -| TARGET_MANIFEST_ID | Locks game version to corespond with Manifest ID from Steam Download Depot. | | See [Manifest ID Table](#locking-specific-game-version) | +| TARGET_MANIFEST_ID | Locks game version to corespond with Manifest ID from Steam Download Depot. | | See [Manifest ID Table](#locking-specific-game-version) | | DISCORD_WEBHOOK_URL | Discord webhook url found after creating a webhook on a discord server | | `https://discord.com/api/webhooks/` | | DISCORD_CONNECT_TIMEOUT | Discord command initial connection timeout | 30 | !0 | | DISCORD_MAX_TIMEOUT | Discord total hook timeout | 30 | !0 | @@ -246,16 +246,16 @@ It is highly recommended you set the following environment values before startin | PLAYER_LOGGING_POLL_PERIOD | Polling period (in seconds) to check for players who have joined or left | 5 | !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 | -\*highly recommended to set +*highly recommended to set -\*\* Make sure you know what you are doing when running this option enabled +** Make sure you know what you are doing when running this option enabled -\*\*\* Required for docker stop to save and gracefully close the server +*** Required for docker stop to save and gracefully close the server ### Game Ports | Port | Info | -| ----- | ---------------- | +|-------|------------------| | 8211 | Game Port (UDP) | | 27015 | Query Port (UDP) | | 25575 | RCON Port (TCP) | @@ -280,7 +280,7 @@ This will open a CLI that uses RCON to write commands to the Palworld Server. ### List of server commands | Command | Info | -| -------------------------------- | --------------------------------------------------- | +|----------------------------------|-----------------------------------------------------| | Shutdown {Seconds} {MessageText} | The server is shut down after the number of Seconds | | DoExit | Force stop the server. | | Broadcast | Send message to all player in the server | @@ -315,7 +315,6 @@ docker exec -it palworld-server restore ``` The `RCON_ENABLED` environment variable must be set to `true` to use this command. - > [!IMPORTANT] > If docker restart is not set to policy `always` or `unless-stopped` then the server will shutdown and will need to be > manually restarted. @@ -368,8 +367,8 @@ Example Usage: If BACKUP_CRON_EXPRESSION to `0 2 * * *`, the backup script will To be able to use automatic Updates with this Server the following environment variables **have** to be set to `true`: -- RCON_ENABLED -- UPDATE_ON_BOOT +* RCON_ENABLED +* UPDATE_ON_BOOT > [!IMPORTANT] > @@ -425,72 +424,72 @@ timezone set with TZ Converting server settings to environment variables follow the same principles (with some exceptions): -- all capital letters -- split words by inserting an underscore -- remove the single letter if the setting starts with one (like 'b') +* all capital letters +* split words by inserting an underscore +* remove the single letter if the setting starts with one (like 'b') For example: -- Difficulty -> DIFFICULTY -- PalSpawnNumRate -> PAL_SPAWN_NUM_RATE -- bIsPvP -> IS_PVP - -| Variable | Description | Default Value | Allowed Value | -| ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------- | -| DIFFICULTY | Game Difficulty | None | `None`,`Normal`,`Difficult` | -| DAYTIME_SPEEDRATE | Day time speed - Larger number means shorter days | 1.000000 | Float | -| NIGHTTIME_SPEEDRATE | Night time speed - Larger number means shorter nights | 1.000000 | Float | -| EXP_RATE | EXP earn rate | 1.000000 | Float | -| PAL_CAPTURE_RATE | Pal capture rate | 1.000000 | Float | -| PAL_SPAWN_NUM_RATE | Pal appearance rate | 1.000000 | Float | -| PAL_DAMAGE_RATE_ATTACK | Damage from pals multipiler | 1.000000 | Float | -| PAL_DAMAGE_RATE_DEFENSE | Damage to pals multipiler | 1.000000 | Float | -| PLAYER_DAMAGE_RATE_ATTACK | Damage from player multipiler | 1.000000 | Float | -| PLAYER_DAMAGE_RATE_DEFENSE | Damage to player multipiler | 1.000000 | Float | -| PLAYER_STOMACH_DECREASE_RATE | Player hunger depletion rate | 1.000000 | Float | -| PLAYER_STAMINA_DECREASE_RATE | Player stamina reduction rate | 1.000000 | Float | -| PLAYER_AUTO_HP_REGEN_RATE | Player auto HP regeneration rate | 1.000000 | Float | -| PLAYER_AUTO_HP_REGEN_RATE_IN_SLEEP | Player sleep HP regeneration rate | 1.000000 | Float | -| PAL_STOMACH_DECREASE_RATE | Pal hunger depletion rate | 1.000000 | Float | -| PAL_STAMINA_DECREASE_RATE | Pal stamina reduction rate | 1.000000 | Float | -| PAL_AUTO_HP_REGEN_RATE | Pal auto HP regeneration rate | 1.000000 | Float | -| PAL_AUTO_HP_REGEN_RATE_IN_SLEEP | Pal sleep health regeneration rate (in Palbox) | 1.000000 | Float | -| BUILD_OBJECT_DAMAGE_RATE | Damage to structure multipiler | 1.000000 | Float | -| BUILD_OBJECT_DETERIORATION_DAMAGE_RATE | Structure determination rate | 1.000000 | Float | -| COLLECTION_DROP_RATE | Getherable items multipiler | 1.000000 | Float | -| COLLECTION_OBJECT_HP_RATE | Getherable objects HP multipiler | 1.000000 | Float | -| COLLECTION_OBJECT_RESPAWN_SPEED_RATE | Getherable objects respawn interval - The smaller the number, the faster the regeneration | 1.000000 | Float | -| ENEMY_DROP_ITEM_RATE | Dropped Items Multipiler | 1.000000 | Float | -| DEATH_PENALTY | Death Penalty
None: No death penalty
Item: Drops items other than equipment
ItemAndEquipment: Drops all items
All: Drops all PALs and all items. | All | `None`,`Item`,`ItemAndEquipment`,`All` | -| ENABLE_PLAYER_TO_PLAYER_DAMAGE | Allows players to cause damage to players | False | Boolean | -| ENABLE_FRIENDLY_FIRE | Allow friendly fire | False | Boolean | -| ENABLE_INVADER_ENEMY | Enable invaders | True | Boolean | -| ACTIVE_UNKO | Enable UNKO (?) | False | Boolean | -| ENABLE_AIM_ASSIST_PAD | Enable controller aim assist | True | Boolean | -| ENABLE_AIM_ASSIST_KEYBOARD | Enable Keyboard aim assist | False | Boolean | -| DROP_ITEM_MAX_NUM | Maximum number of drops in the world | 3000 | Integer | -| DROP_ITEM_MAX_NUM_UNKO | Maximum number of UNKO drops in the world | 100 | Integer | -| BASE_CAMP_MAX_NUM | Maximum number of base camps | 128 | Integer | -| BASE_CAMP_WORKER_MAX_NUM | Maximum number of workers | 15 | Integer | -| DROP_ITEM_ALIVE_MAX_HOURS | Time it takes for items to despawn in hours | 1.000000 | Float | -| 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 | -| PAL_EGG_DEFAULT_HATCHING_TIME | Time(h) to incubate massive egg | 72.000000 | Float | -| WORK_SPEED_RATE | Work speed muliplier | 1.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 | -| ENABLE_NON_LOGIN_PENALTY | Enable non-login penalty | True | Boolean | -| ENABLE_FAST_TRAVEL | Enable fast travel | True | Boolean | -| 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 | -| COOP_PLAYER_MAX_NUM | Maximum number of players in a guild | 4 | Integer | -| REGION | Region | | String | -| USEAUTH | Use authentication | True | Boolean | -| BAN_LIST_URL | Which ban list to use | [https://api.palworldgame.com/api/banlist.txt](https://api.palworldgame.com/api/banlist.txt) | string | -| SHOW_PLAYER_LIST | Enable show player list | True | Boolean | +* Difficulty -> DIFFICULTY +* PalSpawnNumRate -> PAL_SPAWN_NUM_RATE +* bIsPvP -> IS_PVP + +| Variable | Description | Default Value | Allowed Value | +|-------------------------------------------|----------------------------------------------------------------|----------------------------------------------------------------------------------------------|----------------------------------------| +| DIFFICULTY | Game Difficulty | None | `None`,`Normal`,`Difficult` | +| DAYTIME_SPEEDRATE | Day time speed - Larger number means shorter days | 1.000000 | Float | +| NIGHTTIME_SPEEDRATE | Night time speed - Larger number means shorter nights | 1.000000 | Float | +| EXP_RATE | EXP earn rate | 1.000000 | Float | +| PAL_CAPTURE_RATE | Pal capture rate | 1.000000 | Float | +| PAL_SPAWN_NUM_RATE | Pal appearance rate | 1.000000 | Float | +| PAL_DAMAGE_RATE_ATTACK | Damage from pals multipiler | 1.000000 | Float | +| PAL_DAMAGE_RATE_DEFENSE | Damage to pals multipiler | 1.000000 | Float | +| PLAYER_DAMAGE_RATE_ATTACK | Damage from player multipiler | 1.000000 | Float | +| PLAYER_DAMAGE_RATE_DEFENSE | Damage to player multipiler | 1.000000 | Float | +| PLAYER_STOMACH_DECREASE_RATE | Player hunger depletion rate | 1.000000 | Float | +| PLAYER_STAMINA_DECREASE_RATE | Player stamina reduction rate | 1.000000 | Float | +| PLAYER_AUTO_HP_REGEN_RATE | Player auto HP regeneration rate | 1.000000 | Float | +| PLAYER_AUTO_HP_REGEN_RATE_IN_SLEEP | Player sleep HP regeneration rate | 1.000000 | Float | +| PAL_STOMACH_DECREASE_RATE | Pal hunger depletion rate | 1.000000 | Float | +| PAL_STAMINA_DECREASE_RATE | Pal stamina reduction rate | 1.000000 | Float | +| PAL_AUTO_HP_REGEN_RATE | Pal auto HP regeneration rate | 1.000000 | Float | +| PAL_AUTO_HP_REGEN_RATE_IN_SLEEP | Pal sleep health regeneration rate (in Palbox) | 1.000000 | Float | +| BUILD_OBJECT_DAMAGE_RATE | Damage to structure multipiler | 1.000000 | Float | +| BUILD_OBJECT_DETERIORATION_DAMAGE_RATE | Structure determination rate | 1.000000 | Float | +| COLLECTION_DROP_RATE | Getherable items multipiler | 1.000000 | Float | +| COLLECTION_OBJECT_HP_RATE | Getherable objects HP multipiler | 1.000000 | Float | +| COLLECTION_OBJECT_RESPAWN_SPEED_RATE | Getherable objects respawn interval - The smaller the number, the faster the regeneration | 1.000000 | Float | +| ENEMY_DROP_ITEM_RATE | Dropped Items Multipiler | 1.000000 | Float | +| DEATH_PENALTY | Death Penalty
None: No death penalty
Item: Drops items other than equipment
ItemAndEquipment: Drops all items
All: Drops all PALs and all items. | All | `None`,`Item`,`ItemAndEquipment`,`All` | +| ENABLE_PLAYER_TO_PLAYER_DAMAGE | Allows players to cause damage to players | False | Boolean | +| ENABLE_FRIENDLY_FIRE | Allow friendly fire | False | Boolean | +| ENABLE_INVADER_ENEMY | Enable invaders | True | Boolean | +| ACTIVE_UNKO | Enable UNKO (?) | False | Boolean | +| ENABLE_AIM_ASSIST_PAD | Enable controller aim assist | True | Boolean | +| ENABLE_AIM_ASSIST_KEYBOARD | Enable Keyboard aim assist | False | Boolean | +| DROP_ITEM_MAX_NUM | Maximum number of drops in the world | 3000 | Integer | +| DROP_ITEM_MAX_NUM_UNKO | Maximum number of UNKO drops in the world | 100 | Integer | +| BASE_CAMP_MAX_NUM | Maximum number of base camps | 128 | Integer | +| BASE_CAMP_WORKER_MAX_NUM | Maximum number of workers | 15 | Integer | +| DROP_ITEM_ALIVE_MAX_HOURS | Time it takes for items to despawn in hours | 1.000000 | Float | +| 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 | +| PAL_EGG_DEFAULT_HATCHING_TIME | Time(h) to incubate massive egg | 72.000000 | Float | +| WORK_SPEED_RATE | Work speed muliplier | 1.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 | +| ENABLE_NON_LOGIN_PENALTY | Enable non-login penalty | True | Boolean | +| ENABLE_FAST_TRAVEL | Enable fast travel | True | Boolean | +| 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 | +| COOP_PLAYER_MAX_NUM | Maximum number of players in a guild | 4 | Integer | +| REGION | Region | | String | +| USEAUTH | Use authentication | True | Boolean | +| BAN_LIST_URL | Which ban list to use | [https://api.palworldgame.com/api/banlist.txt](https://api.palworldgame.com/api/banlist.txt) | string | +| SHOW_PLAYER_LIST | Enable show player list | True | Boolean | ### Manually @@ -529,23 +528,23 @@ send discord messages with docker compose: ## Locking Specific Game Version -> [!WARNING] -> Downgrading to a lower game version is possible, but it is unknown what impact it will have on existing saves. +>[!WARNING] +>Downgrading to a lower game version is possible, but it is unknown what impact it will have on existing saves. > -> **Please do so at your own risk!** +>**Please do so at your own risk!** If **TARGET_MANIFEST_ID** environment variable is set, will lock server version to specific manifest. The manifest corresponds to the release date/update versions. Manifests can be found using SteamCMD or websites like [SteamDB](https://steamdb.info/depot/2394012/manifests/). ### Version To Manifest ID Table -| Version | Manifest ID | -| ------- | ------------------- | -| 1.3.0 | 1354752814336157338 | -| 1.4.0 | 4190579964382773830 | -| 1.4.1 | 6370735655629434989 | -| 1.5.0 | 3750364703337203431 | -| 1.5.1 | 2815085007637542021 | +| Version | Manifest ID | +|---------|----------------------| +| 1.3.0 | 1354752814336157338 | +| 1.4.0 | 4190579964382773830 | +| 1.4.1 | 6370735655629434989 | +| 1.5.0 | 3750364703337203431 | +| 1.5.1 | 2815085007637542021 | ## Reporting Issues/Feature Requests