Merge pull request #270 from jammsen/develop

Release 2024-06-24.01
jammsen · Jun 24, 2024 · fb21421 · fb21421
2 parents 6c75ef6 + 0e5b345
commit fb21421
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 6 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -7,13 +7,21 @@ body:
     attributes:
       value: |
         ## Important information
-        Thank you for taking the time to fill out this bug report! Please understand you are asking for support for the Docker-Image and Docker-Container. I'm NOT the creator of the Dedicated-Game-Server itself, i'm not involved in programming that. If you need help for that, you might want to ask here for topics related to that: https://tech.palworldgame.com/getting-started/deploy-dedicated-server
+        ### Thank you for taking the time to fill out this bug report in a sensible way and provide us with a clear information on your "Software and Hardware-Setup" and the "Steps to reproduce" your problem!
+        ### Please understand you are asking for support for the Docker-Image and Docker-Container. I'm NOT the creator of the Dedicated-Game-Server itself, i'm not involved in programming that. If you need help for that, you might want to ask here for topics related to that: https://tech.palworldgame.com/getting-started/deploy-dedicated-server
   - type: checkboxes
-    id: understand-important-info
+    id: understand-minimum-required-info
     attributes:
-      label: Have you read the Important information text above
+      label: You understand that if you dont provide clear information on your "Problem", "Software and Hardware-Setup" and the "Steps to reproduce" your issue will be closed without any help, because your not willing to do your part?
       options:
-        - label: Yes i did
+        - label: Yes i do!
+          required: true
+  - type: checkboxes
+    id: understand-gamedev-info
+    attributes:
+      label: You understand that im not a Game-Dev or Game-Server-Dev and my support is primary for the Docker-Image and somewhat limited to the Game-Server?
+      options:
+        - label: Yes i do!
           required: true
   - type: textarea
     id: current-behavior
@@ -41,7 +49,7 @@ body:
   - type: textarea
     id: reproduction
     attributes:
-      label: To Reproduce
+      label: Steps to reproduce
       description: What steps can i do to reproduce your problem?
       value: |
         Steps to reproduce the behavior:

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       |