Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prep for Xbox Dedicated Servers #559

Merged
merged 3 commits into from
Jun 27, 2024
Merged

Prep for Xbox Dedicated Servers #559

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e190b8d
Prep for Xbox Dedicated Servers
thijsvanloef Jun 24, 2024
e52dab9
Merge branch 'main' into prep-for-xbox-dedicated-servers
thijsvanloef Jun 26, 2024
bdd466b
update known issues
thijsvanloef Jun 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ 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
INSTALL_BETA_INSIDER=False
1 change: 1 addition & 0 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ ENV HOME=/home/steam \
PLAYER_LOGGING_POLL_PERIOD=5 \
ARM_COMPATIBILITY_MODE=false \
DISABLE_GENERATE_ENGINE=true \
ALLOW_CONNECT_PLATFORM=Steam \
INSTALL_BETA_INSIDER=false

# Passed from Github Actions
Expand Down
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
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
Open in desktop
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
Open in desktop
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
Open in desktop
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
Open in desktop
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
10 changes: 7 additions & 3 deletions docusaurus/docs/known-issues/known-issues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,15 @@ Using REST API solves it.
`docker exec -it palworld-server rest-cli announce "Hello world"`
:::

## XBox GamePass players unable to join
## XBox Dedicated servers

At the moment, Xbox Gamepass/Xbox Console players will not be able to join a dedicated server.
:::tip
Setup your Xbox dedicated server [following these steps](https://palworld-server-docker.loef.dev/quick-setup-xbox).
:::

At the moment, Xbox Gamepass/Xbox Console players will not be able to join Steam players on a dedicated server.

They will need to join players using the invite code and are limited to sessions of 4 players max.
Dedicated servers are only for Xbox players or only for Steam players and cross-play is not possible at this time.

## [S_API FAIL]

Expand Down
2 changes: 1 addition & 1 deletion scripts/compile-settings.sh
View file
Open in desktop
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