#269 add documentation for upcoming xbox-dedicated-server release

jammsen · Jun 24, 2024 · 0e5b345 · 0e5b345
1 parent a7d46f2
commit 0e5b345
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 [Back to main](README.md#changelog)
 
+## 2024-06-24
+
+- Add support-documentation for Xbox-Dedicated-Servers @jammsen (#269)
+
 ## 2024-04-28
 
 - Log-Rotation by @Gornoka (#261)

diff --git a/README.md b/README.md
@@ -192,6 +192,10 @@ A Helm chart to deploy this container can be found at [palworld-helm](https://gi
 
 ## FAQ
 
+### Does this image support Xbox Dedicated Servers?
+
+> Yes just change the value from `ALLOW_CONNECT_PLATFORM` from Steam to Xbox. See here for more documentation: https://tech.palworldgame.com/getting-started/for-xbox-dedicated-server
+
 ### How can I use the interactive console in Portainer with this image?
 
 > You can run this `docker exec -ti palworld-dedicated-server bash' or you could navigate to the **"Stacks"** tab in Portainer, select your stack, and click on the container name. Then click on the **"Exec console"** button.

diff --git a/docs/ENV_VARS.md b/docs/ENV_VARS.md
@@ -143,7 +143,7 @@ Information sources and credits to the following websites:
 | RESTAPI_ENABLED                           | RESTAPIEnabled                                                     | Enables the RESTAPI                                                                                                                                                                                                                                                                                                                                                                                                             | true                                                   | Boolean       |
 | RESTAPI_PORT                              | RESTAPIPort                                                        | Defines the port inside the container where the API should be hosted - RESTAPI: Needs Basic Auth; admin:ADMIN_PASSWORD                                                                                                                                                                                                                                                                                                          | 8212                                                   | UInt16        |
 | SHOW_PLAYER_LIST                          | bShowPlayerList                                                    | Enables to view player-list ingame via the escape key                                                                                                                                                                                                                                                                                                                                                                           | false                                                  | Boolean       |
-| ALLOW_CONNECT_PLATFORM                    | AllowConnectPlatform                                               | Looks like Cross-Play, but according to official documentation, isnt working yet and no more infos given on this; See: https://tech.palworldgame.com/settings-and-operation/configuration                                                                                                                                                                                                                                       | Steam                                                  | String        |
+| ALLOW_CONNECT_PLATFORM                    | AllowConnectPlatform                                               | Looks like Cross-Play at a later time, but according to official documentation, you can choose either Steam or Xbox; See: https://tech.palworldgame.com/getting-started/for-xbox-dedicated-server and https://tech.palworldgame.com/settings-and-operation/configuration                                                                                                                                                        | Steam                                                  | String        |
 | ENABLE_WORLD_BACKUP                       | bIsUseBackupSaveData                                               | Enables internal world backup inside the game-server; off by default, because we have our own backup solution                                                                                                                                                                                                                                                                                                                   | false                                                  | Boolean       |