diff --git a/README.md b/README.md index 8a4fc3a17..bac5e118d 100644 --- a/README.md +++ b/README.md @@ -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!
## Official Documentation @@ -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 | @@ -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 diff --git a/docusaurus/docs/getting-started/configuration/engine-settings.md b/docusaurus/docs/getting-started/configuration/engine-settings.md index ab50d5627..e6178d014 100644 --- a/docusaurus/docs/getting-started/configuration/engine-settings.md +++ b/docusaurus/docs/getting-started/configuration/engine-settings.md @@ -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 @@ -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) | diff --git a/docusaurus/docs/getting-started/configuration/server-settings.md b/docusaurus/docs/getting-started/configuration/server-settings.md index 319e0d48a..e73df1c91 100644 --- a/docusaurus/docs/getting-started/configuration/server-settings.md +++ b/docusaurus/docs/getting-started/configuration/server-settings.md @@ -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 | diff --git a/docusaurus/docs/guides/pinning-game-version.md b/docusaurus/docs/guides/pinning-game-version.md index abcd4a4bc..4d60aef9b 100644 --- a/docusaurus/docs/guides/pinning-game-version.md +++ b/docusaurus/docs/guides/pinning-game-version.md @@ -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 | diff --git a/docusaurus/docs/guides/rcon/_category_.json b/docusaurus/docs/guides/rcon/_category_.json new file mode 100644 index 000000000..e7e977c2c --- /dev/null +++ b/docusaurus/docs/guides/rcon/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "RCON (Advanced)", + "position": 3, + "link": { + "type": "generated-index" + } +} diff --git a/docusaurus/docs/guides/rcon/rcon-wrapper.md b/docusaurus/docs/guides/rcon/rcon-wrapper.md new file mode 100644 index 000000000..fd9eed81c --- /dev/null +++ b/docusaurus/docs/guides/rcon/rcon-wrapper.md @@ -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) diff --git a/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/getting-started/configuration/engine-settings.md b/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/getting-started/configuration/engine-settings.md new file mode 100644 index 000000000..e47a48d6d --- /dev/null +++ b/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/getting-started/configuration/engine-settings.md @@ -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. +::: diff --git a/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/getting-started/configuration/game-settings.md b/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/getting-started/configuration/game-settings.md index bf1406ed2..9fdf5498a 100644 --- a/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/getting-started/configuration/game-settings.md +++ b/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/getting-started/configuration/game-settings.md @@ -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 | @@ -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 diff --git a/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/getting-started/configuration/server-commands.md b/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/getting-started/configuration/server-commands.md index 69f4f47f7..51fa833ef 100644 --- a/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/getting-started/configuration/server-commands.md +++ b/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/getting-started/configuration/server-commands.md @@ -1,5 +1,5 @@ --- -sidebar_position: 3 +sidebar_position: 4 --- # Serverbefehle (RCON) diff --git a/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/getting-started/configuration/server-settings.md b/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/getting-started/configuration/server-settings.md index f783a0a22..477c6c9ba 100644 --- a/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/getting-started/configuration/server-settings.md +++ b/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/getting-started/configuration/server-settings.md @@ -16,44 +16,49 @@ Es wird dringend empfohlen, die folgenden Umgebungsvariablen festzulegen, bevor * PUID * PGID -| Variable | Info | Standardwerte | Erlaubte Werte | -|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|---------------------------------------------------------------------------------------| -| TZ | Zeitzone, die für die Zeitstempel des Backup-Servers verwendet wird | UTC | Siehe [TZ-Identifikatoren](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#Time_Zone_abbreviations) | -| PLAYERS* | Maximale Anzahl von Spielern, die dem Server beitreten können | 16 | 1-32 | -| PORT* | UDP-Port, den der Server freigibt | 8211 | 1024-65535 | -| PUID* | Die Benutzer-ID des Benutzers, unter dem der Server ausgeführt werden soll | 1000 | !0 | -| PGID* | Die Gruppen-ID der Gruppe, unter der der Server ausgeführt werden soll | 1000 | !0 | -| MULTITHREADING** | Verbessert die Leistung in Umgebungen mit mehreren Threads. Es ist bis zu einer maximalen Anzahl von etwa 4 Threads effektiv, und das Zuweisen von mehr Threads als dieser Anzahl macht nicht viel Sinn. | false | true/false | -| COMMUNITY | Ob der Server im Community-Server-Browser angezeigt wird (VERWENDEN SIE ES AUSSCHLIEẞLICH MIT SERVER_PASSWORD!) | false | true/false | -| PUBLIC_IP | Sie können die globale IP-Adresse des Netzwerks angeben, auf dem der Server ausgeführt wird. Wenn nicht angegeben, wird sie automatisch erkannt. Wenn dies nicht gut funktioniert, versuchen Sie eine manuelle Konfiguration. | | x.x.x.x | -| PUBLIC_PORT | Sie können die Portnummer des Netzwerks angeben, auf dem der Server ausgeführt wird. Wenn nicht angegeben, wird sie automatisch erkannt. Wenn dies nicht gut funktioniert, versuchen Sie eine manuelle Konfiguration. | | 1024-65535 | -| SERVER_NAME | Ein Name für Ihren Server | | "string" | -| SERVER_DESCRIPTION | Ihre Serverbeschreibung | | "string" | -| SERVER_PASSWORD | Sichern Sie Ihren Community-Server mit einem Passwort | | "string" | -| ADMIN_PASSWORD | Sichern Sie den Administrationszugriff auf dem Server mit einem Passwort | | "string" | -| UPDATE_ON_BOOT** | Update/Installieren Sie den Server, wenn der Docker-Container gestartet wird (DIESES MUSS BEIM ERSTEN MAL, WENN SIE DEN CONTAINER AUSFÜHREN, AKTIVIERT WERDEN) | true | true/false | -| RCON_ENABLED*** | Aktivieren Sie RCON für den Palworld-Server | true | true/false | -| RCON_PORT | RCON-Port, um eine Verbindung herzustellen | 25575 | 1024-65535 | -| QUERY_PORT | Abfrageport, der zur Kommunikation mit Steam-Servern verwendet wird | 27015 | 1024-65535 | -| BACKUP_CRON_EXPRESSION | Einstellung beeinflusst die Häufigkeit automatischer Backups. | 0 0 \* \* \* | Erfordert einen Cron-Ausdruck - Siehe [Konfigurieren automatischer Backups mit Cron](https://palworld-server-docker.loef.dev/de/guides/backup/automated-backup) | -| BACKUP_ENABLED | Aktiviert automatische Backups | true | true/false | -| DELETE_OLD_BACKUPS | Löscht Backups nach einer bestimmten Anzahl von Tagen | false | true/false | -| OLD_BACKUP_DAYS | Wie viele Tage sollen Backups aufbewahrt werden | 30 | jede positive Ganzzahl | -| AUTO_UPDATE_CRON_EXPRESSION | Einstellung beeinflusst die Häufigkeit automatischer Updates. | 0 \* \* \* \* | Erfordert einen Cron-Ausdruck - Siehe [Konfigurieren automatischer Updates mit Cron](https://palworld-server-docker.loef.dev/de/guides/automatic-updates) | -| AUTO_UPDATE_ENABLED | Aktiviert automatische Updates | false | true/false | -| AUTO_UPDATE_WARN_MINUTES | Wie lange soll gewartet werden, um den Server zu aktualisieren, nachdem die Spieler informiert wurden. | 30 | !0 | -| AUTO_REBOOT_CRON_EXPRESSION | Einstellung beeinflusst die Häufigkeit automatischer Neustarts. | 0 0 \* \* \* | Erfordert einen Cron-Ausdruck - Siehe [Konfigurieren automatischer Neustarts mit Cron](https://palworld-server-docker.loef.dev/de/guides/automatic-reboots) | -| AUTO_REBOOT_ENABLED | Aktiviert automatische Neustarts | false | true/false | -| AUTO_REBOOT_WARN_MINUTES | Wie lange soll gewartet werden, um den Server neu zu starten, nachdem die Spieler informiert wurden. | 5 | !0 | -| AUTO_REBOOT_EVEN_IF_PLAYERS_ONLINE | Starten Sie den Server neu, auch wenn Spieler online sind. | false | true/false | -| DISCORD_WEBHOOK_URL | Discord-Webhook-URL, die nach Erstellung eines Webhooks auf einem Discord-Server gefunden werden kann | | `https://discord.com/api/webhooks/