{"id":13467982,"url":"https://github.com/thijsvanloef/palworld-server-docker","last_synced_at":"2026-04-01T21:50:37.130Z","repository":{"id":218068786,"uuid":"745388807","full_name":"thijsvanloef/palworld-server-docker","owner":"thijsvanloef","description":"A Docker Container to easily run a Palworld dedicated server.","archived":false,"fork":false,"pushed_at":"2026-03-22T18:36:48.000Z","size":4040,"stargazers_count":2784,"open_issues_count":8,"forks_count":321,"subscribers_count":17,"default_branch":"main","last_synced_at":"2026-03-27T13:45:03.072Z","etag":null,"topics":["dedicated-gameservers","dedicated-server","docker","palworld","palworld-dedicated-server","palworld-server-docker","steamcmd"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/thijsvanloef/palworld-server-docker","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thijsvanloef.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"thijsvanloef","ko_fi":"thijsvanloef"}},"created_at":"2024-01-19T08:24:38.000Z","updated_at":"2026-03-24T07:58:28.000Z","dependencies_parsed_at":"2025-11-30T07:05:01.605Z","dependency_job_id":null,"html_url":"https://github.com/thijsvanloef/palworld-server-docker","commit_stats":null,"previous_names":["thijsvanloef/palworld-server-docker"],"tags_count":81,"template":false,"template_full_name":null,"purl":"pkg:github/thijsvanloef/palworld-server-docker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thijsvanloef%2Fpalworld-server-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thijsvanloef%2Fpalworld-server-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thijsvanloef%2Fpalworld-server-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thijsvanloef%2Fpalworld-server-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thijsvanloef","download_url":"https://codeload.github.com/thijsvanloef/palworld-server-docker/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thijsvanloef%2Fpalworld-server-docker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31046926,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-27T09:35:52.079Z","status":"ssl_error","status_checked_at":"2026-03-27T09:35:20.916Z","response_time":164,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dedicated-gameservers","dedicated-server","docker","palworld","palworld-dedicated-server","palworld-server-docker","steamcmd"],"created_at":"2024-07-31T15:01:03.639Z","updated_at":"2026-04-01T21:50:37.115Z","avatar_url":"https://github.com/thijsvanloef.png","language":"Shell","funding_links":["https://github.com/sponsors/thijsvanloef","https://ko-fi.com/thijsvanloef"],"categories":["Shell","DevOps"],"sub_categories":[],"readme":"# Palworld Dedicated Server Docker\n\n[![Release](https://img.shields.io/github/v/release/thijsvanloef/palworld-server-docker)](https://github.com/thijsvanloef/palworld-server-docker/releases)\n[![Docker Pulls](https://img.shields.io/docker/pulls/thijsvanloef/palworld-server-docker)](https://hub.docker.com/r/thijsvanloef/palworld-server-docker)\n[![Docker Stars](https://img.shields.io/docker/stars/thijsvanloef/palworld-server-docker)](https://hub.docker.com/r/thijsvanloef/palworld-server-docker)\n[![Image Size](https://img.shields.io/docker/image-size/thijsvanloef/palworld-server-docker/latest)](https://hub.docker.com/r/thijsvanloef/palworld-server-docker/tags)\n[![Discord](https://img.shields.io/discord/1200397673329594459?logo=discord\u0026label=Discord\u0026link=https%3A%2F%2Fdiscord.gg%2FUxBxStPAAE)](https://discord.com/invite/UxBxStPAAE)\n\n[![CodeFactor](https://www.codefactor.io/repository/github/thijsvanloef/palworld-server-docker/badge)](https://www.codefactor.io/repository/github/thijsvanloef/palworld-server-docker)\n[![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)\n[![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)\n[![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)\n\n[![Docker Hub](https://img.shields.io/badge/Docker_Hub-palworld-blue?logo=docker)](https://hub.docker.com/r/thijsvanloef/palworld-server-docker)\n[![GHCR](https://img.shields.io/badge/GHCR-palworld-blue?logo=docker)](https://github.com/thijsvanloef/palworld-server-docker/pkgs/container/palworld-server-docker)\n[![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)\n\n[Chat with the community on Discord](https://discord.gg/UxBxStPAAE)\n\nThis is a Docker container to help you get started with hosting your own\n[Palworld](https://store.steampowered.com/app/1623730/Palworld/) dedicated server.\n\nThis Docker container has been tested and will work on the following OS:\n\n* Linux (Ubuntu/Debian)\n* Windows 10,11\n* MacOS (including Apple Silicon M1/M2/M3).\n* Raspberry Pi 4/5\n\nThis container has also been tested and will work on both `x64` and `ARM64` based CPU architecture.\n\n\u003e [!IMPORTANT]\n\u003e Get up and running in no time with the [Quickstart Guide](https://palworld-server-docker.loef.dev/)!\n\n## Sponsors\n\n| Company                                                                                                                                                                                                                                                                                                                       | About                                                                                                                                                                                                                                            |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| \u003c!-- markdownlint-disable-line --\u003e\u003ca href=\"https://indifferentbroccoli.com/palworld-server-hosting\"\u003e\u003cimg src=\"https://github.com/thijsvanloef/palworld-server-docker/assets/58031337/f091b205-d6be-49fe-a508-4a23087023a1\" width=\"150px\" alt=\"Indifferent Broccoli\" /\u003e\u003c/a\u003e\u003cp align=\"center\"\u003eindifferent broccoli \\(\\:\\|\\)\u003c/p\u003e | Thank you to our sponsor indifferent broccoli. If you decide to rent a Palworld server, rather than host yourself, try indifferent broccoli's [Palword server hosting](https://indifferentbroccoli.com/palworld-server-hosting) 2-day free trial |\n\n### Massive shoutout to the following individual sponsors\n\n\u003cp align=\"left\"\u003e\u003c!-- markdownlint-disable-line --\u003e\u003c!-- markdownlint-disable-next-line --\u003e\n\u003c!-- sponsors --\u003e\u003ca href=\"https://github.com/AshishT112203\"\u003e\u003cimg src=\"https://github.com/AshishT112203.png\" width=\"50px\" alt=\"AshishT112203\" /\u003e\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u003ca href=\"https://github.com/indifferentbroc\"\u003e\u003cimg src=\"https://github.com/indifferentbroc.png\" width=\"50px\" alt=\"indifferentbroc\" /\u003e\u003c/a\u003e\u0026nbsp;\u0026nbsp;\u003c!-- sponsors --\u003e\n\u003c/p\u003e\n\n## Official Documentation\n\n[![Documentation](https://github.com/thijsvanloef/palworld-server-docker/assets/58031337/b92d76d1-5efb-438d-9ffd-5385544a831b)](https://palworld-server-docker.loef.dev/)\n\n## Server Requirements\n\n| Resource | Minimum | Recommended                              |\n|----------|---------|------------------------------------------|\n| CPU      | 4 cores | 4+ cores                                 |\n| RAM      | 16GB    | Recommend over 32GB for stable operation |\n| Storage  | 8GB     | 20GB                                     |\n\n## How to use\n\nKeep in mind that you'll need to change the [environment variables](#environment-variables).\n\n### Docker Compose\n\nThis repository includes an example [docker-compose.yml](/docker-compose.yml) file you can use to set up your server.\n\n```yml\nservices:\n   palworld:\n      image: thijsvanloef/palworld-server-docker:latest\n      restart: unless-stopped\n      container_name: palworld-server\n      stop_grace_period: 30s # Set to however long you are willing to wait for the container to gracefully stop\n      ports:\n        - 8211:8211/udp\n        - 27015:27015/udp\n        - 8212:8212/tcp  # REST API enabled port, enabled by default. DO NOT PORT FORWARD THIS.\n      environment:\n         PUID: 1000\n         PGID: 1000\n         PORT: 8211 # Optional but recommended\n         PLAYERS: 16 # Optional but recommended\n         SERVER_PASSWORD: \"worldofpals\" # Optional but recommended\n         MULTITHREADING: true\n         REST_API_ENABLED: true\n         REST_API_PORT: 8212\n         TZ: \"UTC\"\n         ADMIN_PASSWORD: \"adminPasswordHere\"\n         COMMUNITY: false  # Enable this if you want your server to show up in the community servers tab, USE WITH SERVER_PASSWORD!\n         SERVER_NAME: \"palworld-server-docker by Thijs van Loef\"\n         SERVER_DESCRIPTION: \"palworld-server-docker by Thijs van Loef\"\n         CROSSPLAY_PLATFORMS: \"(Steam,Xbox,PS5,Mac)\"\n      volumes:\n         - ./palworld:/palworld/\n```\n\nAs an alternative, you can copy the [.env.example](.env.example) file to a new file called **.env** file.\nModify it to your needs, check out the [environment variables](#environment-variables) section to check the correct\nvalues. Modify your [docker-compose.yml](docker-compose.yml) to this:\n\n```yml\nservices:\n   palworld:\n      image: thijsvanloef/palworld-server-docker:latest\n      restart: unless-stopped\n      container_name: palworld-server\n      stop_grace_period: 30s # Set to however long you are willing to wait for the container to gracefully stop\n      ports:\n        - 8211:8211/udp\n        - 27015:27015/udp\n        # - 8212:8212/tcp  # Port for REST API if REST_API_ENABLED: true\n      env_file:\n         -  .env\n      volumes:\n         - ./palworld:/palworld/\n```\n\n### Docker Run\n\nChange every \u003c\u003e to your own configuration\n\n```bash\ndocker run -d \\\n    --name palworld-server \\\n    -p 8211:8211/udp \\\n    -p 27015:27015/udp \\\n    -v ./palworld:/palworld/ \\\n    -e PUID=1000 \\\n    -e PGID=1000 \\\n    -e PORT=8211 \\\n    -e PLAYERS=16 \\\n    -e MULTITHREADING=true \\\n    -e REST_API_ENABLED=true \\\n    -e REST_API_PORT=8212 \\\n    -e TZ=UTC \\\n    -e ADMIN_PASSWORD=\"adminPasswordHere\" \\\n    -e SERVER_PASSWORD=\"worldofpals\" \\\n    -e COMMUNITY=false \\\n    -e SERVER_NAME=\"palworld-server-docker by Thijs van Loef\" \\\n    -e SERVER_DESCRIPTION=\"palworld-server-docker by Thijs van Loef\" \\\n    -e CROSSPLAY_PLATFORMS=\"(Steam,Xbox,PS5,Mac)\" \\\n    --restart unless-stopped \\\n    --stop-timeout 30 \\\n    thijsvanloef/palworld-server-docker:latest\n```\n\nAs an alternative, you can copy the [.env.example](.env.example) file to a new file called **.env** file.\nModify it to your needs, check out the [environment variables](#environment-variables) section to check the\ncorrect values. Change your docker run command to this:\n\n```bash\ndocker run -d \\\n    --name palworld-server \\\n    -p 8211:8211/udp \\\n    -p 27015:27015/udp \\\n    -v ./palworld:/palworld/ \\\n    --env-file .env \\\n    --restart unless-stopped \\\n    --stop-timeout 30 \\\n    thijsvanloef/palworld-server-docker:latest\n```\n\n### Kubernetes\n\nAll files you will need to deploy this container to kubernetes are located in the [kubernetes folder](kubernetes/).\n\nFollow the steps in the [README.md here](kubernetes/readme.md) to deploy it.\n\n### Running without root\n\nThis is only for advanced users\n\nIt is possible to run this container and\n[override the default user](https://docs.docker.com/engine/reference/run/#user) which is root in this image.\n\nBecause you are specifiying the user and group `PUID` and `PGID` are ignored.\n\nIf you want to find your UID: `id -u`\nIf you want to find your GID: `id -g`\n\nYou must set user to `NUMBERICAL_UID:NUMBERICAL_GID`\n\nBelow we assume your UID is 1000 and your GID is 1001\n\n* In docker run add `--user 1000:1001 \\` above the last line.\n* In docker compose add `user: 1000:1001` above ports.\n\nIf you wish to run it with a different UID/GID than your own you will need to change the ownership of the directory that\nis being bind: `chown UID:GID palworld/`\nor by changing the permissions for all other: `chmod o=rwx palworld/`\n\n#### Using helm chart\n\nThe official helm chart can be found in a seperate repository, [palworld-server-chart](https://github.com/Twinki14/palworld-server-chart)\n\n### Environment variables\n\nYou can use the following values to change the settings of the server on boot.\nIt is highly recommended you set the following environment values before starting the server:\n\n* PLAYERS\n* PORT\n* PUID\n* PGID\n\n| Variable                                   | Info                                                                                                                                                                                                | Default Values                                                                                     | Allowed Values                                                                                                    | Added in Version |\n|--------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|------------------|\n| TZ                                         | Timezone used for time stamping backup server                                                                                                                                                       | UTC                                                                                                | See [TZ Identifiers](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#Time_Zone_abbreviations)        | 0.1.0            |\n| PLAYERS*                                   | Max amount of players that are able to join the server                                                                                                                                              | 16                                                                                                 | 1-32                                                                                                              | 0.1.0            |\n| PORT*                                      | UDP port that the server will expose                                                                                                                                                                | 8211                                                                                               | 1024-65535                                                                                                        | 0.1.0            |\n| PUID*                                      | The uid of the user the server should run as                                                                                                                                                        | 1000                                                                                               | !0                                                                                                                | 0.6.0            |\n| PGID*                                      | The gid of the group the server should run as                                                                                                                                                       | 1000                                                                                               | !0                                                                                                                | 0.6.0            |\n| MULTITHREADING**                           | Improves performance in multi-threaded CPU environments. It is effective up to a maximum of about 4 threads, and allocating more than this number of threads does not make much sense.              | false                                                                                              | true/false                                                                                                        | 0.1.0            |\n| COMMUNITY                                  | Whether or not the server shows up in the community server browser (USE WITH SERVER_PASSWORD)                                                                                                       | false                                                                                              | true/false                                                                                                        | 0.1.0            |\n| PUBLIC_IP                                  | You can manually specify the global IP address of the network on which the server running. If not specified, it will be detected automatically. If it does not work well, try manual configuration. |                                                                                                    | x.x.x.x                                                                                                           | 0.1.0            |\n| PUBLIC_PORT                                | You can manually specify the port number of the network on which the server running. If not specified, it will be detected automatically. If it does not work well, try manual configuration.       |                                                                                                    | 1024-65535                                                                                                        | 0.1.0            |\n| SERVER_NAME                                | A name for your server                                                                                                                                                                              |                                                                                                    | \"string\"                                                                                                          | 0.1.0            |\n| SERVER_DESCRIPTION                         | Your server Description                                                                                                                                                                             |                                                                                                    | \"string\"                                                                                                          | 0.1.0            |\n| SERVER_PASSWORD                            | Secure your community server with a password                                                                                                                                                        |                                                                                                    | \"string\"                                                                                                          | 0.1.0            |\n| ADMIN_PASSWORD                             | Secure administration access in the server with a password                                                                                                                                          |                                                                                                    | \"string\"                                                                                                          | 0.4.0            |\n| UPDATE_ON_BOOT**                           | Update/Install the server when the docker container starts (THIS HAS TO BE ENABLED THE FIRST TIME YOU RUN THE CONTAINER)                                                                            | true                                                                                               | true/false                                                                                                        | 0.3.0            |\n| RCON_ENABLED***                            | Enable RCON for the Palworld server                                                                                                                                                                 | false                                                                                              | true/false                                                                                                        | 0.1.0            |\n| RCON_PORT                                  | RCON port to connect to                                                                                                                                                                             | 25575                                                                                              | 1024-65535                                                                                                        | 0.1.0            |\n| REST_API_ENABLED                           | Enable REST API for the palworld server                                                                                                                                                             | true                                                                                              | true/false                                                                                                        | 0.35.0           |\n| REST_API_PORT                              | REST API port to connect to                                                                                                                                                                         | 8212                                                                                               | 1024-65535                                                                                                        | 0.35.0           |\n| QUERY_PORT                                 | Query port used to communicate with Steam servers                                                                                                                                                   | 27015                                                                                              | 1024-65535                                                                                                        | 0.1.0            |\n| ALLOW_CONNECT_PLATFORM `DEPRECATED`                    | Specify if you are hosting a dedicated server for Steam or Xbox players                                                                                                                             | Steam                                                                                              | Steam/Xbox                                                                                                        | 0.38.0           |\n| BACKUP_CRON_EXPRESSION                     | Setting affects frequency of automatic backups.                                                                                                                                                     | 0 0 \\* \\* \\*                                                                                       | Needs a Cron-Expression - See [Configuring Automatic Backups with Cron](#configuring-automatic-backups-with-cron) | 0.19.0           |\n| BACKUP_ENABLED                             | Enables automatic backups                                                                                                                                                                           | true                                                                                               | true/false                                                                                                        | 0.19.0           |\n| USE_BACKUP_SAVE_DATA                       | Enables native automatic backups                                                                                                                                                                    | true                                                                                               | true/false                                                                                                        | 0.35.0           |\n| DELETE_OLD_BACKUPS                         | Delete backups after a certain number of days                                                                                                                                                       | false                                                                                              | true/false                                                                                                        | 0.19.0           |\n| OLD_BACKUP_DAYS                            | How many days to keep backups                                                                                                                                                                       | 30                                                                                                 | any positive integer                                                                                              | 0.19.0           |\n| AUTO_UPDATE_CRON_EXPRESSION                | Setting affects frequency of automatic updates.                                                                                                                                                     | 0 \\* \\* \\* \\*                                                                                      | Needs a Cron-Expression - See [Configuring Automatic Backups with Cron](#configuring-automatic-backups-with-cron) | 0.20.0           |\n| AUTO_UPDATE_ENABLED                        | Enables automatic updates                                                                                                                                                                           | false                                                                                              | true/false                                                                                                        | 0.20.0           |\n| AUTO_UPDATE_WARN_MINUTES                   | How long to wait to update the server, after the player were informed. (This will be ignored, if no Players are connected)                                                                          | 30                                                                                                 | Integer                                                                                                           | 0.20.0           |\n| AUTO_REBOOT_CRON_EXPRESSION                | Setting affects frequency of automatic updates.                                                                                                                                                     | 0 0 \\* \\* \\*                                                                                       | Needs a Cron-Expression - See [Configuring Automatic Backups with Cron](#configuring-automatic-reboots-with-cron) | 0.21.0           |\n| AUTO_REBOOT_ENABLED                        | Enables automatic reboots                                                                                                                                                                           | false                                                                                              | true/false                                                                                                        | 0.21.0           |\n| AUTO_REBOOT_WARN_MINUTES                   | How long to wait to reboot the server, after the player were informed.                                                                                                                              | 5                                                                                                  | Integer                                                                                                           | 0.21.0           |\n| AUTO_REBOOT_EVEN_IF_PLAYERS_ONLINE         | Restart the Server even if there are players online.                                                                                                                                                | false                                                                                              | true/false                                                                                                        | 0.21.0           |\n| AUTO_PAUSE_ENABLED                         | Enables automatic pause (with ENABLE_PLAYER_LOGGING=true and REST_API_ENABLED=true required.)                                                                                                                                 | false                                                                                              | true/false                                                                                                        | 1.4.0           |\n| AUTO_PAUSE_TIMEOUT_EST                     | default 180 (seconds) describes the time between the last client disconnect and the pausing of the process (read as timeout established)                                                            | 180                                                                                                | Integer                                                                                                           | 1.4.0           |\n| AUTO_PAUSE_LOG                             | Enable auto-pause logging                                                                                                                                                                           | true                                                                                               | true/false                                                                                                        | 1.4.0           |\n| AUTO_PAUSE_DEBUG                           | Enable auto-pause debug logging                                                                                                                                                                     | false                                                                                              | true/false                                                                                                        | 1.4.0           |\n| TARGET_MANIFEST_ID                         | Locks game version to corespond with Manifest ID from Steam Download, use with STEAM_USERNAME/STEAM_PASSWORD Depot.                                                                                                                         |                                                                                                    | See [Manifest ID Table](#locking-specific-game-version)                                                           | 0.27.0           |\n| STEAM_USERNAME                            | Steam username for downloading the server with a TARGET_MANIFEST_ID.                                                                                                                                                    |                                                                                                    | \"string\"                                                                                                          | 1.2.2           |\n| STEAM_PASSWORD                           | Steam password for downloading the server with a TARGET_MANIFEST_ID.                                                                                                                                                    |                                                                                                    | \"string\"                                                                                                          | 1.2.2           |\n| INSTALL_BETA_INSIDER                       | Installs the latest Beta version of the Palworld dedicated server                                                                                                                                   | false                                                                                              | true/false                                                                                                        | 0.38.0           |\n| DISCORD_WEBHOOK_URL                        | Discord webhook url found after creating a webhook on a discord server.                                                                                                                             |                                                                                                    | `https://discord.com/api/webhooks/\u003cwebhook_id\u003e`                                                                   | 0.22.0           |\n| DISCORD_SUPPRESS_NOTIFICATIONS             | Enables/Disables `@silent` messages for the server messages.                                                                                                                                        | false                                                                                              | boolean                                                                                                           | 0.34.0           |\n| DISCORD_CONNECT_TIMEOUT                    | Discord command initial connection timeout                                                                                                                                                          | 30                                                                                                 | !0                                                                                                                | 0.22.0           |\n| DISCORD_MAX_TIMEOUT                        | Discord total hook timeout                                                                                                                                                                          | 30                                                                                                 | !0                                                                                                                | 0.22.0           |\n| DISCORD_PRE_UPDATE_BOOT_MESSAGE            | Discord message sent when server begins updating                                                                                                                                                    | Server is updating...                                                                              | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_PRE_UPDATE_BOOT_MESSAGE_ENABLED    | If the Discord message is enabled for this message                                                                                                                                                  | true                                                                                               | boolean                                                                                                           | 0.31.0           |\n| DISCORD_PRE_UPDATE_BOOT_MESSAGE_URL        | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL)                                                                                                                   |                                                                                                    | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_POST_UPDATE_BOOT_MESSAGE           | Discord message sent when server completes updating                                                                                                                                                 | Server update complete!                                                                            | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_POST_UPDATE_BOOT_MESSAGE_ENABLED   | If the Discord message is enabled for this message                                                                                                                                                  | true                                                                                               | boolean                                                                                                           | 0.31.0           |\n| DISCORD_POST_UPDATE_BOOT_MESSAGE_URL       | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL)                                                                                                                   |                                                                                                    | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_PRE_START_MESSAGE                  | Discord message sent when server begins to start                                                                                                                                                    | Server has been started!                                                                           | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_PRE_START_MESSAGE_ENABLED          | If the Discord message is enabled for this message                                                                                                                                                  | true                                                                                               | boolean                                                                                                           | 0.31.0           |\n| DISCORD_PRE_START_MESSAGE_URL              | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL)                                                                                                                   |                                                                                                    | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_PRE_SHUTDOWN_MESSAGE               | Discord message sent when server begins to shutdown                                                                                                                                                 | Server is shutting down...                                                                         | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_PRE_SHUTDOWN_MESSAGE_ENABLED       | If the Discord message is enabled for this message                                                                                                                                                  | true                                                                                               | boolean                                                                                                           | 0.31.0           |\n| DISCORD_PRE_SHUTDOWN_MESSAGE_URL           | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL)                                                                                                                   |                                                                                                    | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_POST_SHUTDOWN_MESSAGE              | Discord message sent when server has stopped                                                                                                                                                        | Server is stopped!                                                                                 | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_POST_SHUTDOWN_MESSAGE_ENABLED      | If the Discord message is enabled for this message                                                                                                                                                  | true                                                                                               | boolean                                                                                                           | 0.31.0           |\n| DISCORD_POST_SHUTDOWN_MESSAGE_URL          | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL)                                                                                                                   |                                                                                                    | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_PLAYER_JOIN_MESSAGE                | Discord message sent when player joins the server                                                                                                                                                   | `player_name` has joined Palworld!                                                                 | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_PLAYER_JOIN_MESSAGE_ENABLED        | If the Discord message is enabled for this message                                                                                                                                                  | true                                                                                               | boolean                                                                                                           | 0.31.0           |\n| DISCORD_PLAYER_JOIN_MESSAGE_URL            | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL)                                                                                                                   |                                                                                                    | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_PLAYER_LEAVE_MESSAGE               | Discord message sent when player leaves the server                                                                                                                                                  | `player_name` has left Palworld.                                                                   | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_PLAYER_LEAVE_MESSAGE_ENABLED       | If the Discord message is enabled for this message                                                                                                                                                  | true                                                                                               | boolean                                                                                                           | 0.31.0           |\n| DISCORD_PLAYER_LEAVE_MESSAGE_URL           | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL)                                                                                                                   |                                                                                                    | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_PRE_BACKUP_MESSAGE                 | Discord message when starting to create a backup                                                                                                                                                    | Creating backup...                                                                                 | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_PRE_BACKUP_MESSAGE_ENABLED         | If the Discord message is enabled for this message                                                                                                                                                  | true                                                                                               | boolean                                                                                                           | 0.31.0           |\n| DISCORD_PRE_BACKUP_MESSAGE_URL             | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL)                                                                                                                   |                                                                                                    | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_POST_BACKUP_MESSAGE                | Discord message when a backup has been made                                                                                                                                                         | Backup created at `file_path`                                                                      | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_POST_BACKUP_MESSAGE_ENABLED        | If the Discord message is enabled for this message                                                                                                                                                  | true                                                                                               | boolean                                                                                                           | 0.31.0           |\n| DISCORD_POST_BACKUP_MESSAGE_URL            | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL)                                                                                                                   |                                                                                                    | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_PRE_BACKUP_DELETE_MESSAGE          | Discord message when starting to remove older backups                                                                                                                                               | Removing backups older than `old_backup_days` days                                                 | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_PRE_BACKUP_DELETE_MESSAGE_ENABLED  | If the Discord message is enabled for this message                                                                                                                                                  | true                                                                                               | boolean                                                                                                           | 0.31.0           |\n| DISCORD_PRE_BACKUP_DELETE_MESSAGE_URL      | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL)                                                                                                                   |                                                                                                    | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_POST_BACKUP_DELETE_MESSAGE         | Discord message when successfully removed older backups                                                                                                                                             | Removed backups older than `old_backup_days` days                                                  | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_POST_BACKUP_DELETE_MESSAGE_ENABLED | If the Discord message is enabled for this message                                                                                                                                                  | true                                                                                               | boolean                                                                                                           | 0.31.0           |\n| DISCORD_POST_BACKUP_DELETE_MESSAGE_URL     | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL)                                                                                                                   |                                                                                                    | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_ERR_BACKUP_DELETE_MESSAGE          | Discord message when there has been an error removing older backups                                                                                                                                 | Unable to delete old backups, OLD_BACKUP_DAYS is not an integer. OLD_BACKUP_DAYS=`old_backup_days` | \"string\"                                                                                                          | 0.31.0           |\n| DISCORD_ERR_BACKUP_DELETE_MESSAGE_ENABLED  | If the Discord message is enabled for this message                                                                                                                                                  | true                                                                                               | boolean                                                                                                           | 0.31.0           |\n| DISCORD_ERR_BACKUP_DELETE_MESSAGE_URL      | Discord Webhook URL for this message (if left empty will use DISCORD_WEBHOOK_URL)                                                                                                                   |                                                                                                    | \"string\"                                                                                                          | 0.31.0           |\n| DISABLE_GENERATE_SETTINGS                  | Whether to automatically generate the PalWorldSettings.ini                                                                                                                                          | false                                                                                              | true/false                                                                                                        | 0.24.0           |\n| DISABLE_GENERATE_ENGINE                    | Whether to automatically generate the Engine.ini                                                                                                                                                    | true                                                                                               | true/false                                                                                                        | 0.30.0           |\n| ENABLE_PLAYER_LOGGING                      | Enables Logging and announcing when players join and leave (with REST_API_ENABLED=true required.)                                                                                                                                          | true                                                                                               | true/false                                                                                                        | 0.31.0           |\n| PLAYER_LOGGING_POLL_PERIOD                 | Polling period (in seconds) to check for players who have joined or left                                                                                                                            | 5                                                                                                  | !0                                                                                                                | 0.31.0           |\n| USE_DEPOT_DOWNLOADER                     | Uses DepotDownloader to download game server files instead of steamcmd. This will help hosts incompatible with steamcmd (e.g. M-series Mac)                                                    | false                                                                                              | true/false                                                                                                        | 0.39.0           |\n| LOG_FILTER_ENABLED                         | Enable filter to reduce duplicated log lines                                                                                                                                                        | true                                                                                               | true/false                                                                                                        | 2.0.1            |\n| LOG_FORMAT_TYPE                            | Configure log format type                                                                                                                                                                           | default                                                                                            | json/logfmt/colored/plain/default                                                                                 | 2.0.1            |\n\n*highly recommended to set\n\n** Make sure you know what you are doing when running this option enabled\n\n*** Required for docker stop to save and gracefully close the server\n\n### ARM64-exclusive environment variables\n\nARM64 hosts can use the following variables to tweak their server setup. This includes\nknown relevant Box64 configurations one can modify for better server stability/performance.\n\nFor the Box64 configurations, please see the their official documentation for more info.\n\n\u003e [!TIP]\n\u003e Set `ARM64_DEVICE` to the most appropriate setting for your device. `generic` is expected\n\u003e to work on all devices but better stability can be found with specifying your device.\n\u003e For more specific device compatibility, create an issue on the\n\u003e [base image repo](https://github.com/sonroyaalmerol/steamcmd-arm64).\n\n| Variable                                   | Info                                                                                                                                                                                                | Default Values                                                                                     | Allowed Values                                                                                                                                  | Added in Version |\n|--------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|------------------|\n| BOX64_DYNAREC_STRONGMEM                     | [[Box64 config](https://github.com/ptitSeb/box64/blob/main/docs/USAGE.md#box64_dynarec_strongmem-)] Enable/Disable simulation of Strong Memory model                                                    | 1                                                                                              | 0, 1, 2, 3                                                                                                        | 0.23.0           |\n| BOX64_DYNAREC_BIGBLOCK                     | [[Box64 config](https://github.com/ptitSeb/box64/blob/main/docs/USAGE.md#box64_dynarec_bigblock-)] Enables/Disables Box64's Dynarec building BigBlock.                                                    | 1                                                                                              | 0, 1, 2, 3                                                                                                        | 0.23.0           |\n| BOX64_DYNAREC_SAFEFLAGS                     | [[Box64 config](https://github.com/ptitSeb/box64/blob/main/docs/USAGE.md#box64_dynarec_safeflags-)] Handling of flags on CALL/RET opcodes                                                    | 1                                                                                              | 0, 1, 2                                                                                                        | 0.23.0           |\n| BOX64_DYNAREC_FASTROUND                     | [[Box64 config](https://github.com/ptitSeb/box64/blob/main/docs/USAGE.md#box64_dynarec_fastround-)] Enable/Disable generation of precise x86 rounding                                                    | 1                                                                                              | 0, 1                                                                                                        | 0.23.0           |\n| BOX64_DYNAREC_FASTNAN                     | [[Box64 config](https://github.com/ptitSeb/box64/blob/main/docs/USAGE.md#box64_dynarec_fastnan-)] Enable/Disable generation of -NAN                                                    | 1                                                                                              | 0, 1                                                                                                        | 0.23.0           |\n| BOX64_DYNAREC_X87DOUBLE                     | [[Box64 config](https://github.com/ptitSeb/box64/blob/main/docs/USAGE.md#box64_dynarec_x87double-)] Force the use of Double for x87 emulation                                                    | 0                                                                                              | 0, 1                                                                                                        | 0.23.0           |\n| ARM64_DEVICE                     | Specify Box64 build to be used based on host device. This setting is only applicable for ARM64 hosts.                                                    | generic                                                                                              | generic, m1, rpi5, adlink                                                                                                        | 0.39.0           |\n\n### Game Ports\n\n| Port  | Info                |\n|-------|---------------------|\n| 8211  | Game Port (UDP)     |\n| 8212  | REST API Port (TCP) |\n| 27015 | Query Port (UDP)    |\n| 25575 | RCON Port (TCP)     |\n\n## Using RCON\n\nRCON is enabled by default for the palworld-server-docker image.\nOpening the RCON CLI is quite easy:\n\n```bash\ndocker exec -it palworld-server rcon-cli \"\u003ccommand\u003e \u003cvalue\u003e\"\n```\n\nFor example, you can broadcast a message to everyone in the server with the following command:\n\n```bash\ndocker exec -it palworld-server rcon-cli \"Broadcast Hello everyone\"\n```\n\nThis will open a CLI that uses RCON to write commands to the Palworld Server.\n\n### List of server commands\n\n| Command                          | Info                                                |\n|----------------------------------|-----------------------------------------------------|\n| Shutdown {Seconds} {MessageText} | The server is shut down after the number of Seconds |\n| DoExit                           | Force stop the server.                              |\n| Broadcast                        | Send message to all player in the server            |\n| KickPlayer {SteamID}             | Kick player from the server..                       |\n| BanPlayer {SteamID}              | BAN player from the server.                         |\n| TeleportToPlayer {SteamID}       | Teleport to current location of target player.      |\n| TeleportToMe {SteamID}           | Target player teleport to your current location     |\n| ShowPlayers                      | Show information on all connected players.          |\n| Info                             | Show server information.                            |\n| Save                             | Save the world data.                                |\n| UnBanPlayer {SteamID}            | Unban player {SteamID} from the server.             |\n\nFor a full list of commands go to: [https://tech.palworldgame.com/settings-and-operation/commands](https://tech.palworldgame.com/settings-and-operation/commands)\n\n## Using REST API\n\nREST API is enabled by default.\n\ndocker-compose.override.yml\n\n```yaml\nservices:\n  palworld:\n    environment:\n      REST_API_ENABLED: true\n```\n\nThe palworld-server-docker image provides rcon-cli as well as rest-cli.\n\n```bash\n$ docker exec -it palworld-server rest-cli\nUsage: rest-cli \u003capi\u003e [options]\napi:\n  announce \u003cjson\u003e ... announce message.\n  ban \u003cjson\u003e      ... ban player.\n  info            ... show server informations.\n  kick \u003cjson\u003e     ... kick player.\n  metrics         ... show server metrics.\n  players         ... show online players.\n  save            ... save the world.\n  settings        ... show server settings.\n  shutdown \u003cjson\u003e ... shutdown server.\n  stop            ... force stop server.\n  unban \u003cjson\u003e    ... unban player.\noptions:\n  '{...}'         ... json.\n  -               ... json from stdin.\n  --no-flush-log  ... do not flush log after API call.\n  -h, --help      ... help.\n```\n\nFor example, you can broadcast a message to everyone in the server with the following command:\n\nCLI parameter style:\n\n```bash\ndocker exec -i palworld-server rest-cli announce \"Broadcast Hello everyone\"\n```\n\nJSON parameter style:\n\n```bash\ndocker exec -i palworld-server rest-cli announce '{\"message\":\"Broadcast Hello everyone\"}'\n```\n\nJSON pipe style:\n\n```bash\necho '{\"message\":\"Broadcast Hello everyone\"}' | docker exec -i palworld-server rest-cli announce -\n```\n\nrest-cli allows you to call REST APIs directly without exposing ports outside the container.\n\n### List of REST APIs\n\n| API                              | Info                        |\n|----------------------------------|-----------------------------|\n| info                             | Get the server information. |\n| players                          | Get player list.            |\n| settings                         | Get the server settings.    |\n| metrics                          | Get the server metrics.     |\n| announce                         | Announce message.           |\n| kick {SteamID}                   | Kick player.                |\n| ban {SteamID}                    | Ban player.                 |\n| unban {SteamID}                  | Unban player.               |\n| save                             | Save the world.             |\n| shutdown {Seconds} {MessageText} | Shutdown the server         |\n| stop                             | Force stop the server.      |\n\nFor an official documents go to: [https://tech.palworldgame.com/category/rest-api](https://tech.palworldgame.com/category/rest-api)\n\n## Creating a backup\n\nTo create a backup of the game's save at the current point in time, use the command:\n\n```bash\ndocker exec palworld-server backup\n```\n\nThis will create a backup at `/palworld/backups/`\n\nThe server will run a save before the backup if rcon is enabled.\n\n## Restore from a backup\n\nTo restore from a backup, use the command:\n\n```bash\ndocker exec -it palworld-server restore\n```\n\nThe `RCON_ENABLED` environment variable must be set to `true` to use this command.\n\u003e [!IMPORTANT]\n\u003e If docker restart is not set to policy `always` or `unless-stopped` then the server will shutdown and will need to be\n\u003e manually restarted.\n\u003e\n\u003e The example docker run command and docker compose file in [How to Use](#how-to-use) already uses the needed policy\n\n## Manually restore from a backup\n\nLocate the backup you want to restore in `/palworld/backups/` and decompress it.\nNeed to stop the server before task.\n\n```bash\ndocker compose down\n```\n\nDelete the old saved data folder located at `palworld/Pal/Saved/SaveGames/0/\u003cold_hash_value\u003e`.\n\nCopy the contents of the newly decompressed saved data folder `Saved/SaveGames/0/\u003cnew_hash_value\u003e` to `palworld/Pal/Saved/SaveGames/0/\u003cnew_hash_value\u003e`.\n\nReplace the DedicatedServerName inside `palworld/Pal/Saved/Config/LinuxServer/GameUserSettings.ini` with the new folder name.\n\n```ini\nDedicatedServerName=\u003cnew_hash_value\u003e  # Replace it with your folder name.\n```\n\nRestart the game. (If you are using Docker Compose)\n\n```bash\ndocker compose up -d\n```\n\n## Configuring Automatic Backups with Cron\n\nThe server is automatically backed up everynight at midnight according to the timezone set with TZ\n\nSet BACKUP_ENABLED enable or disable automatic backups (Default is enabled)\n\nBACKUP_CRON_EXPRESSION is a cron expression, in a Cron-Expression you define an interval for when to run jobs.\n\n\u003e [!TIP]\n\u003e This image uses Supercronic for crons\n\u003e see [supercronic](https://github.com/aptible/supercronic#crontab-format)\n\u003e or\n\u003e [Crontab Generator](https://crontab-generator.org).\n\nSet BACKUP_CRON_EXPRESSION to change the default schedule.\nExample Usage: If BACKUP_CRON_EXPRESSION to `0 2 * * *`, the backup script will run every day at 2:00 AM.\n\n## Configuring Automatic Updates with Cron\n\nTo be able to use automatic Updates with this Server the following environment variables **have** to be set to `true`:\n\n* RCON_ENABLED\n* UPDATE_ON_BOOT\n\n\u003e [!IMPORTANT]\n\u003e\n\u003e If docker restart is not set to policy `always` or `unless-stopped` then the server will shutdown and will need to be\n\u003e manually restarted.\n\u003e\n\u003e The example docker run command and docker compose file in [How to Use](#how-to-use) already use the needed policy\n\nSet AUTO_UPDATE_ENABLED enable or disable automatic updates (Default is disabled)\n\nAUTO_UPDATE_CRON_EXPRESSION is a cron expression, in a Cron-Expression you define an interval for when to run jobs.\n\n\u003e [!TIP]\n\u003e This image uses Supercronic for crons\n\u003e see [supercronic](https://github.com/aptible/supercronic#crontab-format)\n\u003e or\n\u003e [Crontab Generator](https://crontab-generator.org).\n\nSet AUTO_UPDATE_CRON_EXPRESSION to change the default schedule.\n\n## Configuring Automatic Reboots with Cron\n\nTo be able to use automatic reboots with this server RCON_ENABLED enabled.\n\n\u003e [!IMPORTANT]\n\u003e\n\u003e If docker restart is not set to policy `always` or `unless-stopped` then the server will shutdown and will need to be\n\u003e manually restarted.\n\u003e\n\u003e The example docker run command and docker compose file in [How to Use](#how-to-use) already use the needed policy\n\nSet AUTO_REBOOT_ENABLED enable or disable automatic reboots (Default is disabled)\n\nAUTO_REBOOT_CRON_EXPRESSION is a cron expression, in a Cron-Expression you define an interval for when to run jobs.\n\n\u003e [!TIP]\n\u003e This image uses Supercronic for crons\n\u003e see [supercronic](https://github.com/aptible/supercronic#crontab-format)\n\u003e or\n\u003e [Crontab Generator](https://crontab-generator.org).\n\nSet AUTO_REBOOT_CRON_EXPRESSION to change the set the schedule, default is everynight at midnight according to the\ntimezone set with TZ\n\n## Configuring Automatic Pause\n\nThe AUTO_PAUSE feature puts the PalServer process to sleep when there are no online players.\n\nIt saves data before going to sleep.\n\nIt wakes up when it detects a client connection.\n\nWhen in paused state, the world time stops.\n\nThis feature can be enabled by setting the environment variable `AUTO_PAUSE_ENABLED` to \"true\".\n\n\u003e [!INFO]\n\u003e This feature requires `ENABLE_PLAYER_LOGGING=true` and `REST_API_ENABLED=true` to be set.\n\n| Variable               | Info                                                                                                                                     | Default Values | Allowed Values |\n|------------------------|------------------------------------------------------------------------------------------------------------------------------------------|----------------|----------------|\n| AUTO_PAUSE_ENABLED     | Enables automatic pause (Puts the server to sleep to save power when there are no online players). Requires `ENABLE_PLAYER_LOGGING=true` and `REST_API_ENABLED=true`. | false          | true/false     |\n| AUTO_PAUSE_TIMEOUT_EST | default 180 (seconds) describes the time between the last client disconnect and the pausing of the process (read as timeout established) | 180            | Integer        |\n| AUTO_PAUSE_LOG         | Enable auto-pause logging                                                                                                                | true           | true/false     |\n| AUTO_PAUSE_DEBUG       | Enable auto-pause debug logging                                                                                                          | false          | true/false     |\n\nIf you want timestamps in the container logs for auto-pause events, either run `docker logs -t palworld-server`\nor set `LOG_FORMAT_TYPE=plain` or `LOG_FORMAT_TYPE=colored`.\n\n`AUTO_PAUSE_LOG` messages go through the shared container logger, so\n`LOG_FILTER_ENABLED` and `LOG_FORMAT_TYPE` apply to them too.\n\n\u003e [!NOTE]\n\u003e When using **Podman**, you must add the `--cap-add=NET_RAW` option to the `run` or `create` command.\n\u003e Alternatively, add the following `cap_add:` to your `compose.yml`:\n\u003e\n\u003e ```yaml\n\u003e services:\n\u003e   palworld:\n\u003e     cap_add:\n\u003e       - NET_RAW\n\u003e ```\n\n### Resume manually\n\nA file called `.paused` is created in `/palworld` directory when the server is paused and removed when the server is resumed.\n\nOther services may check for this file's existence before waking the server.\n\nAlternatively, resume with the following command:\n\n```shell\ndocker exec -it palworld-server autopause resume\n```\n\n### Service control manually\n\nA `.autopause-disabled` file can be created in the `/palworld` directory to make the server skip autopausing,\nfor as long as the file is present.\n\nAlternatively, you can control with the following command:\n\n```shell\ndocker exec -it palworld-server autopause stop\ndocker exec -it palworld-server autopause continue\n```\n\nThis `autopause stop` command is also used during automatic reboots, automatic updates, and container stops.\nIt is also used to shutdown command via REST API/RCON.\n\n### With Community Server\n\nIf the environment variable `COMMUNITY` is true, A proxy server is started within the container to\nmaintain registration on the community server list.\n\nThe proxy server captures communication with `api.palworldgames.com`.\n\nThe auto-pause service will replay captured data in the paused state.\n\n## Editing Server Settings\n\n### With Environment Variables\n\n\u003e [!IMPORTANT]\n\u003e\n\u003e These Environment Variables/Settings are subject to change since the game is still in beta.\n\u003e Check out the [official webpage for the supported parameters.](https://tech.palworldgame.com/optimize-game-balance)\n\nConverting server settings to environment variables follow the same principles (with some exceptions):\n\n* all capital letters\n* split words by inserting an underscore\n* remove the single letter if the setting starts with one (like 'b')\n\nFor example:\n\n* Difficulty -\u003e DIFFICULTY\n* PalSpawnNumRate -\u003e PAL_SPAWN_NUM_RATE\n* bIsPvP -\u003e IS_PVP\n\n| Variable                                  | Description                                                                                                                                                      | Default Value                                                                                | Allowed Value                          |\n|-------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|----------------------------------------|\n| DIFFICULTY                                | Game Difficulty                                                                                                                                                  | None                                                                                         | `None`,`Normal`,`Difficult`            |\n| RANDOMIZER_TYPE                           | Random Pal Mode, None : No Randomization, Region : Randomize by Region, All : Completely Random                                                | None                                                                                         | `None`, `Region`, `All`           |\n| RANDOMIZER_SEED                           | Randomizer Seed                                                |  \"\"                                                                                        | String           |\n| IS_RANDOMIZER_PAL_LEVEL_RANDOM            | If the parameter has been set to true, Wild pals level is fully randomized. set to false, Randomized within a level optimized with the area.                             | False                                                                                        | Boolean                                |\n| DAYTIME_SPEEDRATE                         | Day time speed - Larger number means shorter days                                                                                                                | 1.000000                                                                                     | Float                                  |\n| NIGHTTIME_SPEEDRATE                       | Night time speed - Larger number means shorter nights                                                                                                            | 1.000000                                                                                     | Float                                  |\n| EXP_RATE                                  | EXP earn rate                                                                                                                                                    | 1.000000                                                                                     | Float                                  |\n| PAL_CAPTURE_RATE                          | Pal capture rate                                                                                                                                                 | 1.000000                                                                                     | Float                                  |\n| PAL_SPAWN_NUM_RATE                        | Pal appearance rate                                                                                                                                              | 1.000000                                                                                     | Float                                  |\n| PAL_DAMAGE_RATE_ATTACK                    | Damage from pals multipiler                                                                                                                                      | 1.000000                                                                                     | Float                                  |\n| PAL_DAMAGE_RATE_DEFENSE                   | Damage to pals multipiler                                                                                                                                        | 1.000000                                                                                     | Float                                  |\n| PLAYER_DAMAGE_RATE_ATTACK                 | Damage from player multipiler                                                                                                                                    | 1.000000                                                                                     | Float                                  |\n| PLAYER_DAMAGE_RATE_DEFENSE                | Damage to  player multipiler                                                                                                                                     | 1.000000                                                                                     | Float                                  |\n| PLAYER_STOMACH_DECREASE_RATE              | Player hunger depletion rate                                                                                                                                     | 1.000000                                                                                     | Float                                  |\n| PLAYER_STAMINA_DECREASE_RATE              | Player stamina reduction rate                                                                                                                                    | 1.000000                                                                                     | Float                                  |\n| PLAYER_AUTO_HP_REGEN_RATE                 | Player auto HP regeneration rate                                                                                                                                 | 1.000000                                                                                     | Float                                  |\n| PLAYER_AUTO_HP_REGEN_RATE_IN_SLEEP        | Player sleep HP regeneration rate                                                                                                                                | 1.000000                                                                                     | Float                                  |\n| PAL_STOMACH_DECREASE_RATE                 | Pal hunger depletion rate                                                                                                                                        | 1.000000                                                                                     | Float                                  |\n| PAL_STAMINA_DECREASE_RATE                 | Pal stamina reduction rate                                                                                                                                       | 1.000000                                                                                     | Float                                  |\n| PAL_AUTO_HP_REGEN_RATE                    | Pal auto HP regeneration rate                                                                                                                                    | 1.000000                                                                                     | Float                                  |\n| PAL_AUTO_HP_REGEN_RATE_IN_SLEEP           | Pal sleep health regeneration rate (in Palbox)                                                                                                                   | 1.000000                                                                                     | Float                                  |\n| BUILD_OBJECT_HP_RATE           | Damage rate to structure multiplier                                                                                                                  | 1.000000                                                                                     | Float                                  |\n| BUILD_OBJECT_DAMAGE_RATE                  | Damage to structure multipiler                                                                                                                                   | 1.000000                                                                                     | Float                                  |\n| BUILD_OBJECT_DETERIORATION_DAMAGE_RATE    | Structure determination rate                                                                                                                                     | 1.000000                                                                                     | Float                                  |\n| COLLECTION_DROP_RATE                      | Getherable items multipiler                                                                                                                                      | 1.000000                                                                                     | Float                                  |\n| COLLECTION_OBJECT_HP_RATE                 | Getherable objects HP multipiler                                                                                                                                 | 1.000000                                                                                     | Float                                  |\n| COLLECTION_OBJECT_RESPAWN_SPEED_RATE      | Getherable objects respawn interval - The smaller the number, the faster the regeneration                                                                        | 1.000000                                                                                     | Float                                  |\n| ENEMY_DROP_ITEM_RATE                      | Dropped Items Multipiler                                                                                                                                         | 1.000000                                                                                     | Float                                  |\n| DEATH_PENALTY                             | Death Penalty\u003c/br\u003eNone: No death penalty\u003c/br\u003eItem: Drops items other than equipment\u003c/br\u003eItemAndEquipment: Drops all items\u003c/br\u003eAll: Drops all PALs and all items. | All                                                                                          | `None`,`Item`,`ItemAndEquipment`,`All` |\n| ENABLE_PLAYER_TO_PLAYER_DAMAGE            | Allows players to cause damage to players                                                                                                                        | False                                                                                        | Boolean                                |\n| ENABLE_FRIENDLY_FIRE                      | Allow friendly fire                                                                                                                                              | False                                                                                        | Boolean                                |\n| ENABLE_INVADER_ENEMY                      | Enable invaders                                                                                                                                                  | True                                                                                         | Boolean                                |\n| ACTIVE_UNKO                               | Enable UNKO (?)                                                                                                                                                  | False                                                                                        | Boolean                                |\n| ENABLE_AIM_ASSIST_PAD                     | Enable controller aim assist                                                                                                                                     | True                                                                                         | Boolean                                |\n| ENABLE_AIM_ASSIST_KEYBOARD                | Enable Keyboard aim assist                                                                                                                                       | False                                                                                        | Boolean                                |\n| DROP_ITEM_MAX_NUM                         | Maximum number of drops in the world                                                                                                                             | 3000                                                                                         | Integer                                |\n| DROP_ITEM_MAX_NUM_UNKO                    | Maximum number of UNKO drops in the world                                                                                                                        | 100                                                                                          | Integer                                |\n| BASE_CAMP_MAX_NUM                         | Maximum number of base camps                                                                                                                                     | 128                                                                                          | Integer                                |\n| BASE_CAMP_WORKER_MAX_NUM                  | Maximum number of workers                                                                                                                                        | 15                                                                                           | Integer                                |\n| DROP_ITEM_ALIVE_MAX_HOURS                 | Time it takes for items to despawn in hours                                                                                                                      | 1.000000                                                                                     | Float                                  |\n| AUTO_RESET_GUILD_NO_ONLINE_PLAYERS        | Automatically reset guild when no players are online                                                                                                             | False                                                                                        | Bool                                   |\n| AUTO_RESET_GUILD_TIME_NO_ONLINE_PLAYERS   | Time to automatically reset guild when no players are online                                                                                                     | 72.000000                                                                                    | Float                                  |\n| GUILD_PLAYER_MAX_NUM                      | Max player of Guild                                                                                                                                              | 20                                                                                           | Integer                                |\n| BASE_CAMP_MAX_NUM_IN_GUILD                | Max bases of Guild                                                                                                                                               | 4                                                                                            | Integer                                |\n| PAL_EGG_DEFAULT_HATCHING_TIME             | Time(h) to incubate massive egg                                                                                                                                  | 72.000000                                                                                    | Float                                  |\n| WORK_SPEED_RATE                           | Work speed muliplier                                                                                                                                             | 1.000000                                                                                     | Float                                  |\n| AUTO_SAVE_SPAN                           | Time between autosaves (seconds)                                                                                                                                             | 30.000000                                                                                     | Float                                  |\n| IS_MULTIPLAY                              | Enable multiplayer                                                                                                                                               | False                                                                                        | Boolean                                |\n| IS_PVP                                    | Enable PVP                                                                                                                                                       | False                                                                                        | Boolean                                |\n| HARDCORE                                    | Enable Hardcore                                                                                                                                                       | False                                                                                        | Boolean                                |\n|  PAL_LOST                                   | Lose pals on (pal)death                                                                                                                                                      | False                                                                                        | Boolean                                |\n| CAN_PICKUP_OTHER_GUILD_DEATH_PENALTY_DROP | Allow players from other guilds to pick up death penalty items                                                                                                   | False                                                                                        | Boolean                                |\n| ENABLE_NON_LOGIN_PENALTY                  | Enable non-login penalty                                                                                                                                         | True                                                                                         | Boolean                                |\n| ENABLE_FAST_TRAVEL                        | Enable fast travel                                                                                                                                               | True                                                                                         | Boolean                                |\n| IS_START_LOCATION_SELECT_BY_MAP           | Enable selecting of start location                                                                                                                               | True                                                                                         | Boolean                                |\n| EXIST_PLAYER_AFTER_LOGOUT                 | Toggle for deleting players when they log off                                                                                                                    | False                                                                                        | Boolean                                |\n| ENABLE_DEFENSE_OTHER_GUILD_PLAYER         | Allows defense against other guild players                                                                                                                       | False                                                                                        | Boolean                                |\n| INVISIBLE_OTHER_GUILD_BASE_CAMP_AREA_FX         | unknown                                                                                                                       | False                                                                                        | Boolean                                |\n| BUILD_AREA_LIMIT         | Build area limit                                                                                                                       | False                                                                                        | Boolean                                |\n|   ITEM_WEIGHT_RATE       | Item Weight Multiplier                                                                                                                       | 1.000000                                                                                        | float                                |\n| COOP_PLAYER_MAX_NUM                       | Maximum number of players in a guild                                                                                                                             | 4                                                                                            | Integer                                |\n| REGION                                    | Region                                                                                                                                                           |                                                                                              | String                                 |\n| USEAUTH                                   | Use authentication                                                                                                                                               | True                                                                                         | Boolean                                |\n| BAN_LIST_URL                              | Which ban list to use                                                                                                                                            | [https://api.palworldgame.com/api/banlist.txt](https://api.palworldgame.com/api/banlist.txt) | string                                 |\n| SHOW_PLAYER_LIST                          | Enable show player list                                                                                                                                          | True                                                                                         | Boolean                                |\n| CHAT_POST_LIMIT_PER_MINUTE                          | Amount of messages players can send per minute                                                                                                                                          | 10                                                                                         | Integer                                |\n| SUPPLY_DROP_SPAN                          |  Interval for supply drop (minutes)                                                                                                                                         | 180                                                                                         | Integer                                |\n| ENABLE_PREDATOR_BOSS_PAL                          |  Enable Predator boss as pals                                                                                                                                         | true                                                                                         | boolean                                |\n| MAX_BUILDING_LIMIT_NUM                          |  Maximum number of buildings per base                                                                                                                                         | 0 (unlimited)                                                                                         | Integer                                |\n| SERVER_REPLICATE_PAWN_CULL_DISTANCE                          |  Server Replicate Pawn Cull Distance                                                                                                                                       | 15000.000000                                                                                         | Float                                |\n| CROSSPLAY_PLATFORMS           | Allowed platform to connect the server.                                                                                                                               | (Steam,Xbox,PS5,Mac) Please make sure you use the \"()\"                                                                                        | List                                |\n| ALLOW_GLOBAL_PALBOX_EXPORT           | If set to True, saving to the global palbox is possible.                                                                                                                               | True                                                                                         | Boolean                                |\n| ALLOW_GLOBAL_PALBOX_IMPORT           | If set to True, importing from the global palbox is possible.                                                                                                                               | False                                                                                         | Boolean                                |\n| EQUIPMENT_DURABILITY_DAMAGE_RATE           | Equipment durability damage rate.                                                                                                                               | 1.000000                                                                                     | Float                                |\n| ITEM_CONTAINER_FORCE_MARK_DIRTY_INTERVAL           | Item container force mark dirty interval.                                                                                                                               | 1.000000                                                                                     | Float                                |\n| ITEM_CORRUPTION_MULTIPLIER           | Item corruption multiplier.                                                                                                                               | 1.000000                                                                                     | Float                                |\n\n### Manually\n\nWhen the server starts, a `PalWorldSettings.ini` file will be created in the following location: `\u003cmount_folder\u003e/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini`\n\nPlease keep in mind that the ENV variables will always overwrite the changes made to `PalWorldSettings.ini`.\n\n\u003e [!IMPORTANT]\n\u003e Changes can only be made to `PalWorldSettings.ini` while the server is off.\n\u003e\n\u003e Any changes made while the server is live will be overwritten when the server stops.\n\u003e\n\u003e Remember to disable generate settings on the environment variables, or the `PalWorldSettings.ini` file will be\n\u003e overwritten at startup with the default settings. See `DISABLE_GENERATE_SETTINGS` in environment variables.\n\nFor a more detailed list of server settings go to: [Palworld Wiki](https://palworld.wiki.gg/wiki/PalWorldSettings.ini)\n\nFor more detailed server settings explanations go to: [shockbyte](https://shockbyte.com/billing/knowledgebase/1189/How-to-Configure-your-Palworld-server.html)\n\n## Using discord webhooks\n\n1. Generate a webhook url for your discord server in your discord's server settings.\n\n2. Set the environment variable with the unique token at the end of the discord webhook url example: `https://discord.com/api/webhooks/1234567890/abcde`\n\nsend discord messages with docker run:\n\n```sh\n-e DISCORD_WEBHOOK_URL=\"https://discord.com/api/webhooks/1234567890/abcde\" \\\n-e DISCORD_PRE_UPDATE_BOOT_MESSAGE=\"Server is updating...\" \\\n```\n\nsend discord messages with docker compose:\n\n```yaml\n- DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/1234567890/abcde\n- DISCORD_PRE_UPDATE_BOOT_MESSAGE=Server is updating...\n```\n\n## Locking Specific Game Version\n\n\u003e[!WARNING]\n\u003eDowngrading to a lower game version is possible, but it is unknown what impact it will have on existing saves.\n\u003eThis requires you to set STEAM_USERNAME and STEAM_PASSWORD to a Steam account that owns the game.\n\u003eAccounts with Steam Guard enabled are currently not supported.\n\u003e**Please do so at your own risk!**\n\nIf **TARGET_MANIFEST_ID** environment variable is","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthijsvanloef%2Fpalworld-server-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthijsvanloef%2Fpalworld-server-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthijsvanloef%2Fpalworld-server-docker/lists"}