Skip to content

Commit

Permalink
Merge branch 'main' into qemu-compatibility-mode
Browse files Browse the repository at this point in the history
  • Loading branch information
@thijsvanloef
thijsvanloef authored Mar 1, 2024
2 parents 6d0efb4 + ea79d4f commit acff203
Show file tree
Hide file tree
Showing 16 changed files with 164 additions and 42 deletions.
4 changes: 3 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ This container has also been tested and will work on both `x64` and `ARM64` base
Massive shoutout to the following sponsors!

<p align="center"><!-- markdownlint-disable-line --><!-- markdownlint-disable-next-line -->
<!-- sponsors --><a href="https://github.com/ShoeBoom"><img src="https://github.com/ShoeBoom.png" width="50px" alt="ShoeBoom" /></a>&nbsp;&nbsp;<a href="https://github.com/doomhound188"><img src="https://github.com/doomhound188.png" width="50px" alt="doomhound188" /></a>&nbsp;&nbsp;<a href="https://github.com/AshishT112203"><img src="https://github.com/AshishT112203.png" width="50px" alt="AshishT112203" /></a>&nbsp;&nbsp;<a href="https://github.com/pabumake"><img src="https://github.com/pabumake.png" width="50px" alt="pabumake" /></a>&nbsp;&nbsp;<a href="https://github.com/stoprx"><img src="https://github.com/stoprx.png" width="50px" alt="stoprx" /></a>&nbsp;&nbsp;<a href="https://github.com/KiKoS0"><img src="https://github.com/KiKoS0.png" width="50px" alt="KiKoS0" /></a>&nbsp;&nbsp;<a href="https://github.com/inspired-by-nudes"><img src="https://github.com/inspired-by-nudes.png" width="50px" alt="inspired-by-nudes" /></a>&nbsp;&nbsp;<a href="https://github.com/PulsarFTW"><img src="https://github.com/PulsarFTW.png" width="50px" alt="PulsarFTW" /></a>&nbsp;&nbsp;<!-- sponsors -->
<!-- sponsors --><a href="https://github.com/doomhound188"><img src="https://github.com/doomhound188.png" width="50px" alt="doomhound188" /></a>&nbsp;&nbsp;<a href="https://github.com/AshishT112203"><img src="https://github.com/AshishT112203.png" width="50px" alt="AshishT112203" /></a>&nbsp;&nbsp;<a href="https://github.com/pabumake"><img src="https://github.com/pabumake.png" width="50px" alt="pabumake" /></a>&nbsp;&nbsp;<a href="https://github.com/stoprx"><img src="https://github.com/stoprx.png" width="50px" alt="stoprx" /></a>&nbsp;&nbsp;<a href="https://github.com/KiKoS0"><img src="https://github.com/KiKoS0.png" width="50px" alt="KiKoS0" /></a>&nbsp;&nbsp;<a href="https://github.com/inspired-by-nudes"><img src="https://github.com/inspired-by-nudes.png" width="50px" alt="inspired-by-nudes" /></a>&nbsp;&nbsp;<a href="https://github.com/PulsarFTW"><img src="https://github.com/PulsarFTW.png" width="50px" alt="PulsarFTW" /></a>&nbsp;&nbsp;<!-- sponsors -->
</p>

## Official Documentation
Expand Down Expand Up @@ -241,6 +241,7 @@ It is highly recommended you set the following environment values before startin
| DISCORD_PRE_SHUTDOWN_MESSAGE | Discord message sent when server begins to shutdown | Server is shutting down... | "string" |
| DISCORD_POST_SHUTDOWN_MESSAGE | Discord message sent when server has stopped | Server is stopped! | "string" |
| DISABLE_GENERATE_SETTINGS | Whether to automatically generate the PalWorldSettings.ini | false | true/false |
| DISABLE_GENERATE_ENGINE | Whether to automatically generate the Engine.ini | true | true/false |
| ENABLE_PLAYER_LOGGING | Enables Logging and announcing when players join and leave | true | true/false |
| PLAYER_LOGGING_POLL_PERIOD | Polling period (in seconds) to check for players who have joined or left | 5 | !0 |
| ARM_COMPATIBILITY_MODE | Switches the compatibility layer from Box86 to QEMU when executing steamcmd for server updates. This setting is only applicable for ARM64 hosts. | false | true/false |
Expand Down Expand Up @@ -542,6 +543,7 @@ The manifest corresponds to the release date/update versions. Manifests can be f
| 1.3.0 | 1354752814336157338 |
| 1.4.0 | 4190579964382773830 |
| 1.4.1 | 6370735655629434989 |
| 1.5.0 | 3750364703337203431 |
## Reporting Issues/Feature Requests
Expand Down
3 changes: 3 additions & 0 deletions docusaurus/docs/getting-started/configuration/engine-settings.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Changing Engine Settings with Environment variables.
These environment variables and settings are subject to change since the game is still in beta.
:::

To use these settings you must set `DISABLE_GENERATE_ENGINE: false`.

Converting engine settings to environment variables follow the same principles (with some exceptions):

* All capital letters
Expand All @@ -26,6 +28,7 @@ For example:

| Variable | Description | Default Value | Allowed Value |
|-------------------------------|-----------------------------------------------------------------------------------------------------------------|---------------|--------------------|
| DISABLE_GENERATE_ENGINE | Disable the generation of the Engine.ini | true | Boolean |
| LAN_SERVER_MAX_TICK_RATE | Sets maximum ticks per second for LAN servers, higher rates result in smoother gameplay. | 120 | Integer |
| NET_SERVER_MAX_TICK_RATE | Sets maximum ticks per second for Internet servers, similarly ensuring smoother online gameplay. | 120 | Integer |
| CONFIGURED_INTERNET_SPEED | Sets the assumed player internet speed in bytes per second. High value reduces chances of bandwidth throttling. | 104857600 | Integer (in bytes) |
Expand Down
1 change: 1 addition & 0 deletions docusaurus/docs/getting-started/configuration/server-settings.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ It is highly recommended you set the following environment values before startin
| DISCORD_PRE_SHUTDOWN_MESSAGE | Discord message sent when server begins to shutdown | Server is shutting down... | "string" |
| DISCORD_POST_SHUTDOWN_MESSAGE | Discord message sent when server has stopped | Server is stopped! | "string" |
| DISABLE_GENERATE_SETTINGS | Whether to automatically generate the PalWorldSettings.ini | false | true/false |
| DISABLE_GENERATE_ENGINE | Whether to automatically generate the Engine.ini | true | true/false |
| ENABLE_PLAYER_LOGGING | Enables Logging and announcing when players join and leave | true | true/false |
| PLAYER_LOGGING_POLL_PERIOD | Polling period (in seconds) to check for players who have joined or left | 5 | !0 |
| ARM_COMPATIBILITY_MODE | Switches the compatibility layer from Box86 to QEMU when executing steamcmd for server updates. This setting is only applicable for ARM64 hosts. | false | true/false |
Expand Down
1 change: 1 addition & 0 deletions docusaurus/docs/guides/pinning-game-version.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,4 @@ The manifest corresponds to the release date/update versions. Manifests can be f
| 1.3.0 | 1354752814336157338 |
| 1.4.0 | 4190579964382773830 |
| 1.4.1 | 6370735655629434989 |
| 1.5.0 | 3750364703337203431 |
7 changes: 7 additions & 0 deletions docusaurus/docs/guides/rcon/_category_.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "RCON (Advanced)",
"position": 3,
"link": {
"type": "generated-index"
}
}
6 changes: 6 additions & 0 deletions docusaurus/docs/guides/rcon/rcon-wrapper.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# RCON Wrapper

GitHub user [valamidev](https://github.com/valamidev) made a plugin for `palworld-server-docker`
that allows you to protect the palworld RCON end-point with a Bearer token and access it via HTTP protocol.

More information on his GitHub Repo: [valamidev/palworld-rcon-buddy](https://github.com/valamidev/palworld-rcon-buddy)
49 changes: 49 additions & 0 deletions ...us-plugin-content-docs/current/getting-started/configuration/engine-settings.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
sidebar_position: 3
---

# Engine-Einstellungen

Ändern der Engine-Einstellungen mit Umgebungsvariablen.

## Mit Umgebungsvariablen

:::warning
Diese Umgebungsvariablen und Einstellungen können sich ändern, da das Spiel sich noch in der Beta-Phase befindet.
:::

Um diese Einstellungen zu nutzen, musst du `DISABLE_GENERATE_ENGINE: false` setzen.

Um Engine-Einstellungen in Umgebungsvariablen zu konvertieren müssen folgende Regeln eingehalten werden:

* alle Buchstaben groß schreiben
* Wörter durch Einfügen eines Unterstrichs trennen
* falls die Einstellung mit einem einzelnen Buchstaben beginnt, muss dieser entfernt werden (z.B. 'b')

Beispiel:

* LanServerMaxTickRate -> LAN_SERVER_MAX_TICK_RATE
* bUseFixedFrameRate -> USE_FIXED_FRAME_RATE
* NetClientTicksPerSecond -> NET_CLIENT_TICKS_PER_SECOND

| Variable | Beschreibung | Standardwert | Erlaubter Wert |
| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------- |
| DISABLE_GENERATE_ENGINE | Deaktiviert die Generierung der Engine.ini | true | Boolean |
| LAN_SERVER_MAX_TICK_RATE | Setzt die maximale Anzahl an Ticks pro Sekunde für LAN-Server. Höhere Raten sorgen für ein flüssigeres Gameplay. | 120 | Integer |
| NET_SERVER_MAX_TICK_RATE | Setzt die maximale Anzahl an Ticks pro Sekunde für dedizierte Server, um ein ebenso flüssiges Online-Spiel zu gewährleisten. | 120 | Integer |
| CONFIGURED_INTERNET_SPEED | Setzt die angenommene Internetgeschwindigkeit der Spieler in Bytes pro Sekunde. Ein hoher Wert reduziert die Wahrscheinlichkeit von Bandbreiten-Drosselung. | 104857600 | Integer (in Bytes) |
| CONFIGURED_LAN_SPEED | Setzt die LAN-Geschwindigkeit, um sicherzustellen, dass LAN-Spieler die maximale Netzwerkkapazität nutzen können. | 104857600 | GInteger (in Bytes) |
| MAX_CLIENT_RATE | Maximale Datenübertragungsrate pro Client für alle Verbindungen, um eine Datenbeschränkung zu verhindern. | 104857600 | Integer (in Bytes) |
| MAX_INTERNET_CLIENT_RATE | Zielt speziell auf Internet-Clients ab, um eine uneingeschränkte Datenübertragung in großem Umfang zu ermöglichen. | 104857600 | Integer (in Bytes) |
| SMOOTH_FRAME_RATE | Ermöglicht es der Spiel-Engine, Schwankungen der Bildrate auszugleichen, für ein konsistenteres visuelles Erlebnis. | true | Boolean |
| SMOOTH_FRAME_RATE_UPPER_LIMIT | Setzt einen maximalen Ziel-Bildratenbereich für die Frame-Glättung fest. | 120.000000 | Float |
| SMOOTH_FRAME_RATE_LOWER_LIMIT | Setzt einen minimalen Ziel-Bildratenbereich für die Frame-Glättung fest. | 30.000000 | Float |
| USE_FIXED_FRAME_RATE | Aktiviert die Verwendung einer festen Bildrate | false | Boolean |
| FIXED_FRAME_RATE | Feste Bildrate | 120.000000 | Float |
| MIN_DESIRED_FRAME_RATE | Legt eine minimale akzeptable Bildrate fest, um sicherzustellen, dass das Spiel zumindest mit dieser Bildrate flüssig läuft. | 60.000000 | Float |
| NET_CLIENT_TICKS_PER_SECOND | Erhöht die Update-Frequenz für Clients, um die Reaktionsfähigkeit zu verbessern und die Verzögerung zu reduzieren. | 120 | Integer |

:::tip
Das Erhöhen der Server-Tickrate auf über 120 fps macht zwar einige Gameplay-Aspekte flüssiger,
behebt jedoch keine Ruckler und belastet deine Hardware erheblich mehr.
:::
7 changes: 5 additions & 2 deletions ...urus-plugin-content-docs/current/getting-started/configuration/game-settings.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ Beispiele:
| Variable | Beschreibung | Standardwert | Erlaubte Werte |
|-------------------------------------------|----------------------------------------------------------------|----------------------------------------------------------------------------------------------|----------------------------------------|
| DIFFICULTY | Spiel-Schwierigkeitsgrad | None | `None`,`Normal`,`Difficult` |
| DAYTIME_SPEEDRATE | Tageszeit-Geschwindigkeit - Kleinerer Wert bedeutet kürzere Tage | 1.000000 | Float |
| NIGHTTIME_SPEEDRATE | Nachtszeit-Geschwindigkeit - Kleinerer Wert bedeutet kürzere Nächte | 1.000000 | Float |
| DAYTIME_SPEEDRATE | Tageszeit-Geschwindigkeit - Größerer Wert bedeutet kürzere Tage | 1.000000 | Float |
| NIGHTTIME_SPEEDRATE | Nachtszeit-Geschwindigkeit - Größerer Wert bedeutet kürzere Nächte | 1.000000 | Float |
| EXP_RATE | EXP-Sammelrate | 1.000000 | Float |
| PAL_CAPTURE_RATE | Pal-Fangrate | 1.000000 | Float |
| PAL_SPAWN_NUM_RATE | Pal-Erscheinungsrate | 1.000000 | Float |
Expand Down Expand Up @@ -81,7 +81,10 @@ Beispiele:
| REGION | Region | | String |
| USEAUTH | Authentifizierung verwenden | True | Boolean |
| BAN_LIST_URL | Welche Sperrliste verwenden | [https://api.palworldgame.com/api/banlist.txt](https://api.palworldgame.com/api/banlist.txt) | string |
| SHOW_PLAYER_LIST | Aktiviert die Anzeige der Spieler | True | Boolean |
| TARGET_MANIFEST_ID | Legt die Spielversion entsprechend der Manifest-ID aus dem Steam-Download-Depot fest. | | Siehe [Manifest IDs](https://palworld-server-docker.loef.dev/de/guides/pinning-game-version) |
| ENABLE_PLAYER_LOGGING | Aktiviert das Protokollieren und das Ankündigen, wenn Spieler dem Spiel beitreten und es verlassen. | true | Boolean |
| PLAYER_LOGGING_POLL_PERIOD | Abfrageintervall (in Sekunden), um zu überprüfen, ob Spieler dem Spiel beigetreten sind oder es verlassen haben. | 5 | !0 |

### Manuell

Expand Down
2 changes: 1 addition & 1 deletion ...us-plugin-content-docs/current/getting-started/configuration/server-commands.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 3
sidebar_position: 4
---

# Serverbefehle (RCON)
Expand Down
Loading

0 comments on commit acff203

Please sign in to comment.