From e190b8d207639809aef498dc13fb40b56308c702 Mon Sep 17 00:00:00 2001 From: Thijs van Loef Date: Mon, 24 Jun 2024 13:17:08 +0200 Subject: [PATCH] Prep for Xbox Dedicated Servers --- .env.example | 1 + Dockerfile | 3 +- README.md | 8 ++-- docker-compose.yml | 1 + .../configuration/server-settings.md | 2 +- .../docs/getting-started/quick-setup-xbox.md | 37 +++++++++++++++++++ .../docs/getting-started/quick-setup.md | 12 ++++-- scripts/compile-settings.sh | 2 +- 8 files changed, 55 insertions(+), 11 deletions(-) create mode 100644 docusaurus/docs/getting-started/quick-setup-xbox.md diff --git a/.env.example b/.env.example index bc5c01a3f..b76230b3c 100644 --- a/.env.example +++ b/.env.example @@ -85,5 +85,6 @@ BAN_LIST_URL=https://api.palworldgame.com/api/banlist.txt REST_API_ENABLED=False REST_API_PORT=8212 SHOW_PLAYER_LIST=True +# ALLOW_CONNECT_PLATFORM Defaults to "Steam" if not set, set this to "Xbox" if you want to host a server for Xbox players. CROSSPLAY BETWEEN XBOX-STEAM IS NOT YET SUPPORTED ALLOW_CONNECT_PLATFORM=Steam USE_BACKUP_SAVE_DATA=True diff --git a/Dockerfile b/Dockerfile index f561a0e99..f9d1b81c5 100644 --- a/Dockerfile +++ b/Dockerfile @@ -145,7 +145,8 @@ ENV HOME=/home/steam \ ENABLE_PLAYER_LOGGING=true \ PLAYER_LOGGING_POLL_PERIOD=5 \ ARM_COMPATIBILITY_MODE=false \ - DISABLE_GENERATE_ENGINE=true + DISABLE_GENERATE_ENGINE=true \ + ALLOW_CONNECT_PLATFORM=Steam # Passed from Github Actions ARG GIT_VERSION_TAG=unspecified diff --git a/README.md b/README.md index 3a6bf7058..2a85f8075 100644 --- a/README.md +++ b/README.md @@ -34,9 +34,7 @@ This Docker container has been tested and will work on the following OS: This container has also been tested and will work on both `x64` and `ARM64` based CPU architecture. > [!IMPORTANT] -> At the moment, Xbox GamePass/Xbox Console players will not be able to join a dedicated server. -> -> They will need to join players using the invite code and are limited to sessions of 4 players max. +> Looking to host a server for Xbox players? [Follow this guide here!](https://palworld-server-docker.loef.dev/quick-setup-xbox) ## Sponsors @@ -91,6 +89,7 @@ services: COMMUNITY: false # Enable this if you want your server to show up in the community servers tab, USE WITH SERVER_PASSWORD! SERVER_NAME: "palworld-server-docker by Thijs van Loef" SERVER_DESCRIPTION: "palworld-server-docker by Thijs van Loef" + ALLOW_CONNECT_PLATFORM: "Steam" # Defaults to "Steam" if not set, set this to "Xbox" if you want to host a server for Xbox players. CROSSPLAY BETWEEN XBOX-STEAM IS NOT YET SUPPORTED volumes: - ./palworld:/palworld/ ``` @@ -139,6 +138,7 @@ docker run -d \ -e COMMUNITY=false \ -e SERVER_NAME="palworld-server-docker by Thijs van Loef" \ -e SERVER_DESCRIPTION="palworld-server-docker by Thijs van Loef" \ + -e ALLOW_CONNECT_PLATFORM="Steam" \ --restart unless-stopped \ --stop-timeout 30 \ thijsvanloef/palworld-server-docker:latest @@ -224,7 +224,7 @@ It is highly recommended you set the following environment values before startin | REST_API_ENABLED | Enable REST API for the palworld server | false | true/false | 0.35.0 | | REST_API_PORT | REST API port to connect to | 8212 | 1024-65535 | 0.35.0 | | QUERY_PORT | Query port used to communicate with Steam servers | 27015 | 1024-65535 | 0.1.0 | -| ALLOW_CONNECT_PLATFORM | !!Doesn't work this version!! | Steam | unknown | 0.35.0 | +| ALLOW_CONNECT_PLATFORM | Specify if you are hosting a dedicated server for Steam or Xbox players | Steam | Steam/Xbox | 0.38.0 | | BACKUP_CRON_EXPRESSION | Setting affects frequency of automatic backups. | 0 0 \* \* \* | Needs a Cron-Expression - See [Configuring Automatic Backups with Cron](#configuring-automatic-backups-with-cron) | 0.19.0 | | BACKUP_ENABLED | Enables automatic backups | true | true/false | 0.19.0 | | USE_BACKUP_SAVE_DATA | Enables native automatic backups | true | true/false | 0.35.0 | diff --git a/docker-compose.yml b/docker-compose.yml index 8b5bc7ace..dbfa706aa 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -23,5 +23,6 @@ services: COMMUNITY: false # Enable this if you want your server to show up in the community servers tab, USE WITH SERVER_PASSWORD! SERVER_NAME: "palworld-server-docker by Thijs van Loef" SERVER_DESCRIPTION: "palworld-server-docker by Thijs van Loef" + ALLOW_CONNECT_PLATFORM: "Steam" # Defaults to "Steam" if not set, set this to "Xbox" if you want to host a server for Xbox players. CROSSPLAY BETWEEN XBOX-STEAM IS NOT YET SUPPORTED volumes: - ./palworld:/palworld/ diff --git a/docusaurus/docs/getting-started/configuration/server-settings.md b/docusaurus/docs/getting-started/configuration/server-settings.md index bb0d2c76c..d7c4ec21a 100644 --- a/docusaurus/docs/getting-started/configuration/server-settings.md +++ b/docusaurus/docs/getting-started/configuration/server-settings.md @@ -42,7 +42,7 @@ It is highly recommended you set the following environment values before startin | REST_API_ENABLED | Enable REST API for the palworld server | false | true/false | 0.35.0 | | REST_API_PORT | REST API port to connect to | 8212 | 1024-65535 | 0.35.0 | | QUERY_PORT | Query port used to communicate with Steam servers | 27015 | 1024-65535 | 0.1.0 | -| ALLOW_CONNECT_PLATFORM | !!Doesn't work this version!! | Steam | unknown | 0.35.0 | +| ALLOW_CONNECT_PLATFORM | Specify if you are hosting a dedicated server for Steam or Xbox players | Steam | Steam/Xbox | 0.38.0 | | BACKUP_CRON_EXPRESSION | Setting affects frequency of automatic backups. | 0 0 \* \* \* | Needs a Cron-Expression - See [Configuring Automatic Backups with Cron](https://palworld-server-docker.loef.dev/guides/backup/automated-backup) | 0.19.0 | | BACKUP_ENABLED | Enables automatic backups | true | true/false | 0.19.0 | | USE_BACKUP_SAVE_DATA | Enables native automatic backups | true | true/false | 0.35.0 | diff --git a/docusaurus/docs/getting-started/quick-setup-xbox.md b/docusaurus/docs/getting-started/quick-setup-xbox.md new file mode 100644 index 000000000..36064a333 --- /dev/null +++ b/docusaurus/docs/getting-started/quick-setup-xbox.md @@ -0,0 +1,37 @@ +--- +sidebar_position: 2 +slug: /quick-setup-xbox +title: Palworld Dedicated server Quick Setup Xbox +description: This guide will help you get setup with hosting your Palworld Dedicated server for Xbox! This Palworld server quick setup will only take a couple of minutes and you'll have a working server. +keywords: [Palworld, palworld dedicated server, how to setup palworld dedicated server xbox, palworld server docker xbox, palworld docker, xbox] +image: ../assets/Palworld_Banner.jpg +sidebar_label: Quick Setup Xbox +--- + +# Palworld Dedicated server Xbox + +:::warning +PLEASE NOT THAT CROSSPLAY BETWEEN XBOX-STEAM IS NOT YET SUPPORTED +::: + +Servers set up using these steps will be able to accept connections from the Xbox Series X version, Xbox Series S version, +Xbox One version, and the Windows PC version downloaded from the Microsoft Store. [^1] + +Setting up a dedicated server for Xbox is the same as deploying for Steam. +You would only need to change the following environment variable. + +Change: + +```yaml +ALLOW_CONNECT_PLATFORM: "Steam" +``` + +to: + +```yaml +ALLOW_CONNECT_PLATFORM: "Xbox" +``` + +--- + +[^1]: [Official documentation](https://tech.palworldgame.com/getting-started/for-xbox-dedicated-server) diff --git a/docusaurus/docs/getting-started/quick-setup.md b/docusaurus/docs/getting-started/quick-setup.md index 7a11e29b8..16dc9a410 100644 --- a/docusaurus/docs/getting-started/quick-setup.md +++ b/docusaurus/docs/getting-started/quick-setup.md @@ -13,14 +13,16 @@ sidebar_label: Quick Setup This guide will help you get setup with hosting your Palworld Dedicated server on Docker! This Palworld server quick setup will only take a couple of minutes and you'll have a working server. -## Prerequisites +## Xbox Dedicated Server + +:::important -:::warning -At the moment, Xbox Gamepass/Xbox Console players will not be able to join a dedicated server. +Looking to host a server for Xbox players? [Follow this guide here!](https://palworld-server-docker.loef.dev/quick-setup-xbox) -They will need to join players using the invite code and are limited to sessions of 4 players max. ::: +## Prerequisites + * Virtualization enabled in the BIOS/UEFI * Must have [Docker](https://docs.docker.com/engine/install/) installed @@ -63,6 +65,7 @@ services: COMMUNITY: false # Enable this if you want your server to show up in the community servers tab, USE WITH SERVER_PASSWORD! SERVER_NAME: "palworld-server-docker by Thijs van Loef" SERVER_DESCRIPTION: "palworld-server-docker by Thijs van Loef" + ALLOW_CONNECT_PLATFORM: "Steam" # Defaults to "Steam" if not set, set this to "Xbox" if you want to host a server for Xbox players. CROSSPLAY BETWEEN XBOX-STEAM IS NOT YET SUPPORTED volumes: - ./palworld:/palworld/ ``` @@ -123,6 +126,7 @@ docker run -d \ -e COMMUNITY=false \ -e SERVER_NAME="palworld-server-docker by Thijs van Loef" \ -e SERVER_DESCRIPTION="palworld-server-docker by Thijs van Loef" \ + -e ALLOW_CONNECT_PLATFORM: "Steam" \ --restart unless-stopped \ --stop-timeout 30 \ thijsvanloef/palworld-server-docker:latest diff --git a/scripts/compile-settings.sh b/scripts/compile-settings.sh index 22fae7419..449dd8a6c 100755 --- a/scripts/compile-settings.sh +++ b/scripts/compile-settings.sh @@ -86,7 +86,7 @@ export BAN_LIST_URL=\"${BAN_LIST_URL:-https://api.palworldgame.com/api/banlist.t export REST_API_ENABLED=\"${REST_API_ENABLED:-False}\" export REST_API_PORT=\"${REST_API_PORT:-8212}\" export SHOW_PLAYER_LIST=${SHOW_PLAYER_LIST:-True} -export ALLOW_CONNECT_PLATFORM=${ALLOW_CONNECT_PLATFORM:-"Steam"} +export ALLOW_CONNECT_PLATFORM=${ALLOW_CONNECT_PLATFORM:-Steam} export USE_BACKUP_SAVE_DATA=${USE_BACKUP_SAVE_DATA:-True} if [ "${DEBUG,,}" = true ]; then