Skip to content

Commit

Permalink
Prep for Xbox Dedicated Servers
Browse files Browse the repository at this point in the history
  • Loading branch information
@thijsvanloef
thijsvanloef committed Jun 24, 2024
1 parent f12136f commit e190b8d
Show file tree
Hide file tree
Showing 8 changed files with 55 additions and 11 deletions.
1 change: 1 addition & 0 deletions .env.example
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 2 additions & 1 deletion Dockerfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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/
```
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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 |
Expand Down
1 change: 1 addition & 0 deletions docker-compose.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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/
2 changes: 1 addition & 1 deletion docusaurus/docs/getting-started/configuration/server-settings.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
37 changes: 37 additions & 0 deletions docusaurus/docs/getting-started/quick-setup-xbox.md
View file
Original file line number Diff line number Diff line change
@@ -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
---
<!-- markdownlint-disable-next-line -->
# 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)
12 changes: 8 additions & 4 deletions docusaurus/docs/getting-started/quick-setup.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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/
```
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion scripts/compile-settings.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit e190b8d

Please sign in to comment.