diff --git a/.env.example b/.env.example index b4ed3d741..ddb969288 100644 --- a/.env.example +++ b/.env.example @@ -81,4 +81,5 @@ ENABLE_DEFENSE_OTHER_GUILD_PLAYER=False COOP_PLAYER_MAX_NUM=4 REGION= USEAUTH=True -BAN_LIST_URL=https://api.palworldgame.com/api/banlist.txt \ No newline at end of file +BAN_LIST_URL=https://api.palworldgame.com/api/banlist.txt +SHOW_PLAYER_LIST=True diff --git a/Dockerfile b/Dockerfile index 534149ff9..ce2cba43a 100644 --- a/Dockerfile +++ b/Dockerfile @@ -20,7 +20,7 @@ RUN wget -q https://github.com/gorcon/rcon-cli/archive/refs/tags/v${RCON_VERSION FROM cm2network/steamcmd:root as base-amd64 # Ignoring --platform=arm64 as this is required for the multi-arch build to continue to work on amd64 hosts # hadolint ignore=DL3029 -FROM --platform=arm64 sonroyaalmerol/steamcmd-arm64:root as base-arm64 +FROM --platform=arm64 sonroyaalmerol/steamcmd-arm64:root-2024-02-29 as base-arm64 ARG TARGETARCH # Ignoring the lack of a tag here because the tag is defined in the above FROM lines @@ -109,8 +109,12 @@ ENV HOME=/home/steam \ DISCORD_PRE_START_MESSAGE="Server has been started!" \ DISCORD_PRE_SHUTDOWN_MESSAGE="Server is shutting down..." \ DISCORD_POST_SHUTDOWN_MESSAGE="Server has been stopped!" \ + DISCORD_PLAYER_JOIN_MESSAGE="\${player_name} has joined Palworld!" \ + DISCORD_PLAYER_LEAVE_MESSAGE="\${player_name} has left Palworld." \ ENABLE_PLAYER_LOGGING=true \ - PLAYER_LOGGING_POLL_PERIOD=5 + PLAYER_LOGGING_POLL_PERIOD=5 \ + ARM_COMPATIBILITY_MODE=false \ + DISABLE_GENERATE_ENGINE=true COPY ./scripts /home/steam/server/ COPY ./services /home/steam/server/services/ diff --git a/README.md b/README.md index 2ca39dd21..20a6650e2 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ [Chat with the community on Discord](https://discord.gg/UxBxStPAAE) -[English](/README.md) | [한국어](/docs/kr/README.md) | [简体中文](/docs/zh-CN/README.md) +[English](/README.md) | [한국어](/docs/kr/README.md) | [简体中文](/docs/zh-CN/README.md) | [French](/docs/fr/README.md) > [!TIP] > Unsure how to get started? Check out [this guide I wrote!](https://tice.tips/containerization/palworld-server-docker/) @@ -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!

-ShoeBoom  doomhound188  AshishT112203  pabumake  stoprx  KiKoS0  inspired-by-nudes  USA-RedDragon  PulsarFTW   +doomhound188  AshishT112203  stoprx  KiKoS0  inspired-by-nudes  PulsarFTW  

## Official Documentation @@ -226,12 +226,12 @@ It is highly recommended you set the following environment values before startin | OLD_BACKUP_DAYS | How many days to keep backups | 30 | any positive integer | | AUTO_UPDATE_CRON_EXPRESSION | Setting affects frequency of automatic updates. | 0 \* \* \* \* | Needs a Cron-Expression - See [Configuring Automatic Backups with Cron](#configuring-automatic-backups-with-cron) | | AUTO_UPDATE_ENABLED | Enables automatic updates | false | true/false | -| AUTO_UPDATE_WARN_MINUTES | How long to wait to update the server, after the player were informed. (This will be ignored, if no Players are connected) | 30 | Integer | +| AUTO_UPDATE_WARN_MINUTES | How long to wait to update the server, after the player were informed. (This will be ignored, if no Players are connected) | 30 | Integer | | AUTO_REBOOT_CRON_EXPRESSION | Setting affects frequency of automatic updates. | 0 0 \* \* \* | Needs a Cron-Expression - See [Configuring Automatic Backups with Cron](#configuring-automatic-reboots-with-cron) | | AUTO_REBOOT_ENABLED | Enables automatic reboots | false | true/false | -| AUTO_REBOOT_WARN_MINUTES | How long to wait to reboot the server, after the player were informed. | 5 | Integer | +| AUTO_REBOOT_WARN_MINUTES | How long to wait to reboot the server, after the player were informed. | 5 | Integer | | AUTO_REBOOT_EVEN_IF_PLAYERS_ONLINE | Restart the Server even if there are players online. | false | true/false | -| TARGET_MANIFEST_ID | Locks game version to corespond with Manfiest ID from Steam Download Depot. | | See [Manifest ID Table](#locking-specific-game-version) | +| TARGET_MANIFEST_ID | Locks game version to corespond with Manifest ID from Steam Download Depot. | | See [Manifest ID Table](#locking-specific-game-version) | | DISCORD_WEBHOOK_URL | Discord webhook url found after creating a webhook on a discord server | | `https://discord.com/api/webhooks/` | | DISCORD_CONNECT_TIMEOUT | Discord command initial connection timeout | 30 | !0 | | DISCORD_MAX_TIMEOUT | Discord total hook timeout | 30 | !0 | @@ -240,9 +240,13 @@ It is highly recommended you set the following environment values before startin | DISCORD_PRE_START_MESSAGE | Discord message sent when server begins to start | Server is started! | "string" | | 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" | +| DISCORD_PLAYER_JOIN_MESSAGE | Discord message sent when player joins the server | \${player_name} has joined Palworld! | "string" | +| DISCORD_PLAYER_LEAVE_MESSAGE | Discord message sent when player leaves the server | \${player_name} has left Palworld. | "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 | *highly recommended to set @@ -290,7 +294,7 @@ This will open a CLI that uses RCON to write commands to the Palworld Server. | Info | Show server information. | | Save | Save the world data. | -For a full list of commands go to: [https://tech.palworldgame.com/server-commands](https://tech.palworldgame.com/server-commands) +For a full list of commands go to: [https://tech.palworldgame.com/settings-and-operation/commands](https://tech.palworldgame.com/settings-and-operation/commands) ## Creating a backup @@ -487,6 +491,7 @@ For example: | REGION | Region | | String | | USEAUTH | Use authentication | True | Boolean | | BAN_LIST_URL | Which ban list to use | [https://api.palworldgame.com/api/banlist.txt](https://api.palworldgame.com/api/banlist.txt) | string | +| SHOW_PLAYER_LIST | Enable show player list | True | Boolean | ### Manually @@ -540,6 +545,8 @@ 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 | +| 1.5.1 | 2815085007637542021 | ## Reporting Issues/Feature Requests diff --git a/docs/fr/README.md b/docs/fr/README.md new file mode 100644 index 000000000..5fcc92e0e --- /dev/null +++ b/docs/fr/README.md @@ -0,0 +1,571 @@ +# Palworld Serveur Dédié Docker + +## ⚠️These docs will be deprecated and removed on March 31 2024⚠️ + +Please use the official docs: [https://palworld-server-docker.loef.dev/](https://palworld-server-docker.loef.dev/) + +[![Release](https://img.shields.io/github/v/release/thijsvanloef/palworld-server-docker)](https://github.com/thijsvanloef/palworld-server-docker/releases) +[![Docker Pulls](https://img.shields.io/docker/pulls/thijsvanloef/palworld-server-docker)](https://hub.docker.com/r/thijsvanloef/palworld-server-docker) +[![Docker Stars](https://img.shields.io/docker/stars/thijsvanloef/palworld-server-docker)](https://hub.docker.com/r/thijsvanloef/palworld-server-docker) +[![Image Size](https://img.shields.io/docker/image-size/thijsvanloef/palworld-server-docker/latest)](https://hub.docker.com/r/thijsvanloef/palworld-server-docker/tags) +[![Discord](https://img.shields.io/discord/1200397673329594459?logo=discord&label=Discord&link=https%3A%2F%2Fdiscord.gg%2FUxBxStPAAE)](https://discord.com/invite/UxBxStPAAE) + +[![CodeFactor](https://www.codefactor.io/repository/github/thijsvanloef/palworld-server-docker/badge)](https://www.codefactor.io/repository/github/thijsvanloef/palworld-server-docker) +[![Release](https://github.com/thijsvanloef/palworld-server-docker/actions/workflows/release.yml/badge.svg)](https://github.com/thijsvanloef/palworld-server-docker/actions/workflows/release.yml) +[![Linting](https://github.com/thijsvanloef/palworld-server-docker/actions/workflows/linting.yml/badge.svg)](https://github.com/thijsvanloef/palworld-server-docker/actions/workflows/linting.yml) +[![Security](https://github.com/thijsvanloef/palworld-server-docker/actions/workflows/security.yml/badge.svg)](https://github.com/thijsvanloef/palworld-server-docker/actions/workflows/security.yml) + +[![Docker Hub](https://img.shields.io/badge/Docker_Hub-palworld-blue?logo=docker)](https://hub.docker.com/r/thijsvanloef/palworld-server-docker) +[![GHCR](https://img.shields.io/badge/GHCR-palworld-blue?logo=docker)](https://github.com/thijsvanloef/palworld-server-docker/pkgs/container/palworld-server-docker) +[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/palworld-server-chart)](https://artifacthub.io/packages/search?repo=palworld-server-chart) + +[Discuter avec la communauté sur Discord](https://discord.gg/UxBxStPAAE) + +[English](/README.md) | [한국어](/docs/kr/README.md) | [简体中文](/docs/zh-CN/README.md) | [French](/docs/fr/README.md) + +> [!TIP] +> Vous ne savez pas par où commencer ? Consultez [ce guide que j'ai écrit !](https://tice.tips/containerization/palworld-server-docker/) + +Il s'agit d'un conteneur Docker pour vous aider à démarrer l'hébergement de votre propre serveur dédié [Palworld](https://store.steampowered.com/app/1623730/Palworld/). + +Ce conteneur Docker a été testé et fonctionnera sur les systèmes d'exploitation suivants : + +- Linux (Ubuntu/Debian) +- Windows 10, 11 +- MacOS (y compris Apple Silicon M1/M2/M3). + +Ce conteneur a également été testé et fonctionnera sur les architectures de processeur `x64` et `ARM64`. + +> [!IMPORTANT] +> Pour le moment, les joueurs Xbox GamePass/Xbox Console ne pourront pas rejoindre un serveur dédié. +> +> Ils devront rejoindre les joueurs en utilisant le code d'invitation et sont limités à des sessions de 4 joueurs maximum. + +## Sponsors + +Un énorme merci aux sponsors suivants ! + +

+doomhound188  AshishT112203  pabumake  stoprx  KiKoS0  inspired-by-nudes  PulsarFTW   +

+ +## Documentation Officielle + +[![Documentation](https://github.com/thijsvanloef/palworld-server-docker/assets/58031337/b92d76d1-5efb-438d-9ffd-5385544a831b)](https://palworld-server-docker.loef.dev/) + +## Configuration requise du serveur + +| Ressource | Minimum | Recommandé | +| --------- | ------- | -------------------------------------------------------- | +| CPU | 4 cœurs | 4 cœurs ou plus | +| RAM | 16 Go | Recommandé : plus de 32 Go pour un fonctionnement stable | +| Stockage | 8 Go | 20 Go | + +## Comment utiliser + +N'oubliez pas que vous devrez modifier les [variables d'environnement](#variables-d-environnement). + +### Docker Compose + +Ce référentiel comprend un exemple de fichier [docker-compose.yml](/docker-compose.yml) +que vous pouvez utiliser pour configurer votre serveur. + +```yml +services: + palworld: + image: thijsvanloef/palworld-server-docker:latest + restart: unless-stopped + container_name: palworld-server + stop_grace_period: 30s # Réglez selon le temps que vous êtes prêt à attendre pour l'arrêt gracieux du conteneur + ports: + - 8211:8211/udp + - 27015:27015/udp + environment: + PUID: 1000 + PGID: 1000 + PORT: 8211 # Optionnel mais recommandé + PLAYERS: 16 # Optionnel mais recommandé + SERVER_PASSWORD: 'worldofpals' # Optionnel mais recommandé + MULTITHREADING: true + RCON_ENABLED: true + RCON_PORT: 25575 + TZ: 'UTC' + ADMIN_PASSWORD: 'adminPasswordHere' + COMMUNITY: false # Activez ceci si vous souhaitez que votre serveur apparaisse dans l'onglet des serveurs communautaires, À UTILISER AVEC LE MOT DE PASSE DU SERVEUR ! + SERVER_NAME: 'palworld-server-docker par Thijs van Loef' + SERVER_DESCRIPTION: 'palworld-server-docker par Thijs van Loef' + volumes: + - ./palworld:/palworld/ +``` + +En alternative, vous pouvez copier le fichier [.env.example](.env.example) dans un nouveau fichier appelé **.env**. +Modifiez-le selon vos besoins, consultez la section [environment variables](#variables-d-environnement) pour vérifier les +valeurs correctes. Modifiez votre fichier [docker-compose.yml](docker-compose.yml) comme suit : + +```yml +services: + palworld: + image: thijsvanloef/palworld-server-docker:latest + restart: unless-stopped + container_name: palworld-server + stop_grace_period: 30s # Réglez selon le temps que vous êtes prêt à attendre pour l'arrêt gracieux du conteneur + ports: + - 8211:8211/udp + - 27015:27015/udp + env_file: + - .env + volumes: + - ./palworld:/palworld/ +``` + +### Docker Run + +Changez chaque <> par votre propre configuration + +```bash +docker run -d \ + --name palworld-server \ + -p 8211:8211/udp \ + -p 27015:27015/udp \ + -v ./palworld:/palworld/ \ + -e PUID=1000 \ + -e PGID=1000 \ + -e PORT=8211 \ + -e PLAYERS=16 \ + -e MULTITHREADING=true \ + -e RCON_ENABLED=true \ + -e RCON_PORT=25575 \ + -e TZ=UTC \ + -e ADMIN_PASSWORD="adminPasswordHere" \ + -e SERVER_PASSWORD="worldofpals" \ + -e COMMUNITY=false \ + -e SERVER_NAME="palworld-server-docker by Thijs van Loef" \ + -e SERVER_DESCRIPTION="palworld-server-docker by Thijs van Loef" \ + --restart unless-stopped \ + --stop-timeout 30 \ + thijsvanloef/palworld-server-docker:latest +``` + +En alternative, vous pouvez copier le fichier [.env.example](.env.example) dans un nouveau fichier appelé **.env**. +Modifiez-le selon vos besoins, consultez la section [environment variables](#variables-d-environnement) pour vérifier +les valeurs correctes. Modifiez votre commande docker run comme suit: + +```bash +docker run -d \ + --name palworld-server \ + -p 8211:8211/udp \ + -p 27015:27015/udp \ + -v ./palworld:/palworld/ \ + --env-file .env \ + --restart unless-stopped \ + --stop-timeout 30 \ + thijsvanloef/palworld-server-docker:latest +``` + +### Kubernetes + +Tous les fichiers dont vous aurez besoin pour déployer ce conteneur sur Kubernetes se trouvent dans le dossier [k8s](k8s/). + +Suivez les étapes dans le [README.md ici](k8s/readme.md) pour le déployer. + +### Exécution sans les droits root + +Ceci est réservé aux utilisateurs avancés. + +Il est possible d'exécuter ce conteneur et de [remplacer l'utilisateur par défaut](https://docs.docker.com/engine/reference/run/#user) +qui est root dans cette image. + +Étant donné que vous spécifiez l'utilisateur et le groupe, `PUID` et `PGID` sont ignorés. + +Si vous souhaitez trouver votre UID : `id -u` +Si vous souhaitez trouver votre GID : `id -g` + +Vous devez définir l'utilisateur sur `UID_NUMÉRIQUE:GID_NUMÉRIQUE` + +Ci-dessous, nous supposons que votre UID est 1000 et votre GID est 1001. + +- Dans la commande docker run, ajoutez `--user 1000:1001 \` au-dessus de la dernière ligne. +- Dans le fichier docker-compose, ajoutez `user: 1000:1001` au-dessus des ports. + +Si vous souhaitez l'exécuter avec un UID/GID différent du vôtre, vous devrez changer la +propriété du répertoire qui est monté : `chown UID:GID palworld/` +ou en changeant les permissions pour tous les autres : `chmod o=rwx palworld/` + +#### Utilisation du chart Helm + +Le chart Helm officiel peut être trouvé dans un dépôt séparé, [palworld-server-chart](https://github.com/Twinki14/palworld-server-chart) + +### Variables d environnement + +Vous pouvez utiliser les valeurs suivantes pour modifier les paramètres du serveur au démarrage. +Il est fortement recommandé de définir les valeurs d'environnement suivantes avant de démarrer le serveur : + +- PLAYERS +- PORT +- PUID +- PGID + +| Variable | Info | Valeurs par défaut | Valeurs autorisées | +| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | +| TZ | Fuseau horaire utilisé pour dater la sauvegarde du serveur | UTC | Voir [Identifiants TZ](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#Time_Zone_abbreviations) | +| PLAYERS\* | Nombre maximal de joueurs pouvant rejoindre le serveur | 16 | 1-32 | +| PORT\* | Port UDP exposé par le serveur | 8211 | 1024-65535 | +| PUID\* | UID de l'utilisateur sous lequel le serveur doit s'exécuter | 1000 | !0 | +| PGID\* | GID du groupe sous lequel le serveur doit s'exécuter | 1000 | !0 | +| MULTITHREADING\*\* | Améliore les performances dans les environnements CPU multi-threadés. Elle est efficace jusqu'à un maximum d'environ 4 threads, et allouer plus que ce nombre de threads n'a pas beaucoup de sens. | false | true/false | +| COMMUNITY | Si le serveur apparaît ou non dans le navigateur de serveurs communautaires (À UTILISER AVEC SERVER_PASSWORD) | false | true/false | +| PUBLIC_IP | Vous pouvez spécifier manuellement l'adresse IP globale du réseau sur lequel le serveur est en cours d'exécution. Sinon, elle sera détectée automatiquement. Si cela ne fonctionne pas bien, essayez une configuration manuelle. | | x.x.x.x | +| PUBLIC_PORT | Vous pouvez spécifier manuellement le numéro de port du réseau sur lequel le serveur est en cours d'exécution. Sinon, il sera détecté automatiquement. Si cela ne fonctionne pas bien, essayez une configuration manuelle. | | 1024-65535 | +| SERVER_NAME | Un nom pour votre serveur | | "chaîne" | +| SERVER_DESCRIPTION | La description de votre serveur | | "chaîne" | +| SERVER_PASSWORD | Sécurisez votre serveur communautaire avec un mot de passe | | "chaîne" | +| ADMIN_PASSWORD | Sécurisez l'accès à l'administration du serveur avec un mot de passe | | "chaîne" | +| UPDATE_ON_BOOT\*\* | Mettre à jour/Installer le serveur lorsque le conteneur Docker démarre (CELÀ DOIT ÊTRE ACTIVÉ LA PREMIÈRE FOIS QUE VOUS EXÉCUTEZ LE CONTENEUR) | true | true/false | +| RCON_ENABLED\*\*\* | Activer RCON pour le serveur Palworld | true | true/false | +| RCON_PORT | Port RCON pour se connecter | 25575 | 1024-65535 | +| QUERY_PORT | Port de requête utilisé pour communiquer avec les serveurs Steam | 27015 | 1024-65535 | +| BACKUP_CRON_EXPRESSION | Le paramètre affecte la fréquence des sauvegardes automatiques. | 0 0 \* \* \* | Nécessite une expression Cron - Voir [Configuration des sauvegardes automatiques avec Cron](#configuration-des-sauvegardes-automatiques-avec-cron) | +| BACKUP_ENABLED | Active les sauvegardes automatiques | true | true/false | +| DELETE_OLD_BACKUPS | Supprime les sauvegardes après un certain nombre de jours | false | true/false | +| OLD_BACKUP_DAYS | Combien de jours conserver les sauvegardes | 30 | tout entier positif | +| AUTO_UPDATE_CRON_EXPRESSION | Le paramètre affecte la fréquence des mises à jour automatiques. | 0 \* \* \* \* | Nécessite une expression Cron - Voir [Configuration des sauvegardes automatiques avec Cron](#configuration-des-sauvegardes-automatiques-avec-cron) | +| AUTO_UPDATE_ENABLED | Active les mises à jour automatiques | false | true/false | +| AUTO_UPDATE_WARN_MINUTES | Temps d'attente avant de mettre à jour le serveur, après que les joueurs ont été informés. (Cela sera ignoré s'il n'y a pas de joueurs connectés) | 30 | Entier | +| AUTO_REBOOT_CRON_EXPRESSION | Le paramètre affecte la fréquence des mises à jour automatiques. | 0 0 \* \* \* | Nécessite une expression Cron - Voir [Configuration des sauvegardes automatiques avec Cron](#configuration-des-redémarrages-automatiques-avec-cron) | +| AUTO_REBOOT_ENABLED | Active les redémarrages automatiques | false | true/false | +| AUTO_REBOOT_WARN_MINUTES | Temps d'attente avant de redémarrer le serveur, après que les joueurs ont été informés. | 5 | Entier | +| AUTO_REBOOT_EVEN_IF_PLAYERS_ONLINE | Redémarrez le serveur même s'il y a des joueurs en ligne. | false | true/false | +| TARGET_MANIFEST_ID | Verrouille la version du jeu en correspondance avec l'ID de manifeste de Steam Download Depot. | | Voir [Tableau des ID de manifeste](#tableau-des-versions-vers-les-id-de-manifeste) | +| DISCORD_WEBHOOK_URL | URL du webhook Discord trouvée après la création d'un webhook sur un serveur Discord | | `https://discord.com/api/webhooks/` | +| DISCORD_CONNECT_TIMEOUT | Délai de connexion initial de la commande Discord | 30 | !0 | +| DISCORD_MAX_TIMEOUT | Délai total du webhook Discord | 30 | !0 | +| DISCORD_PRE_UPDATE_BOOT_MESSAGE | Message Discord envoyé lorsque le serveur commence à se mettre à jour | Le serveur est en cours de mise à jour... | "chaîne" | +| DISCORD_POST_UPDATE_BOOT_MESSAGE | Message Discord envoyé lorsque le serveur a terminé de se mettre à jour | Mise à jour du serveur terminée ! | "chaîne" | +| DISCORD_PRE_START_MESSAGE | Message Discord envoyé lorsque le serveur commence à démarrer | Le serveur est démarré ! | "chaîne" | +| DISCORD_PRE_SHUTDOWN_MESSAGE | Message Discord envoyé lorsque le serveur commence à s'arrêter | Le serveur est en cours d'arrêt... | "chaîne" | +| DISCORD_POST_SHUTDOWN_MESSAGE | Message Discord envoyé lorsque le serveur s'est arrêté | Le serveur est arrêté ! | "chaîne" | +| DISABLE_GENERATE_SETTINGS | S'il faut générer automatiquement le fichier PalWorldSettings.ini | false | true/false | +| DISABLE_GENERATE_ENGINE | S'il faut générer automatiquement le fichier Engine.ini | true | true/false | +| ENABLE_PLAYER_LOGGING | Active la journalisation et l'annonce des entrées et sorties de joueurs | true | true/false | +| PLAYER_LOGGING_POLL_PERIOD | Période de sondage (en secondes) pour vérifier les joueurs qui ont rejoint ou quitté | 5 | !0 | + +\* Hautement recommandé à définir + +\*\* Assurez-vous de savoir ce que vous faites lorsque vous exécutez cette option activée + +\*\*\* Nécessaire pour que `docker stop` enregistre et ferme gracieusement le serveur + +### Ports du jeu + +| Port | Info | +| ----- | --------------------- | +| 8211 | Port du jeu (UDP) | +| 27015 | Port de requête (UDP) | +| 25575 | Port RCON (TCP) | + +## Utilisation de RCON + +RCON est activé par défaut pour l'image palworld-server-docker. +Ouvrir la CLI RCON est assez simple : + +```bash +docker exec -it palworld-server rcon-cli " " +``` + +Par exemple, vous pouvez diffuser un message à tout le monde dans le serveur avec la commande suivante : + +```bash +docker exec -it palworld-server rcon-cli "Broadcast Bonjour à tous" +``` + +Cela ouvrira une interface en ligne de commande utilisant RCON pour envoyer des commandes au serveur Palworld. + +### Liste des commandes du serveur + +| Command | Info | +| ------------------------------------ | --------------------------------------------------------- | +| Shutdown {Secondes} {TexteDuMessage} | Le serveur s'arrête après le nombre de secondes spécifié | +| DoExit | Arrêt forcé du serveur. | +| Broadcast | Envoyer un message à tous les joueurs dans le serveur | +| KickPlayer {SteamID} | Expulser un joueur du serveur. | +| BanPlayer {SteamID} | Bannir un joueur du serveur. | +| TeleportToPlayer {SteamID} | Téléporter à l'emplacement actuel du joueur ciblé. | +| TeleportToMe {SteamID} | Téléporter le joueur ciblé à votre emplacement actuel | +| ShowPlayers | Afficher les informations sur tous les joueurs connectés. | +| Info | Afficher les informations du serveur. | +| Save | Sauvegarder les données du monde. | + +Pour une liste complète des commandes, consultez : [https://tech.palworldgame.com/server-commands](https://tech.palworldgame.com/server-commands) + +## Création d'une sauvegarde + +Pour créer une sauvegarde de la progression actuelle du jeu, utilisez la commande : + +```bash +docker exec palworld-server backup +``` + +Cela créera une sauvegarde dans `/palworld/backups/` + +Le serveur effectuera une sauvegarde avant la sauvegarde si RCON est activé. + +## Restauration à partir d'une sauvegarde + +Pour restaurer à partir d'une sauvegarde, utilisez la commande : + +```bash +docker exec -it palworld-server restore +``` + +La variable d'environnement `RCON_ENABLED` doit être définie sur `true` pour utiliser cette commande. + +> [!IMPORTANT] +> Si la redémarrage de Docker n'est pas configuré avec la politique `always` ou `unless-stopped` +> le serveur s'éteindra et devra être redémarré manuellement. +> +> La commande docker run exemple et le fichier docker-compose dans [Comment utiliser](#comment-utiliser) +> utilisent déjà la politique nécessaire + +## Restauration manuelle à partir d'une sauvegarde + +Localisez la sauvegarde que vous souhaitez restaurer dans `/palworld/backups/` et décompressez-la. +Vous devez arrêter le serveur avant de continuer. + +```bash +docker compose down +``` + +Supprimez l'ancien dossier de données sauvegardées situé à `palworld/Pal/Saved/SaveGames/0/`. + +Copiez le contenu du nouveau dossier de données sauvegardées décompressé `Saved/SaveGames/0/` to `palworld/Pal/Saved/SaveGames/0/`. + +Remplacez le nom DedicatedServerName à l'intérieur de `palworld/Pal/Saved/Config/LinuxServer/GameUserSettings.ini` +par le nouveau nom de dossier. + +```ini +DedicatedServerName= # Remplacez-le par votre nom de dossier. +``` + +Redémarrez le jeu. (Si vous utilisez Docker Compose) + +```bash +docker compose up -d +``` + +## Configuration des Sauvegardes Automatiques avec Cron + +Le serveur est automatiquement sauvegardé chaque nuit à minuit, selon le fuseau horaire défini avec TZ. + +Définissez BACKUP_ENABLED pour activer ou désactiver les sauvegardes automatiques (par défaut, c'est activé). + +BACKUP_CRON_EXPRESSION est une expression cron, où vous définissez un intervalle pour l'exécution des tâches. + +> [!TIP] +> Cette image utilise Supercronic pour les tâches cron +> voir [supercronic](https://github.com/aptible/supercronic#crontab-format) +> ou +> [Crontab Generator](https://crontab-generator.org). + +Définissez BACKUP_CRON_EXPRESSION pour changer la planification par défaut. +Exemple d'utilisation : Si BACKUP_CRON_EXPRESSION est défini sur `0 2 * * *`, le script de sauvegarde +s'exécutera tous les jours à 2h00 du matin. + +## Configuration des Mises à Jour Automatiques avec Cron + +Pour pouvoir utiliser les mises à jour automatiques avec ce serveur, les variables d'environnement +suivantes **doivent** être définies sur `true`: + +- RCON_ENABLED +- UPDATE_ON_BOOT + +> [!IMPORTANT] +> +> Si le redémarrage de Docker n'est pas configuré avec la politique `always` ou `unless-stopped` +> le serveur s'éteindra et devra être +> redémarré manuellement. +> +> La commande docker run exemple et le fichier docker-compose dans [Comment utiliser](#comment-utiliser) +> utilisent déjà la politique nécessaire + +Définissez AUTO_UPDATE_ENABLED pour activer ou désactiver les mises à jour automatiques (par défaut, c'est désactivé). + +AUTO_UPDATE_CRON_EXPRESSION est une expression cron, où vous définissez un intervalle pour l'exécution des tâches. + +> [!TIP] +> Cette image utilise Supercronic pour les tâches cron +> voir [supercronic](https://github.com/aptible/supercronic#crontab-format) +> ou +> [Crontab Generator](https://crontab-generator.org). + +Définissez AUTO_UPDATE_CRON_EXPRESSION pour changer la planification par défaut. + +## Configuration des Redémarrages Automatiques avec Cron + +Pour pouvoir utiliser les redémarrages automatiques avec ce serveur, RCON_ENABLED doit être activé. + +> [!IMPORTANT] +> +> Si le redémarrage de Docker n'est pas configuré avec la politique `always` ou `unless-stopped` +> le serveur s'éteindra et devra être +> redémarré manuellement. +> +> La commande docker run exemple et le fichier docker-compose dans [Comment utiliser](#comment-utiliser) +> utilisent déjà la politique nécessaire + +Définissez AUTO_REBOOT_ENABLED pour activer ou désactiver les redémarrages automatiques (par défaut, c'est désactivé). + +AUTO_REBOOT_CRON_EXPRESSION est une expression cron, où vous définissez un intervalle pour l'exécution des tâches. + +> [!TIP] +> Cette image utilise Supercronic pour les tâches cron +> voir [supercronic](https://github.com/aptible/supercronic#crontab-format) +> ou +> [Crontab Generator](https://crontab-generator.org). + +Définissez AUTO_REBOOT_CRON_EXPRESSION pour changer la planification par défaut, qui est tous les soirs à minuit selon le +fuseau horaire défini avec TZ. + +## Modification des paramètres du serveur + +### Avec des variables d'environnement + +> [!IMPORTANT] +> +> Ces variables d'environnement/paramètres sont susceptibles de changer car le jeu est encore en version bêta. +> Consultez la [page officielle pour les paramètres pris en charge.](https://tech.palworldgame.com/optimize-game-balance) + +La conversion des paramètres du serveur en variables d'environnement suit les mêmes principes (avec quelques exceptions): + +- toutes en majuscules +- séparation des mots par l'insertion d'un trait de soulignement +- suppression de la lettre unique si le paramètre commence par une (comme 'b') + +Par exemple : + +- Difficulty -> DIFFICULTY +- PalSpawnNumRate -> PAL_SPAWN_NUM_RATE +- bIsPvP -> IS_PVP + +| Variable | Description | Valeur par défaut | Valeur autorisée | +| ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | ---------------------------------------------- | +| DIFFICULTY | Difficulté du jeu | Aucune | `Aucune`, `Normal`, `Difficile` | +| DAYTIME_SPEEDRATE | Vitesse du jour - Un nombre plus grand signifie des journées plus courtes | 1,000000 | Flottant | +| NIGHTTIME_SPEEDRATE | Vitesse de la nuit - Un nombre plus grand signifie des nuits plus courtes | 1,000000 | Flottant | +| EXP_RATE | Taux de gain d'EXP | 1,000000 | Flottant | +| PAL_CAPTURE_RATE | Taux de capture de Pal | 1,000000 | Flottant | +| PAL_SPAWN_NUM_RATE | Taux d'apparition des Pals | 1,000000 | Flottant | +| PAL_DAMAGE_RATE_ATTACK | Multiplicateur des dégâts infligés par les Pals | 1,000000 | Flottant | +| PAL_DAMAGE_RATE_DEFENSE | Multiplicateur des dégâts subis par les Pals | 1,000000 | Flottant | +| PLAYER_DAMAGE_RATE_ATTACK | Multiplicateur des dégâts infligés par le joueur | 1,000000 | Flottant | +| PLAYER_DAMAGE_RATE_DEFENSE | Multiplicateur des dégâts subis par le joueur | 1,000000 | Flottant | +| PLAYER_STOMACH_DECREASE_RATE | Taux de déplétion de la faim du joueur | 1,000000 | Flottant | +| PLAYER_STAMINA_DECREASE_RATE | Taux de réduction de la stamina du joueur | 1,000000 | Flottant | +| PLAYER_AUTO_HP_REGEN_RATE | Taux de régénération automatique des PV du joueur | 1,000000 | Flottant | +| PLAYER_AUTO_HP_REGEN_RATE_IN_SLEEP | Taux de régénération automatique des PV du joueur pendant le sommeil | 1,000000 | Flottant | +| PAL_STOMACH_DECREASE_RATE | Taux de déplétion de la faim des Pals | 1,000000 | Flottant | +| PAL_STAMINA_DECREASE_RATE | Taux de réduction de la stamina des Pals | 1,000000 | Flottant | +| PAL_AUTO_HP_REGEN_RATE | Taux de régénération automatique des PV des Pals | 1,000000 | Flottant | +| PAL_AUTO_HP_REGEN_RATE_IN_SLEEP | Taux de régénération automatique de la santé des Pals (dans la Palbox) | 1,000000 | Flottant | +| BUILD_OBJECT_DAMAGE_RATE | Multiplicateur des dégâts aux structures | 1,000000 | Flottant | +| BUILD_OBJECT_DETERIORATION_DAMAGE_RATE | Taux de détermination de la structure | 1,000000 | Flottant | +| COLLECTION_DROP_RATE | Multiplicateur d'objets collectables | 1,000000 | Flottant | +| COLLECTION_OBJECT_HP_RATE | Multiplicateur de la santé des objets collectables | 1,000000 | Flottant | +| COLLECTION_OBJECT_RESPAWN_SPEED_RATE | Taux d'intervalle de réapparition des objets collectables - Plus le nombre est petit, plus la régénération est rapide | 1,000000 | Flottant | +| ENEMY_DROP_ITEM_RATE | Multiplicateur d'objets abandonnés par les ennemis | 1,000000 | Flottant | +| DEATH_PENALTY | Pénalité de mort
Aucune : Pas de pénalité de mort
Objet : Lâche des objets autres que l'équipement
ObjetEtÉquipement : Lâche tous les objets
Tous : Lâche tous les Pals et tous les objets | Tous | `Aucune`, `Objet`, `ObjetEtÉquipement`, `Tous` | +| ENABLE_PLAYER_TO_PLAYER_DAMAGE | Permet aux joueurs de causer des dégâts aux autres joueurs | Faux | Booléen | +| ENABLE_FRIENDLY_FIRE | Autoriser les tirs amis | Faux | Booléen | +| ENABLE_INVADER_ENEMY | Activer les envahisseurs | Vrai | Booléen | +| ACTIVE_UNKO | Activer UNKO (?) | Faux | Booléen | +| ENABLE_AIM_ASSIST_PAD | Activer l'assistance à la visée du contrôleur | Vrai | Booléen | +| ENABLE_AIM_ASSIST_KEYBOARD | Activer l'assistance à la visée du clavier | Faux | Booléen | +| DROP_ITEM_MAX_NUM | Nombre maximal de largages dans le monde | 3000 | Entier | +| DROP_ITEM_MAX_NUM_UNKO | Nombre maximal de largages UNKO dans le monde | 100 | Entier | +| BASE_CAMP_MAX_NUM | Nombre maximal de camps de base | 128 | Entier | +| BASE_CAMP_WORKER_MAX_NUM | Nombre maximal de travailleurs | 15 | Entier | +| DROP_ITEM_ALIVE_MAX_HOURS | Temps avant la disparition des objets en heures | 1,000000 | Flottant | +| AUTO_RESET_GUILD_NO_ONLINE_PLAYERS | Réinitialiser automatiquement la guilde lorsqu'aucun joueur n'est en ligne | Faux | Booléen | +| AUTO_RESET_GUILD_TIME_NO_ONLINE_PLAYERS | Temps pour réinitialiser automatiquement la guilde lorsqu'aucun joueur n'est en ligne | 72,000000 | Flottant | +| GUILD_PLAYER_MAX_NUM | Nombre maximum de joueurs dans une guilde | 20 | Entier | +| PAL_EGG_DEFAULT_HATCHING_TIME | Temps (h) pour incuber un œuf massif | 72,000000 | Flottant | +| WORK_SPEED_RATE | Multiplicateur de la vitesse de travail | 1,000000 | Flottant | +| IS_MULTIPLAY | Activer le multijoueur | Faux | Booléen | +| IS_PVP | Activer le PVP | Faux | Booléen | +| CAN_PICKUP_OTHER_GUILD_DEATH_PENALTY_DROP | Autoriser les joueurs d'autres guildes à ramasser les objets de pénalité de mort | Faux | Booléen | +| ENABLE_NON_LOGIN_PENALTY | Activer la pénalité hors connexion | Vrai | Booléen | +| ENABLE_FAST_TRAVEL | Activer le déplacement rapide | Vrai | Booléen | +| IS_START_LOCATION_SELECT_BY_MAP | Activer la sélection de l'emplacement de départ | Vrai | Booléen | +| EXIST_PLAYER_AFTER_LOGOUT | Bascule pour supprimer les joueurs lorsqu'ils se déconnectent | Faux | Booléen | +| ENABLE_DEFENSE_OTHER_GUILD_PLAYER | Permet la défense contre les joueurs d'autres guildes | Faux | Booléen | +| COOP_PLAYER_MAX_NUM | Nombre maximum de joueurs dans une guilde | 4 | Entier | +| REGION | Région | | Chaîne de caractères | +| USEAUTH | Utiliser l'authentification | Vrai | Booléen | +| BAN_LIST_URL | Liste des interdictions à utiliser | [https://api.palworldgame.com/api/banlist.txt](https://api.palworldgame.com/api/banlist.txt) | Chaîne de caractères | +| SHOW_PLAYER_LIST | Activer l'affichage de la liste des joueurs | Vrai | Booléen | + +### Manuellement + +Lorsque le serveur démarre, un fichier `PalWorldSettings.ini` sera créé à l'emplacement suivant : `/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini` + +Veuillez noter que les variables d'environnement (ENV) écraseront toujours les modifications apportées à `PalWorldSettings.ini`. + +> [!IMPORTANT] +> Les changements ne peuvent être apportés à `PalWorldSettings.ini` que lorsque le serveur est éteint. +> +> Toutes les modifications apportées pendant que le serveur est en cours d'exécution seront écrasées lors de l'arrêt du serveur. + +Pour une liste plus détaillée des paramètres du serveur, consultez : [Palworld Wiki](https://palworld.wiki.gg/wiki/PalWorldSettings.ini) + +Pour des explications plus détaillées sur les paramètres du serveur, consultez : [shockbyte](https://shockbyte.com/billing/knowledgebase/1189/How-to-Configure-your-Palworld-server.html) + +## Utilisation de webhooks Discord + +1. Générez une URL de webhook pour votre serveur Discord dans les paramètres de votre serveur Discord. + +2. Configurez la variable d'environnement avec le jeton unique à la fin de l'exemple d'URL de webhook Discord : `https://discord.com/api/webhooks/1234567890/abcde` + +Envoyez des messages Discord avec docker run : + +```sh +-e DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/1234567890/abcde" \ +-e DISCORD_PRE_UPDATE_BOOT_MESSAGE="Le serveur est en cours de mise à jour..." \ + +``` + +Envoyez des messages Discord avec docker compose : + +```yaml +- DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/1234567890/abcde +- DISCORD_PRE_UPDATE_BOOT_MESSAGE=Le serveur est en cours de mise à jour... +``` + +## Verrouiller une Version Spécifique du Jeu + +> [!WARNING] +> Rétrograder vers une version inférieure du jeu est possible, mais on ne sait pas quel impact +> cela aura sur les sauvegardes existantes. +> +> **Faites-le à vos propres risques !** + +Si la variable d'environnement **TARGET_MANIFEST_ID** est définie, elle verrouillera la version +du serveur sur un manifeste spécifique. +Le manifeste correspond aux dates de sortie/mises à jour. Les manifestes peuvent être trouvés +à l'aide de SteamCMD ou de sites web comme [SteamDB](https://steamdb.info/depot/2394012/manifests/). + +### Tableau des Versions Vers les ID de Manifeste + +| Version | ID de Manifeste | +| ------- | ------------------- | +| 1.3.0 | 1354752814336157338 | +| 1.4.0 | 4190579964382773830 | +| 1.4.1 | 6370735655629434989 | +| 1.5.0 | 3750364703337203431 | +| 1.5.1 | 2815085007637542021 | + +## Signalement de Problèmes/Demandes de Fonctionnalités + +Les problèmes/Demandes de fonctionnalités peuvent être soumis en utilisant [ce lien](https://github.com/thijsvanloef/palworld-server-docker/issues/new/choose). + +### Problèmes Connus + +Les problèmes connus sont répertoriés dans la [documentation](https://palworld-server-docker.loef.dev/known-issues/) diff --git a/docs/kr/README.md b/docs/kr/README.md index 13f317fa7..4010da2b8 100644 --- a/docs/kr/README.md +++ b/docs/kr/README.md @@ -1,5 +1,9 @@ # Palworld 전용 서버 도커 +## ⚠️These docs will be deprecated and removed on March 31 2024⚠️ + +Please use the official docs: [https://palworld-server-docker.loef.dev/](https://palworld-server-docker.loef.dev/ko/) + [![Release](https://img.shields.io/github/v/release/thijsvanloef/palworld-server-docker)](https://github.com/thijsvanloef/palworld-server-docker/releases) [![Docker Pulls](https://img.shields.io/docker/pulls/thijsvanloef/palworld-server-docker)](https://hub.docker.com/r/thijsvanloef/palworld-server-docker) [![Docker Stars](https://img.shields.io/docker/stars/thijsvanloef/palworld-server-docker)](https://hub.docker.com/r/thijsvanloef/palworld-server-docker) @@ -34,7 +38,7 @@ 다음 스폰서들에게 큰 박수를 보냅니다!

-ShoeBoom  doomhound188  AshishT112203  pabumake   +doomhound188  AshishT112203  pabumake  stoprx  KiKoS0  inspired-by-nudes  PulsarFTW  

## Official Documentation @@ -161,15 +165,39 @@ docker run -d \ 공식 Helm 차트는 별도의 저장소에서 찾을 수 있습니다, [palworld-server-chart](https://github.com/Twinki14/palworld-server-chart) +### 루트권한 없이 실행하기 + +해당 항목은 고급사용자를 위한 항목입니다. + +해당 컨테이너는 [기본사용자 덮어씌우기](https://docs.docker.com/engine/reference/run/#user)가 가능합니다. 해당 이미지의 기본사용자는 루트입니다. + +사용자가 유저와 그룹을 설정하기 떄문에 `PUID`와 `PGID`가 무시됩니다. + +UID를 찾으려면: `id -u`를 사용합니다. +GID를 찾으려면: `id -g`를 사용합니다. + +반드시 유저를 `NUMBERICAL_UID:NUMBERICAL_GID`와 같이 설정하셔야합니다. + +아래는 UID를 1000으로 GID를 1001로 가정해 작성된 예제문입니다. + +* docker run에서 `--user 1000:1001 \`를 마지막 줄위에 추가하세요. +* docker compose에서 `user: 1000:1001`를 포트설정위에 추가하세요. + +만약 다른 UID/GID를 사용해 실행하려면 디렉토리의 소유권을 변경해야합니다: `chown UID:GID palworld/` 또는 모든 계정의 권한를 수정하셔야합니다: `chmod o=rwx palworld/` + +#### helm chart 사용 + +공식 helm chart 사용법은 다른 리포지토리에 있습니다, [palworld-server-chart](https://github.com/Twinki14/palworld-server-chart) + ### 환경 변수 다음 값을 사용하여 부팅 시 서버의 설정을 변경할 수 있습니다. 서버를 시작하기 전에 다음 환경 변수를 설정하는 것이 좋습니다: -- PLAYERS -- PORT -- PUID -- PGID +* PLAYERS +* PORT +* PUID +* PGID | 변수명 | 정보 | 기본값 | 허용되는 값 | | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------ | @@ -200,6 +228,8 @@ docker run -d \ | AUTO_REBOOT_CRON_EXPRESSION | 자동 서버 재부팅 주기 | 0 0 \* \* \* | Cron 표현식 필요 - [cron을 이용한 자동 재부팅 설정](#cron을-이용한-자동-재부팅-설정) 참조 | | AUTO_REBOOT_ENABLED | 자동 서버 재부팅 활성화 여부 | false | true/false | | AUTO_REBOOT_WARN_MINUTES | 재부팅 대기 시간 설정(분), 이때 사용자는 분 단위로 서버 종료에 대한 알림을 받습니다. | 5 | !0 | +| AUTO_REBOOT_EVEN_IF_PLAYERS_ONLINE | 온라인 사용자가 있어도 재시작. | false | true/false | +| TARGET_MANIFEST_ID | 게임의 버젼을 스팀 다운로드 디포의 해당 Manifest ID로 고정. | | [Manifest ID Table](#버전별Manifest ID표) 보 | | DISCORD_WEBHOOK_URL | 디스코드 웹훅 URL | | `https://discord.com/api/webhooks/` | | DISCORD_CONNECT_TIMEOUT | 디스코드 명령 초기 연결 시간 초과 | 30 | !0 | | DISCORD_MAX_TIMEOUT | Discord 총 훅 시간 초과 | 30 | !0 | @@ -209,6 +239,9 @@ docker run -d \ | DISCORD_PRE_SHUTDOWN_MESSAGE | 서버가 종료되기 시작할 때 전송되는 디스코드 메시지 | Server is shutting down... | "string" | | DISCORD_POST_SHUTDOWN_MESSAGE | 서버가 멈췄을 때 전송되는 디스코드 메시지 | Server is stopped! | "string" | | DISABLE_GENERATE_SETTINGS | 자동으로 PalWorldSettings.ini를 생성할지 여부 | false | true/false | +| DISABLE_GENERATE_ENGINE | 자동으로 Engine.ini를 생성할지 여부 | true | true/false | +| ENABLE_PLAYER_LOGGING | 플레이어가 접속 또는 종료시 로깅과 공지를 활성화 | true | true/false | +| PLAYER_LOGGING_POLL_PERIOD | 플레이어의 접속과 종료를 확인하기위한 폴링시간(초) 설정| 5 | !0 | *설정하는 것을 적극 권장합니다. @@ -255,7 +288,7 @@ docker exec -it palworld-server rcon-cli "Broadcast Hello everyone" | Info | 서버 정보를 표시합니다. | | Save | 월드 정보를 저장합니다. | -전체 명령어 목록을 보려면 다음으로 이동하세요: [https://tech.palworldgame.com/server-commands](https://tech.palworldgame.com/server-commands) +전체 명령어 목록을 보려면 다음으로 이동하세요: [https://tech.palworldgame.com/settings-and-operation/commands](https://tech.palworldgame.com/settings-and-operation/commands) ## 백업 만들기 @@ -329,8 +362,8 @@ BACKUP_CRON_EXPRESSION을 설정하여 기본 스케줄을 변경합니다. 이 서버에서 자동 업데이트를 사용하려면 다음 환경 변수들을 `true`로 **설정해야 합니다**: -- RCON_ENABLED -- UPDATE_ON_BOOT +* RCON_ENABLED +* UPDATE_ON_BOOT > [!IMPORTANT] > 도커 `restart` 정책이 `always` 또는 `unless-stopped`로 설정 되어있지 않다면, 서버는 종료되고 @@ -380,15 +413,15 @@ AUTO_REBOOT_CRON_EXPRESSION을 설정하여 기본 스케줄을 변경하세요. 서버 설정을 환경 변수로 바꾸는 과정은 다음과 같은 규칙을 따릅니다 (몇가지 예외 있음): -- 모두 대문자로 작성 -- 밑줄을 삽입하여 단어를 분할 -- 한 글자로 시작하는 설정(예: 'b')의 경우 그 한 글자를 제거 +* 모두 대문자로 작성 +* 밑줄을 삽입하여 단어를 분할 +* 한 글자로 시작하는 설정(예: 'b')의 경우 그 한 글자를 제거 아래는 예시입니다: -- Difficulty -> DIFFICULTY -- PalSpawnNumRate -> PAL_SPAWN_NUM_RATE -- bIsPvP -> IS_PVP +* Difficulty -> DIFFICULTY +* PalSpawnNumRate -> PAL_SPAWN_NUM_RATE +* bIsPvP -> IS_PVP | 변수 | 설명 | 기본값 | 허용값 | |-------------------------------------------|----------------------------------------------------------------|----------------------------------------------------------------------------------------------|----------------------------------------| @@ -445,6 +478,7 @@ AUTO_REBOOT_CRON_EXPRESSION을 설정하여 기본 스케줄을 변경하세요. | REGION | Region | | String | | USEAUTH | 인증 사용 여부 | True | Boolean | | BAN_LIST_URL | 사용할 BAN 목록 | [https://api.palworldgame.com/api/banlist.txt](https://api.palworldgame.com/api/banlist.txt) | string | +| SHOW_PLAYER_LIST | Enable show player list | True | Boolean | ### 수동 설정 @@ -486,6 +520,26 @@ docker compose로 디스코드 메시지 보내기: - DISCORD_PRE_UPDATE_BOOT_MESSAGE=Server is updating... ``` +## 게임버전 고정하기 + +>[!WARNING] +>다운그레이딩이 가능하나 세이브 파일에 어떠한 영향이 있을지 알 수 없습니다. +> +>**본인의 책임하에 하세요!** + +만약 **TARGET_MANIFEST_ID** 환경변수가 정해졌다면, 서버의 버전은 특정 manifest로 고정됩니다. +Manifest는 게임의 릴리즈 시간/업데이트 버젼에 따라 정해집니다. Manifest는 SteamCMD나 [SteamDB](https://steamdb.info/depot/2394012/manifests/)와 +같은 웹사이트에서 검색가능합니다. + +### 버전별 Manifest ID 표 + +| Version | Manifest ID | +|---------|----------------------| +| 1.3.0 | 1354752814336157338 | +| 1.4.0 | 4190579964382773830 | +| 1.4.1 | 6370735655629434989 | +| 1.5.0 | 3750364703337203431 | + ## 이슈/기능 요청 문제/기능 요청은 다음 [링크](https://github.com/thijsvanloef/palworld-server-docker/issues/new/choose)에서 제출할 수 있습니다. diff --git a/docs/readme.md b/docs/readme.md new file mode 100644 index 000000000..886c3e9f3 --- /dev/null +++ b/docs/readme.md @@ -0,0 +1,3 @@ +# These docs will be deprecated on March 31 2024 + +Please use the official docs: [https://palworld-server-docker.loef.dev/](https://palworld-server-docker.loef.dev/) diff --git a/docs/zh-CN/README.md b/docs/zh-CN/README.md index 780b7ee86..891d7eeda 100644 --- a/docs/zh-CN/README.md +++ b/docs/zh-CN/README.md @@ -1,5 +1,9 @@ # Palworld Dedicated Server Docker +## ⚠️These docs will be deprecated and removed on March 31 2024⚠️ + +Please use the official docs: [https://palworld-server-docker.loef.dev/](https://palworld-server-docker.loef.dev/zh/) + [![Release](https://img.shields.io/github/v/release/thijsvanloef/palworld-server-docker)](https://github.com/thijsvanloef/palworld-server-docker/releases) [![Docker Pulls](https://img.shields.io/docker/pulls/thijsvanloef/palworld-server-docker)](https://hub.docker.com/r/thijsvanloef/palworld-server-docker) [![Docker Stars](https://img.shields.io/docker/stars/thijsvanloef/palworld-server-docker)](https://hub.docker.com/r/thijsvanloef/palworld-server-docker) @@ -238,7 +242,7 @@ docker exec -it palworld-server rcon-cli | Info | 显示服务器信息。 | | Save | 保存游戏。 | -请查看 [官方文档](https://tech.palworldgame.com/server-commands) 以获取所有命令。 +请查看 [官方文档](https://tech.palworldgame.com/settings-and-operation/commands) 以获取所有命令。 ## 创建备份 diff --git a/docusaurus/docs/advanced/kubernetes.md b/docusaurus/docs/advanced/kubernetes.md index 9f8ece499..65d5a038c 100644 --- a/docusaurus/docs/advanced/kubernetes.md +++ b/docusaurus/docs/advanced/kubernetes.md @@ -1,13 +1,20 @@ --- sidebar_position: 2 +title: Palworld Dedicated Server on Kubernetes +description: How to run Palworld Dedicated server on Kubernetes. +keywords: [Palworld, palworld dedicated server, Palworld Dedicated server kubernetes] +image: ../assets/Palworld_Banner.jpg +sidebar_label: Kubernetes --- + +# Palworld Dedicated Server on Kubernetes -# Kubernetes - -All files you will need to deploy this container to kubernetes are located in the [k8s folder](https://github.com/thijsvanloef/palworld-server-docker/tree/main/k8s). +How to run Palworld Dedicared server on Kubernetes. ## Setup Palworld in kubernetes +All files you will need to deploy this container to kubernetes are located in the [k8s folder](https://github.com/thijsvanloef/palworld-server-docker/tree/main/k8s). + Use the following commands to setup this Palworld container in Kubernetes: * `kubectl apply -f pvc.yaml` diff --git a/docusaurus/docs/assets/Palworld_Banner.jpg b/docusaurus/docs/assets/Palworld_Banner.jpg new file mode 100644 index 000000000..f15a095b5 Binary files /dev/null and b/docusaurus/docs/assets/Palworld_Banner.jpg differ diff --git a/docusaurus/docs/getting-started/configuration/engine-settings.md b/docusaurus/docs/getting-started/configuration/engine-settings.md new file mode 100644 index 000000000..c74100731 --- /dev/null +++ b/docusaurus/docs/getting-started/configuration/engine-settings.md @@ -0,0 +1,54 @@ +--- +sidebar_position: 3 +title: Palworld Server Engine Settings +description: How to change the Palworld Engine Settings (Engine.ini file) using Docker Environment variables. +keywords: [Palworld, palworld dedicated server, Palworld Engine.ini, palworld engine settings] +image: ../../assets/Palworld_Banner.jpg +sidebar_label: Engine Settings +--- + +# Palworld Server Engine Settings + +How to change the Palworld Engine Settings (Engine.ini file) using Docker Environment variables. + +## With Environment Variables + +:::warning +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 +* Split words by inserting an underscore +* Remove the single letter if the setting starts with one (like 'b') + +For example: + +* LanServerMaxTickRate -> LAN_SERVER_MAX_TICK_RATE +* bUseFixedFrameRate -> USE_FIXED_FRAME_RATE +* NetClientTicksPerSecond -> NET_CLIENT_TICKS_PER_SECOND + +| 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) | +| CONFIGURED_LAN_SPEED | Sets the LAN speed, ensuring LAN players can utilize maximum network capacity. | 104857600 | Integer (in bytes) | +| MAX_CLIENT_RATE | Maximum data transfer rate per client for all connections, set to a high value to prevent data capping. | 104857600 | Integer (in bytes) | +| MAX_INTERNET_CLIENT_RATE | Specifically targets internet clients, allowing for high-volume data transfer without restrictions. | 104857600 | Integer (in bytes) | +| SMOOTH_FRAME_RATE | Enables the game engine to smooth out frame rate fluctuations for a more consistent visual experience. | true | Boolean | +| SMOOTH_FRAME_RATE_UPPER_LIMIT | Sets a max target frame rate range for smoothing. | 120.000000 | Float | +| SMOOTH_FRAME_RATE_LOWER_LIMIT | Sets a min target frame rate range for smoothing. | 30.000000 | Float | +| USE_FIXED_FRAME_RATE | Enables the use of a fixed frame rate | false | Boolean | +| FIXED_FRAME_RATE | Fixed frame rate | 120.000000 | Float | +| MIN_DESIRED_FRAME_RATE | Specifies a minimum acceptable frame rate, ensuring the game runs smoothly at least at this frame rate. | 60.000000 | Float | +| NET_CLIENT_TICKS_PER_SECOND | Increases the update frequency for clients, enhancing responsiveness and reducing lag. | 120 | Integer | + +:::tip +While setting the server tickrate above to 120 fps will make some gameplay aspect smoother, +it won't fix rubber-banding and will tax your hardware significantly more. +::: diff --git a/docusaurus/docs/getting-started/configuration/game-settings.md b/docusaurus/docs/getting-started/configuration/game-settings.md index 8b4503b1a..a625a72f0 100644 --- a/docusaurus/docs/getting-started/configuration/game-settings.md +++ b/docusaurus/docs/getting-started/configuration/game-settings.md @@ -1,10 +1,15 @@ --- sidebar_position: 2 +title: Palworld Server Game Settings +description: How to change the Palworld Game Settings (PalWorldSettings.ini file) using Docker Environment variables. +keywords: [Palworld, palworld dedicated server, Palworld PalWorldSettings.ini, palworld game settings, PalWorldSettings.ini] +image: ../../assets/Palworld_Banner.jpg +sidebar_label: Game Settings --- + +# Palworld Server Game Settings -# Game Settings - -Changing Game Settings with Environment variables. +How to change the Palworld Game Settings (PalWorldSettings.ini file) using Docker Environment variables. ## With Environment Variables @@ -81,6 +86,7 @@ For example: | REGION | Region | | String | | USEAUTH | Use authentication | True | Boolean | | BAN_LIST_URL | Which ban list to use | [https://api.palworldgame.com/api/banlist.txt](https://api.palworldgame.com/api/banlist.txt) | string | +| SHOW_PLAYER_LIST | Enable show player list | True | Boolean | | TARGET_MANIFEST_ID | Locks game version to corespond with Manfiest ID from Steam Download Depot. | | See [Manifest ID Table](https://palworld-server-docker.loef.dev/guides/pinning-game-version) | | 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 | diff --git a/docusaurus/docs/getting-started/configuration/server-commands.md b/docusaurus/docs/getting-started/configuration/server-commands.md index e08335ef7..aed9afd40 100644 --- a/docusaurus/docs/getting-started/configuration/server-commands.md +++ b/docusaurus/docs/getting-started/configuration/server-commands.md @@ -1,10 +1,16 @@ --- -sidebar_position: 3 +sidebar_position: 4 +title: Palworld Dedicated Server Commands (RCON) +description: How to use Palworld Dedicated server commands to manage your server, including Kicking, Banning and teleporting players. +keywords: [Palworld, palworld dedicated server, Palworld Server Commands, Palworld server how to ban player, Palworld server how to kick player] +image: ../../assets/Palworld_Banner.jpg +sidebar_label: Server Commands (RCON) --- + +# Palworld Dedicated Server Commands (RCON) -# Server Commands (RCON) - -How to use RCON to interact with the server. +How to use Palworld Dedicated server commands to manage your server, +including Kicking, Banning and teleporting players. ## RCON @@ -38,4 +44,4 @@ This will open a CLI that uses RCON to write commands to the Palworld Server. | Info | Show server information. | | Save | Save the world data. | -For a full list of commands go to: [https://tech.palworldgame.com/server-commands](https://tech.palworldgame.com/server-commands) +For a full list of commands go to: [https://tech.palworldgame.com/settings-and-operation/commands](https://tech.palworldgame.com/settings-and-operation/commands) diff --git a/docusaurus/docs/getting-started/configuration/server-settings.md b/docusaurus/docs/getting-started/configuration/server-settings.md index fa8596d6d..7e7238f35 100644 --- a/docusaurus/docs/getting-started/configuration/server-settings.md +++ b/docusaurus/docs/getting-started/configuration/server-settings.md @@ -1,10 +1,15 @@ --- sidebar_position: 1 +title: Palworld Dedicated Server Settings +description: How to change the Palworld Server Settings using Docker Environment variables. +keywords: [Palworld, palworld dedicated server, Palworld Dedicated server settings, palworld server settings, Palworld Docker Dedicated server settings, palworld Docker server settings] +image: ../../assets/Palworld_Banner.jpg +sidebar_label: Server Settings --- + +# Palworld Dedicated Server Settings -# Server Settings - -Changing Server Settings using environment variables. +How to change the Palworld Server Settings using Docker Environment variables. ## Environment variables @@ -55,9 +60,13 @@ It is highly recommended you set the following environment values before startin | DISCORD_PRE_START_MESSAGE | Discord message sent when server begins to start | Server is started! | "string" | | 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" | +| DISCORD_PLAYER_JOIN_MESSAGE | Discord message sent when player joins the server | \$\{player_name\} has joined Palworld! | "string" | +| DISCORD_PLAYER_LEAVE_MESSAGE | Discord message sent when player leaves the server | \$\{player_name\} has left Palworld. | "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 | *highly recommended to set diff --git a/docusaurus/docs/getting-started/quick-setup.md b/docusaurus/docs/getting-started/quick-setup.md index 566c6e480..11bcb5218 100644 --- a/docusaurus/docs/getting-started/quick-setup.md +++ b/docusaurus/docs/getting-started/quick-setup.md @@ -1,11 +1,19 @@ --- sidebar_position: 1 slug: / +title: Palworld Dedicated server Quick Setup +description: 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. +keywords: [Palworld, palworld dedicated server, how to setup palworld dedicated server, palworld server docker, palworld docker] +image: ../assets/Palworld_Banner.jpg +sidebar_label: Quick Setup --- + +# Palworld Dedicated server Quick Setup -# 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. -Let's get you on your way with the Palworld Dedicated server! +## Prerequisites :::warning At the moment, Xbox Gamepass/Xbox Console players will not be able to join a dedicated server. @@ -13,8 +21,6 @@ At the moment, Xbox Gamepass/Xbox Console players will not be able to join a ded 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 diff --git a/docusaurus/docs/guides/discord/discord-webhooks.md b/docusaurus/docs/guides/discord/discord-webhooks.md index c5f8346e1..a0d0877f9 100644 --- a/docusaurus/docs/guides/discord/discord-webhooks.md +++ b/docusaurus/docs/guides/discord/discord-webhooks.md @@ -1,8 +1,18 @@ --- sidebar_position: 1 +title: Palworld Server Discord webhooks +description: How to use the Palworld Dedicated server Discord Webhook integration to get notified when your server is starting, stopping, and updating! +keywords: [Palworld, palworld dedicated server, Palworld dedicated server Discord Webhooks, Palworld Discord Webhooks] +image: ../../assets/Palworld_Banner.jpg +sidebar_label: Using Discord Webhooks --- + +# Using discord webhooks with Palworld Server -# Using discord webhooks +How to use the Palworld Dedicated server Discord Webhook integration to +get notified when your server is starting, stopping, and updating! + +## Getting started 1. Generate a webhook url for your discord server in your discord's server settings. @@ -21,3 +31,7 @@ send discord messages with docker compose: - DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/1234567890/abcde - DISCORD_PRE_UPDATE_BOOT_MESSAGE=Server is updating... ``` + +:::tip +You can mention people in the messages by adding `<@user_id>` in the message! +::: diff --git a/docusaurus/docs/guides/pinning-game-version.md b/docusaurus/docs/guides/pinning-game-version.md index abcd4a4bc..abdafc3e9 100644 --- a/docusaurus/docs/guides/pinning-game-version.md +++ b/docusaurus/docs/guides/pinning-game-version.md @@ -20,3 +20,5 @@ 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 | +| 1.5.1 | 2815085007637542021 | 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/docs/known-issues/known-issues.md b/docusaurus/docs/known-issues/known-issues.md index 0fc3e3765..f5316cb0f 100644 --- a/docusaurus/docs/known-issues/known-issues.md +++ b/docusaurus/docs/known-issues/known-issues.md @@ -1,10 +1,16 @@ --- sidebar_position: 5 +title: Palworld Dedicated Server Known Issues +description: The current known issues of the Palworld Dedicated server running on Docker, including S_API FAIL, Setting breakpad minidump AppID = 2394010 and more. +keywords: [Palworld, palworld dedicated server, Palworld dedicated server known issues, Palworld dedicated server issues] +image: ../../assets/Palworld_Banner.jpg +sidebar_label: Known issues --- + +# Palworld Dedicated Server Known Issues -# Known Issues - -Known issues of using this Docker image. +The current know issues of the Palworld Dedicated server running on Docker, +including S_API FAIL, Setting breakpad minidump AppID = 2394010 and more. ## PalWorldSettings.ini keeps resetting @@ -56,6 +62,38 @@ it means that you'll need to look at the following: * Firewall settings, make sure that you allow port 8211/udp and 27015/udp through your firewall * Make sure you've correctly port forwarded your 8211/udp 27015/udp +## Only ARM64 hosts with 4k page size is supported + +This error occurs when the container detects that the host kernel does not have a 4k page size, +which is required for the emulation used for ARM64 architecture. The container relies on this specific page +size for proper execution. + +If the host kernel does not have a 4k page size, you have a couple of alternatives: + +* **Download server files in a different machine**: The 4k page size limitation is only applicable for steamcmd +ARM emulation. You may try initializing the container in a fully supported machine (AMD64 or ARM64 with 4k page size) +and let it download the server files with `UPDATE_ON_BOOT` enabled. Make sure to disable `UPDATE_ON_BOOT` in the +problematic machine to prevent steamcmd from executing. + +* **Change/Modify Kernel**: You can consider changing the kernel of your host machine to one that supports a 4k page size. + * The Raspberry Pi 5 with Raspberry Pi OS has an easy [switch](https://github.com/raspberrypi/bookworm-feedback/issues/107#issuecomment-1773810662). + +* **Switch OS**: Another option is to switch OS to ones shipped with 4k page size kernels. + * Debian and Ubuntu are known working Linux distros. + +* **Run within a VM**: Another option is to run the container within a virtual machine (VM) that is configured + with a kernel supporting a 4k page size. By doing so, you can ensure compatibility and proper execution of the + container. + +## /usr/local/bin/box86: cannot execute binary file: Exec format error (ARM64 hosts) + +This means that the Docker host is unable to run AArch32 binaries such as Box86 without an additional +compatibility layer which is the case for Apple Silicon. + +Docker Desktop solves this by running its containers inside a VM (QEMU) with a compatible kernel. +However, if you're unable to use Docker Desktop, then try setting `ARM_COMPATIBILITY_MODE` to `true`. +This will switch the container from using Box86 to QEMU when running steamcmd. + ## FAQ [A useful FAQ that gets updated regularly](https://gist.github.com/Toakan/3c78a577c21a21fcc5fa917f3021d70e#file-palworld-server-faq-community-md) diff --git a/docusaurus/docusaurus.config.js b/docusaurus/docusaurus.config.js index b832c1d03..e8eeabd25 100644 --- a/docusaurus/docusaurus.config.js +++ b/docusaurus/docusaurus.config.js @@ -11,6 +11,7 @@ const config = { title: 'Palworld Server Docker Documentation', tagline: 'All the information you need to get a Palworld Dedicated server up and running using Docker', favicon: 'img/favicon.ico', + trailingSlash: false, // Set the production url of your site here url: 'https://palworld-server-docker.loef.dev', 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..5e2013f19 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) @@ -38,4 +38,4 @@ Dies öffnet eine CLI, die RCON verwendet, um Befehle an den Palworld-Server zu | Info | Zeigt Serverinformationen an. | | Save | Speichern Sie die Weltendaten. | -Für eine vollständige Liste der Befehle gehen Sie zu: [https://tech.palworldgame.com/server-commands](https://tech.palworldgame.com/server-commands) +Für eine vollständige Liste der Befehle gehen Sie zu: [https://tech.palworldgame.com/settings-and-operation/commands](https://tech.palworldgame.com/settings-and-operation/commands) 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/` | -| DISCORD_CONNECT_TIMEOUT | Discord-Befehlsverbindungstimeout | 30 | !0 | -| DISCORD_MAX_TIMEOUT | Discord-Webhook Timeout | 30 | !0 | -| DISCORD_PRE_UPDATE_BOOT_MESSAGE | Discord-Nachricht, die gesendet wird, wenn der Server mit dem Update beginnt | Server wird aktualisiert... | "string" | -| DISCORD_POST_UPDATE_BOOT_MESSAGE | Discord-Nachricht, die gesendet wird, wenn der Server das Update abgeschlossen hat | Serverupdate abgeschlossen! | "string" | -| DISCORD_PRE_START_MESSAGE | Discord-Nachricht, die gesendet wird, wenn der Server mit dem Starten beginnt | Server wurde gestartet! | "string" | -| DISCORD_PRE_SHUTDOWN_MESSAGE | Discord-Nachricht, die gesendet wird, wenn der Server mit dem Herunterfahren beginnt | Server wird heruntergefahren... | "string" | -| DISCORD_POST_SHUTDOWN_MESSAGE | Discord-Nachricht, die gesendet wird, wenn der Server gestoppt wurde | Server wurde gestoppt! | "string" | +| 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 | +| TARGET_MANIFEST_ID | Legt die Spielversion entsprechend der Manifest-ID aus dem Steam-Download-Depot fest. | | See [Manifest ID Table](https://palworld-server-docker.loef.dev/guides/pinning-game-version#version-to-manifest-id-table) | +| DISCORD_WEBHOOK_URL | Discord-Webhook-URL, die nach Erstellung eines Webhooks auf einem Discord-Server gefunden werden kann | | `https://discord.com/api/webhooks/` | +| DISCORD_CONNECT_TIMEOUT | Discord-Befehlsverbindungstimeout | 30 | !0 | +| DISCORD_MAX_TIMEOUT | Discord-Webhook Timeout | 30 | !0 | +| DISCORD_PRE_UPDATE_BOOT_MESSAGE | Discord-Nachricht, die gesendet wird, wenn der Server mit dem Update beginnt | Server wird aktualisiert... | "string" | +| DISCORD_POST_UPDATE_BOOT_MESSAGE | Discord-Nachricht, die gesendet wird, wenn der Server das Update abgeschlossen hat | Serverupdate abgeschlossen! | "string" | +| DISCORD_PRE_START_MESSAGE | Discord-Nachricht, die gesendet wird, wenn der Server mit dem Starten beginnt | Server wurde gestartet! | "string" | +| DISCORD_PRE_SHUTDOWN_MESSAGE | Discord-Nachricht, die gesendet wird, wenn der Server mit dem Herunterfahren beginnt | Server wird heruntergefahren... | "string" | +| DISCORD_POST_SHUTDOWN_MESSAGE | Discord-Nachricht, die gesendet wird, wenn der Server gestoppt wurde | Server wurde gestoppt! | "string" | +| DISABLE_GENERATE_SETTINGS | Ob die PalWorldSettings.ini automatisch generiert werden soll | false | true/false | +| DISABLE_GENERATE_ENGINE | Ob die Engine.ini automatisch generiert werden soll | true | true/false | +| ENABLE_PLAYER_LOGGING | Aktiviert das Protokollieren und die Benachrichtigung, wenn Spieler dem Spiel beitreten und es verlassen. | true | true/false | +| PLAYER_LOGGING_POLL_PERIOD | Abfrageintervall (in Sekunden), um zu überprüfen, ob Spieler dem Spiel beigetreten sind oder es verlassen haben. | 5 | !0 | *dringend empfohlen, festzulegen diff --git a/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/guides/automatic-server-stopping.md b/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/guides/automatic-server-stopping.md new file mode 100644 index 000000000..13db8116d --- /dev/null +++ b/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/guides/automatic-server-stopping.md @@ -0,0 +1,10 @@ +--- +sidebar_position: 8 +--- + +# Server stoppen, wenn keine Spieler verbunden sind + +Der User [dnwjn](https://github.com/dnwjn) hat einen Docker-Container erstellt, der den Palworld-Server stoppt, wenn +keine Spieler verbunden sind, und den Container startet, wenn ein Spieler versucht, sich erneut zu verbinden. + +Für die offizielle Dokumentation zu diesem Feature besuche bitte das [dnwjn/palworld-server-watcher Repository](https://github.com/dnwjn/palworld-server-watcher). diff --git a/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/guides/discord/discord-webhooks.md b/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/guides/discord/discord-webhooks.md index 5e4b0095f..cb6650b69 100644 --- a/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/guides/discord/discord-webhooks.md +++ b/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/guides/discord/discord-webhooks.md @@ -22,3 +22,7 @@ Senden Sie Discord-Nachrichten mit `docker-compose`: - DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/1234567890/abcde - DISCORD_PRE_UPDATE_BOOT_MESSAGE=Der Server wird aktualisiert... ``` + +:::tip +Du kannst Personen in den Nachrichten erwähnen, indem du `<@user_id>` in die Nachricht einfügst! +::: diff --git a/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/guides/pinning-game-version.md b/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/guides/pinning-game-version.md index 37eb61402..2cc5543fa 100644 --- a/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/guides/pinning-game-version.md +++ b/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/guides/pinning-game-version.md @@ -23,3 +23,4 @@ von SteamCMD oder Websites wie [SteamDB](https://steamdb.info/depot/2394012/mani | 1.3.0 | 1354752814336157338 | | 1.4.0 | 4190579964382773830 | | 1.4.1 | 6370735655629434989 | +| 1.5.0 | 3750364703337203431 | diff --git a/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/guides/rcon/_category_.json b/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/guides/rcon/_category_.json new file mode 100644 index 000000000..b3246617f --- /dev/null +++ b/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/guides/rcon/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "RCON (Fortgeschritten)", + "position": 3, + "link": { + "type": "generated-index" + } +} diff --git a/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/guides/rcon/rcon-wrapper.md b/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/guides/rcon/rcon-wrapper.md new file mode 100644 index 000000000..eee170e42 --- /dev/null +++ b/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/guides/rcon/rcon-wrapper.md @@ -0,0 +1,8 @@ +# RCON Wrapper + +Der GitHub-User [valamidev](https://github.com/valamidev) hat ein Plugin für +`palworld-server-docker` erstellt, das es ermöglicht, den Palworld RCON-Endpunkt mit einem +Bearer-Token zu schützen und über das HTTP-Protokoll darauf zuzugreifen. + +Weitere Informationen findest du in seinem GitHub-Repo: +[valamidev/palworld-rcon-buddy](https://github.com/valamidev/palworld-rcon-buddy) diff --git a/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/known-issues/known-issues.md b/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/known-issues/known-issues.md index 754fda50c..a5d5bc708 100644 --- a/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/known-issues/known-issues.md +++ b/docusaurus/i18n/de/docusaurus-plugin-content-docs/current/known-issues/known-issues.md @@ -6,6 +6,21 @@ sidebar_position: 5 Bekannte Probleme bei der Verwendung dieses Docker-Images. +## PalWorldSettings.ini wird immer zurückgesetzt + +Wenn die `PalworldSettings.ini` zurückgesetzt wird, nachdem du die Datei geändert und den Server neu gestartet hast, +dann stelle sicher, dass `DISABLE_GENERATE_SETTINGS` auf `true` gesetzt ist. + +Falls das nicht der Fall ist, werden deine Einstellungen von den über die [Umgebungsvariablen gesetzten Einstellungen](https://palworld-server-docker.loef.dev/getting-started/configuration/game-settings) überschrieben. + +:::tip +Es wird empfohlen, die Umgebungsvariablen zu verwenden, um deine Spiel-Einstellungen festzulegen, anstatt +die `PalWorldSettings.ini` manuell zu ändern. + +Wenn du die Datei dennoch manuell ändern möchtest, stelle sicher, dass der Server ausgeschaltet ist, wenn du die +Änderungen vornimmst. +::: + ## Broadcast-Befehl kann nur 1 Wort senden Beim Verwenden eines Broadcasts über RCON wird nur ein Wort gesendet. diff --git a/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/advanced/kubernetes.md b/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/advanced/kubernetes.md index 5be463e2d..0e85a75e2 100644 --- a/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/advanced/kubernetes.md +++ b/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/advanced/kubernetes.md @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 2 --- # 쿠버네티스 diff --git a/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/getting-started/configuration/engine-settings.md b/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/getting-started/configuration/engine-settings.md new file mode 100644 index 000000000..41ca067b1 --- /dev/null +++ b/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/getting-started/configuration/engine-settings.md @@ -0,0 +1,54 @@ +--- +sidebar_position: 3 +title: 팔월드 서버 엔진설정 +description: 도커 환경변수로 팔월드 엔진설정 (Engine.ini file)하는 법. +keywords: [Palworld, palworld dedicated server, Palworld Engine.ini, palworld engine settings] +image: ../../assets/Palworld_Banner.jpg +sidebar_label: 엔진설정 +--- + +# 팔월드 서버 엔진설정 + +도커 환경변수로 팔월드 엔진설정 (Engine.ini file)하는 법. + +## 환경변수 + +:::warning +해당 환경변수들과 설정들은 게임이 아직 베타이기 때문에 변경될 수 있습니다. +::: + +설정을 이용하기 위해서는 `DISABLE_GENERATE_ENGINE: false`을 설정해주세요. + +엔진 설정을 환경 변수로 바꾸는 과정은 다음과 같은 규칙을 따릅니다 (몇가지 예외 있음): + +* 모두 대문자로 작성 +* 밑줄을 삽입하여 단어를 분할 +* 한 글자로 시작하는 설정(예: 'b')의 경우 그 한 글자를 제거 + +예시입니다: + +* LanServerMaxTickRate -> LAN_SERVER_MAX_TICK_RATE +* bUseFixedFrameRate -> USE_FIXED_FRAME_RATE +* NetClientTicksPerSecond -> NET_CLIENT_TICKS_PER_SECOND + +| 변수 | 설명 | 기본값 | 허용값 | +|-------------------------------|-----------------------------------------------------------------------------------------------------------------|---------------|--------------------| +| DISABLE_GENERATE_ENGINE | 엔진설정의 생성을 비활성화 합니다.ini | true | Boolean | +| LAN_SERVER_MAX_TICK_RATE | 내부서버 사용자의 최대 초당 tick을 설정합니다. 높을수록 게임이 부드러워집니다. | 120 | Integer | +| NET_SERVER_MAX_TICK_RATE | 외부서버 사용자의 최대 초당 tick을 설정합니다. 높을수록 게임이 부드러워집니다. | 120 | Integer | +| CONFIGURED_INTERNET_SPEED | 외부서버 사용자의 인터넷 속도를 (bytes per second) 설정합니다. 높을수록 대역폭의 병목현상이 줄어듭니다. | 104857600 | Integer (in bytes) | +| CONFIGURED_LAN_SPEED | 내부서버 사용자의 로컬 속도를 (bytes per second) 설정합니다. 높을수록 대역폭의 병목현상이 줄어듭니다. | 104857600 | Integer (in bytes) | +| MAX_CLIENT_RATE | 모든 클라이언트의 최대 데이터 전송속도를 설정합니다. 높을수록 데이터의 한도초과를 방지합니다. | 104857600 | Integer (in bytes) | +| MAX_INTERNET_CLIENT_RATE | 외부서버 사용자의 고용량 데이터 전송을 한도 없이 허가합니다. | 104857600 | Integer (in bytes) | +| SMOOTH_FRAME_RATE | 일관된 시각적 경험을 위해 게임 엔진에서 변동 프레임율 설정을 활성화합니다. | true | Boolean | +| SMOOTH_FRAME_RATE_UPPER_LIMIT | 부드럽게 하기위해 최대 목표 프레임률 범위을 설정합니다. | 120.000000 | Float | +| SMOOTH_FRAME_RATE_LOWER_LIMIT | 부드럽게 하기위해 최소 목표 프레임률 범위을 설정합니다. | 30.000000 | Float | +| USE_FIXED_FRAME_RATE | 프레임률 고정을 활성화합니다. | false | Boolean | +| FIXED_FRAME_RATE | 프레임률를 고정합니다 | 120.000000 | Float | +| MIN_DESIRED_FRAME_RATE | 수용 가능한 최소 프레임률을 설정해 해당 프레임율에서 게임이 부드럽게 돌아가게 합니다. | 60.000000 | Float | +| NET_CLIENT_TICKS_PER_SECOND | 클라이언트의 업데이트 주기를 늘려 렉과 반응도를 향상시킵니다. | 120 | Integer | + +:::tip +서버의 tickrate을 120이상으로 설정하는 것은 게임을 조금 더 부드럽게 하지만, +현재 문제가되는 물결현상 (rubber-banding)을 해결하지 못하고 하드웨어에 많은 부담을 줍니다. +::: diff --git a/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/getting-started/configuration/game-settings.md b/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/getting-started/configuration/game-settings.md index 11f409698..2e02533e0 100644 --- a/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/getting-started/configuration/game-settings.md +++ b/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/getting-started/configuration/game-settings.md @@ -1,9 +1,16 @@ --- sidebar_position: 2 +title: 팔월드 서버 게임설정 +description: 도커의 환경변수로 팔월드 게임 설정하기 (PalWorldSettings.ini file). +keywords: [Palworld, palworld dedicated server, Palworld PalWorldSettings.ini, palworld game settings, PalWorldSettings.ini] +image: ../../assets/Palworld_Banner.jpg +sidebar_label: 게임설정 --- - + # 게임 설정 +도커의 환경변수로 팔월드 게임 설정하기 (PalWorldSettings.ini file). + ## 환경 변수로 설정 :::warning @@ -14,71 +21,75 @@ sidebar_position: 2 서버 설정을 환경 변수로 바꾸는 과정은 다음과 같은 규칙을 따릅니다 (몇가지 예외 있음): -- 모두 대문자로 작성 -- 밑줄을 삽입하여 단어를 분할 -- 한 글자로 시작하는 설정(예: 'b')의 경우 그 한 글자를 제거 +* 모두 대문자로 작성 +* 밑줄을 삽입하여 단어를 분할 +* 한 글자로 시작하는 설정(예: 'b')의 경우 그 한 글자를 제거 아래는 예시입니다: -- Difficulty -> DIFFICULTY -- PalSpawnNumRate -> PAL_SPAWN_NUM_RATE -- bIsPvP -> IS_PVP +* Difficulty -> DIFFICULTY +* PalSpawnNumRate -> PAL_SPAWN_NUM_RATE +* bIsPvP -> IS_PVP -| 변수 | 설명 | 기본값 | 허용값 | +| 변수 | 설명 | 기본값 | 허용값 | |-------------------------------------------|----------------------------------------------------------------|----------------------------------------------------------------------------------------------|----------------------------------------| -| DIFFICULTY | 게임 난이도 | None | `None`,`Normal`,`Difficult` | -| DAYTIME_SPEEDRATE | 낮 시간 속도 - 숫자가 작을수록 낮이 짧아짐 | 1.000000 | Float | -| NIGHTTIME_SPEEDRATE | 밤 시간 속도 - 숫자가 작을수록 밤이 짧아짐 | 1.000000 | Float | -| EXP_RATE | 경험치 획득 비율 | 1.000000 | Float | -| PAL_CAPTURE_RATE | PAL 포획률 | 1.000000 | Float | -| PAL_SPAWN_NUM_RATE | PAL 출현 비율 | 1.000000 | Float | -| PAL_DAMAGE_RATE_ATTACK | PAL이 주는 데미지 배수 | 1.000000 | Float | -| PAL_DAMAGE_RATE_DEFENSE | PAL이 받는 데미지 배수 | 1.000000 | Float | -| PLAYER_DAMAGE_RATE_ATTACK | 플레이어가 주는 데미지 배수 | 1.000000 | Float | -| PLAYER_DAMAGE_RATE_DEFENSE | 플레이어가 받는 데미지 배수 | 1.000000 | Float | -| PLAYER_STOMACH_DECREASE_RATE | 플레이어 포만도 감소율 | 1.000000 | Float | -| PLAYER_STAMINA_DECREASE_RATE | 플레이어 기력 감소율 | 1.000000 | Float | -| PLAYER_AUTO_HP_REGEN_RATE | 플레이어 HP 자연 회복률 | 1.000000 | Float | -| PLAYER_AUTO_HP_REGEN_RATE_IN_SLEEP | 플레이어 수면 시 HP 회복률 | 1.000000 | Float | -| PAL_STOMACH_DECREASE_RATE | PAL 포만도 감소율 | 1.000000 | Float | -| PAL_STAMINA_DECREASE_RATE | PAL 기력 감소율 | 1.000000 | Float | -| PAL_AUTO_HP_REGEN_RATE | PAL HP 자연 회복률 | 1.000000 | Float | -| PAL_AUTO_HP_REGEN_RATE_IN_SLEEP | PAL 수면 시 HP 회복률 (PLA상자 내 HP 회복률) | 1.000000 | Float | -| BUILD_OBJECT_DAMAGE_RATE | 구조물 피해 배수 | 1.000000 | Float | -| BUILD_OBJECT_DETERIORATION_DAMAGE_RATE | 구조물 노화 속도 배수 | 1.000000 | Float | -| COLLECTION_DROP_RATE | 채집 아이템 획득량 배수 | 1.000000 | Float | -| COLLECTION_OBJECT_HP_RATE | 채집 오브젝트 HP 배수 | 1.000000 | Float | -| COLLECTION_OBJECT_RESPAWN_SPEED_RATE | 채집 오브젝트 생성 간격 - 숫자가 작을수록 재 생성이 빨라짐 | 1.000000 | Float | -| ENEMY_DROP_ITEM_RATE | 드롭 아이템 양 배수 | 1.000000 | Float | -| DEATH_PENALTY | 사망 패널티, None: 사망 패널티 없음, Item: 장비 이외의 아이템 드롭, ItemAndEquipment: 모든 아이템 드롭, All: 모든 PAL과 모든 아이템 드롭 | All | `None`,`Item`,`ItemAndEquipment`,`All` | -| ENABLE_PLAYER_TO_PLAYER_DAMAGE | 플레이어간 데미지 여부 | False | Boolean | -| ENABLE_FRIENDLY_FIRE | 아군간 데미지 여부 | False | Boolean | -| ENABLE_INVADER_ENEMY | 습격 이벤트 발생 여부 | True | Boolean | -| ACTIVE_UNKO | UNKO 활성화 여부(?) | False | Boolean | -| ENABLE_AIM_ASSIST_PAD | 컨트롤러 조준 보조 활성화 | True | Boolean | -| ENABLE_AIM_ASSIST_KEYBOARD | 키보드 조준 보조 활성화 | False | Boolean | -| DROP_ITEM_MAX_NUM | 월드 내의 드롭 아이템 최대 수 | 3000 | Integer | -| DROP_ITEM_MAX_NUM_UNKO | 월드 내의 UNKO 드롭 최대 수 | 100 | Integer | -| BASE_CAMP_MAX_NUM | 거점 최대 수량 | 128 | Integer | -| BASE_CAMP_WORKER_MAX_NUM | 거점 작업 PAL 최대 수 | 15 | Integer | -| DROP_ITEM_ALIVE_MAX_HOURS | 드롭 아이템이 사라지기까지 걸리는 시간 | 1.000000 | Float | -| AUTO_RESET_GUILD_NO_ONLINE_PLAYERS | 온라인 플레이어가 없을 때 길드 자동 리셋 여부 | False | Bool | -| AUTO_RESET_GUILD_TIME_NO_ONLINE_PLAYERS | 온라인 플레이어가 없을 때 길드를 자동 리셋 시간(h) | 72.000000 | Float | -| GUILD_PLAYER_MAX_NUM | 길드 내 최대 인원 수 | 20 | Integer | -| PAL_EGG_DEFAULT_HATCHING_TIME | 거대알 부화에 걸리는 시간(h) | 72.000000 | Float | -| WORK_SPEED_RATE | 작업 속도 배수 | 1.000000 | Float | -| IS_MULTIPLAY | 멀티플레이 활성화 여부 | False | Boolean | -| IS_PVP | PVP 활성화 여부 | False | Boolean | -| CAN_PICKUP_OTHER_GUILD_DEATH_PENALTY_DROP | 다른 길드 플레이어의 데스 페널티 드롭 아이템 획득 가능 여부 | False | Boolean | -| ENABLE_NON_LOGIN_PENALTY | 비 로그인 패널티 활성화 여부 | True | Boolean | -| ENABLE_FAST_TRAVEL | 빠른 이동 활성화 여부 | True | Boolean | -| IS_START_LOCATION_SELECT_BY_MAP | 시작 위치를 지도로 선택할 수 있는지 여부 | True | Boolean | -| EXIST_PLAYER_AFTER_LOGOUT | 로그오프 후 플레이어 삭제 여부 | False | Boolean | -| ENABLE_DEFENSE_OTHER_GUILD_PLAYER | 다른 길드 플레이어에 대한 방어 허용 여부 | False | Boolean | -| COOP_PLAYER_MAX_NUM | 협동던전 최대인원 | 4 | Integer | -| REGION | Region | | String | -| USEAUTH | 인증 사용 여부 | True | Boolean | -| BAN_LIST_URL | 사용할 BAN 목록 | [https://api.palworldgame.com/api/banlist.txt](https://api.palworldgame.com/api/banlist.txt) | string | +| DIFFICULTY | 게임 난이도 | None | `None`,`Normal`,`Difficult` | +| DAYTIME_SPEEDRATE | 낮 시간 속도 - 숫자가 작을수록 낮이 짧아짐 | 1.000000 | Float | +| NIGHTTIME_SPEEDRATE | 밤 시간 속도 - 숫자가 작을수록 밤이 짧아짐 | 1.000000 | Float | +| EXP_RATE | 경험치 획득 비율 | 1.000000 | Float | +| PAL_CAPTURE_RATE | PAL 포획률 | 1.000000 | Float | +| PAL_SPAWN_NUM_RATE | PAL 출현 비율 | 1.000000 | Float | +| PAL_DAMAGE_RATE_ATTACK | PAL이 주는 데미지 배수 | 1.000000 | Float | +| PAL_DAMAGE_RATE_DEFENSE | PAL이 받는 데미지 배수 | 1.000000 | Float | +| PLAYER_DAMAGE_RATE_ATTACK | 플레이어가 주는 데미지 배수 | 1.000000 | Float | +| PLAYER_DAMAGE_RATE_DEFENSE | 플레이어가 받는 데미지 배수 | 1.000000 | Float | +| PLAYER_STOMACH_DECREASE_RATE | 플레이어 포만도 감소율 | 1.000000 | Float | +| PLAYER_STAMINA_DECREASE_RATE | 플레이어 기력 감소율 | 1.000000 | Float | +| PLAYER_AUTO_HP_REGEN_RATE | 플레이어 HP 자연 회복률 | 1.000000 | Float | +| PLAYER_AUTO_HP_REGEN_RATE_IN_SLEEP | 플레이어 수면 시 HP 회복률 | 1.000000 | Float | +| PAL_STOMACH_DECREASE_RATE | PAL 포만도 감소율 | 1.000000 | Float | +| PAL_STAMINA_DECREASE_RATE | PAL 기력 감소율 | 1.000000 | Float | +| PAL_AUTO_HP_REGEN_RATE | PAL HP 자연 회복률 | 1.000000 | Float | +| PAL_AUTO_HP_REGEN_RATE_IN_SLEEP | PAL 수면 시 HP 회복률 (PLA상자 내 HP 회복률) | 1.000000 | Float | +| BUILD_OBJECT_DAMAGE_RATE | 구조물 피해 배수 | 1.000000 | Float | +| BUILD_OBJECT_DETERIORATION_DAMAGE_RATE | 구조물 노화 속도 배수 | 1.000000 | Float | +| COLLECTION_DROP_RATE | 채집 아이템 획득량 배수 | 1.000000 | Float | +| COLLECTION_OBJECT_HP_RATE | 채집 오브젝트 HP 배수 | 1.000000 | Float | +| COLLECTION_OBJECT_RESPAWN_SPEED_RATE | 채집 오브젝트 생성 간격 - 숫자가 작을수록 재 생성이 빨라짐 | 1.000000 | Float | +| ENEMY_DROP_ITEM_RATE | 드롭 아이템 양 배수 | 1.000000 | Float | +| DEATH_PENALTY | 사망 패널티, None: 사망 패널티 없음, Item: 장비 이외의 아이템 드롭, ItemAndEquipment: 모든 아이템 드롭, All: 모든 PAL과 모든 아이템 드롭 | All | `None`,`Item`,`ItemAndEquipment`,`All` | +| ENABLE_PLAYER_TO_PLAYER_DAMAGE | 플레이어간 데미지 여부 | False | Boolean | +| ENABLE_FRIENDLY_FIRE | 아군간 데미지 여부 | False | Boolean | +| ENABLE_INVADER_ENEMY | 습격 이벤트 발생 여부 | True | Boolean | +| ACTIVE_UNKO | UNKO 활성화 여부(?) | False | Boolean | +| ENABLE_AIM_ASSIST_PAD | 컨트롤러 조준 보조 활성화 | True | Boolean | +| ENABLE_AIM_ASSIST_KEYBOARD | 키보드 조준 보조 활성화 | False | Boolean | +| DROP_ITEM_MAX_NUM | 월드 내의 드롭 아이템 최대 수 | 3000 | Integer | +| DROP_ITEM_MAX_NUM_UNKO | 월드 내의 UNKO 드롭 최대 수 | 100 | Integer | +| BASE_CAMP_MAX_NUM | 거점 최대 수량 | 128 | Integer | +| BASE_CAMP_WORKER_MAX_NUM | 거점 작업 PAL 최대 수 | 15 | Integer | +| DROP_ITEM_ALIVE_MAX_HOURS | 드롭 아이템이 사라지기까지 걸리는 시간 | 1.000000 | Float | +| AUTO_RESET_GUILD_NO_ONLINE_PLAYERS | 온라인 플레이어가 없을 때 길드 자동 리셋 여부 | False | Bool | +| AUTO_RESET_GUILD_TIME_NO_ONLINE_PLAYERS | 온라인 플레이어가 없을 때 길드를 자동 리셋 시간(h) | 72.000000 | Float | +| GUILD_PLAYER_MAX_NUM | 길드 내 최대 인원 수 | 20 | Integer | +| PAL_EGG_DEFAULT_HATCHING_TIME | 거대알 부화에 걸리는 시간(h) | 72.000000 | Float | +| WORK_SPEED_RATE | 작업 속도 배수 | 1.000000 | Float | +| IS_MULTIPLAY | 멀티플레이 활성화 여부 | False | Boolean | +| IS_PVP | PVP 활성화 여부 | False | Boolean | +| CAN_PICKUP_OTHER_GUILD_DEATH_PENALTY_DROP | 다른 길드 플레이어의 데스 페널티 드롭 아이템 획득 가능 여부 | False | Boolean | +| ENABLE_NON_LOGIN_PENALTY | 비 로그인 패널티 활성화 여부 | True | Boolean | +| ENABLE_FAST_TRAVEL | 빠른 이동 활성화 여부 | True | Boolean | +| IS_START_LOCATION_SELECT_BY_MAP | 시작 위치를 지도로 선택할 수 있는지 여부 | True | Boolean | +| EXIST_PLAYER_AFTER_LOGOUT | 로그오프 후 플레이어 삭제 여부 | False | Boolean | +| ENABLE_DEFENSE_OTHER_GUILD_PLAYER | 다른 길드 플레이어에 대한 방어 허용 여부 | False | Boolean | +| COOP_PLAYER_MAX_NUM | 협동던전 최대인원 | 4 | Integer | +| REGION | Region | | String | +| USEAUTH | 인증 사용 여부 | True | Boolean | +| BAN_LIST_URL | 사용할 BAN 목록 | [https://api.palworldgame.com/api/banlist.txt](https://api.palworldgame.com/api/banlist.txt) | string | +| SHOW_PLAYER_LIST | ESC시 사용자 리스트 | True | Boolean | +| TARGET_MANIFEST_ID | 게임의 버젼을 스팀 다운로드 디포의 해당 Manifest ID로 고정. | | [Manifest ID Table](#버전별Manifest ID표) 보기 | +| ENABLE_PLAYER_LOGGING | 플레이어가 접속 또는 종료시 로깅과 공지를 활성화 | true | true/false | +| PLAYER_LOGGING_POLL_PERIOD | 플레이어의 접속과 종료를 확인하기위한 폴링시간(초) 설정 | 5 | !0 | ### 수동으로 설정 diff --git a/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/getting-started/configuration/server-commands.md b/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/getting-started/configuration/server-commands.md index 789887e53..ac84f950f 100644 --- a/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/getting-started/configuration/server-commands.md +++ b/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/getting-started/configuration/server-commands.md @@ -1,8 +1,14 @@ --- -sidebar_position: 3 +sidebar_position: 4 +title: 팔월드 데디케이드 서버 명령어 (RCON) +description: RCON을 사용하여 서버와 상호 작용하는 방법을 소개합니다. +keywords: [Palworld, palworld dedicated server, Palworld Server Commands, Palworld server how to ban player, Palworld server how to kick player] +image: ../../assets/Palworld_Banner.jpg +sidebar_label: Server Commands (RCON) --- -# 서버 명령어 (RCON) + +# 팔월드 데디케이드 서버 명령어 (RCON) RCON을 사용하여 서버와 상호 작용하는 방법을 소개합니다. @@ -37,4 +43,4 @@ docker exec -it palworld-server rcon-cli "Broadcast Hello everyone" | Info | 서버 정보를 표시합니다. | | Save | 월드 정보를 저장합니다. | -전체 명령어 목록을 보려면 다음으로 이동하세요: [https://tech.palworldgame.com/server-commands](https://tech.palworldgame.com/server-commands) +전체 명령어 목록을 보려면 다음으로 이동하세요: [https://tech.palworldgame.com/settings-and-operation/commands](https://tech.palworldgame.com/settings-and-operation/commands) diff --git a/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/getting-started/configuration/server-settings.md b/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/getting-started/configuration/server-settings.md index 391420fc9..fc10bfa1b 100644 --- a/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/getting-started/configuration/server-settings.md +++ b/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/getting-started/configuration/server-settings.md @@ -1,10 +1,15 @@ --- sidebar_position: 1 +title: 팔월드 데디케이트 서버 설정 +description: 도커 환경변수를 사용해 팔월드 서버 세팅 변경방법. +keywords: [Palworld, palworld dedicated server, Palworld Dedicated server settings, palworld server settings, Palworld Docker Dedicated server settings, palworld Docker server settings] +image: ../../assets/Palworld_Banner.jpg +sidebar_label: Server Settings --- + +# 팔월드 데디케이트 서버 설정 -# 서버 설정 - -이 부분에서는 서버를 구성하는 방법을 설명합니다. +도커 환경변수를 사용해 팔월드 서버 세팅 변경방법. ## 환경 변수 @@ -45,6 +50,8 @@ sidebar_position: 1 | AUTO_REBOOT_CRON_EXPRESSION | 자동 서버 재부팅 주기 | 0 0 \* \* \* | Cron 표현식 필요 - [cron을 이용한 자동 재부팅 설정](https://palworld-server-docker.loef.dev/ko/guides/automatic-reboots#cron%EC%9D%84-%EC%9D%B4%EC%9A%A9%ED%95%9C-%EC%9E%90%EB%8F%99-%EC%9E%AC%EB%B6%80%ED%8C%85-%EC%84%A4%EC%A0%95) 참조 | | AUTO_REBOOT_ENABLED | 자동 서버 재부팅 활성화 여부 | false | true/false | | AUTO_REBOOT_WARN_MINUTES | 재부팅 대기 시간 설정(분), 이때 사용자는 분 단위로 서버 종료에 대한 알림을 받습니다. | 5 | !0 | +| AUTO_REBOOT_EVEN_IF_PLAYERS_ONLINE | 플레이어 온라인시에도 재부팅. | false | true/false | +| TARGET_MANIFEST_ID | 게임의 버젼을 스팀 다운로드 디포의 해당 Manifest ID로 고정. | | See [Manifest ID Table](https://palworld-server-docker.loef.dev/guides/pinning-game-version#version-to-manifest-id-table) | | DISCORD_WEBHOOK_URL | 디스코드 웹훅 URL | | `https://discord.com/api/webhooks/` | | DISCORD_CONNECT_TIMEOUT | 디스코드 명령 초기 연결 시간 초과 | 30 | !0 | | DISCORD_MAX_TIMEOUT | Discord 총 훅 시간 초과 | 30 | !0 | @@ -54,6 +61,10 @@ sidebar_position: 1 | DISCORD_PRE_SHUTDOWN_MESSAGE | 서버가 종료되기 시작할 때 전송되는 디스코드 메시지 | Server is shutting down... | "string" | | DISCORD_POST_SHUTDOWN_MESSAGE | 서버가 멈췄을 때 전송되는 디스코드 메시지 | Server is stopped! | "string" | | DISABLE_GENERATE_SETTINGS | 자동으로 PalWorldSettings.ini를 생성할지 여부 | false | true/false | +| DISABLE_GENERATE_ENGINE | 엔진설정의 생성을 비활성화 합니다.ini | true | true/false | +| ENABLE_PLAYER_LOGGING | 플레이어가 접속 또는 종료시 로깅과 공지를 활성화 | true | true/false | +| PLAYER_LOGGING_POLL_PERIOD | 플레이어의 접속과 종료를 확인하기위한 폴링시간(초) 설정 | 5 | !0 | +| ARM_COMPATIBILITY_MODE | 서버 업데이트를하기 위해 steamcmd를 실행시 호환성 레이어를 Box86에서 QEMU로 변경. 이 설정은 ARM64 호스트 전용입니다. | false | true/false | *설정하는 것을 적극 권장합니다. diff --git a/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/getting-started/quick-setup.md b/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/getting-started/quick-setup.md index f588818d9..10ac66767 100644 --- a/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/getting-started/quick-setup.md +++ b/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/getting-started/quick-setup.md @@ -1,8 +1,13 @@ --- sidebar_position: 1 slug: / +title: 팔월드 데디케이드 서버 빠른설정 +description: 이 가이드는 팔월드 데디케이드 서버를 도커에서 설정하는 방법입니다! 불과 몇분만에 데디케이드 서버를 설정해보세요. +keywords: [Palworld, palworld dedicated server, how to setup palworld dedicated server, palworld server docker, palworld docker] +image: ../assets/Palworld_Banner.jpg +sidebar_label: 빠른설정 --- - + # 빠른 설정 Palworld 전용 서버를 이용해 보세요! @@ -56,7 +61,9 @@ services: 환경 변수를 설정하는 또 다른 방법으로 [.env.example](https://github.com/thijsvanloef/palworld-server-docker/blob/main/.env.example) 파일을 **.env** 라는 새로운 파일에 복사할 수 있습니다. -필요에 맞게 수정하고 [환경 변수](https://palworld-server-docker.loef.dev/ko/getting-started/configuration/server-settings/#환경-변수) 섹션에서 올바른 값을 확인해보세요. [docker-compose.yml](https://github.com/thijsvanloef/palworld-server-docker/blob/main/docker-compose.yml)을 다음과 같이 수정합니다: +필요에 맞게 수정하고 [환경 변수](https://palworld-server-docker.loef.dev/ko/getting-started/configuration/server-settings/#환경-변수) 섹션에서 올바른 값을 확인해보세요. + +[docker-compose.yml](https://github.com/thijsvanloef/palworld-server-docker/blob/main/docker-compose.yml)을 다음과 같이 수정합니다: ```yml services: @@ -74,6 +81,16 @@ services: - ./palworld:/palworld/ ``` +### 서버 시작하기 + +`docker compose up -d` 명령어를 `docker-compose.yml`가 들어있는 폴더안에서 입력해 백그라운드에서 실행하세요. + +### 서버 정지하기 + +`docker compose stop` 명령어를 `docker-compose.yml`가 들어있는 폴더안에서 입력해 서버를 정지하세요. + +`docker compose down --rmi all` 명령어를 `docker-compose.yml`가 들어있는 폴더안에서 입력해 서버와 이미지를 정지해 지우세요. + ### Docker Run ```bash @@ -115,13 +132,3 @@ docker run -d \ --stop-timeout 30 \ thijsvanloef/palworld-server-docker:latest ``` - -## 서버 시작하기 - -`docker compose up -d` 를 사용해 백그라운드에서 서버를 시작합니다. - -## 서버 중지하기 - -`docker compose stop` 를 사용해 서버를 중지시킵니다. - -`docker compose down --rmi all` 를 사용해 서버를 중지시키고 삭제한 다음 컴퓨터의 docker image까지 삭제합니다. diff --git a/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/guides/automatic-server-stopping.md b/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/guides/automatic-server-stopping.md new file mode 100644 index 000000000..48a12b51c --- /dev/null +++ b/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/guides/automatic-server-stopping.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 8 +--- + +# 서버 접속 유저가 없을때 서버종료하기 + +사용자 [dnwjn](https://github.com/dnwjn)의 컨테이너는 팔월드 서버에 유저가 없을 경우 서버를 멈춥니다. 유저가 접속하려는 경우 다시 서버를 시작합니다. + +해당기능의 공식적인 문서를 확인하시려면 [dnwjn/palworld-server-watcher repository](https://github.com/dnwjn/palworld-server-watcher)를 확인하세요. diff --git a/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/guides/pinning-game-version.md b/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/guides/pinning-game-version.md new file mode 100644 index 000000000..f9e85dc6f --- /dev/null +++ b/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/guides/pinning-game-version.md @@ -0,0 +1,25 @@ +--- +sidebar_position: 7 +--- + +# 게임버전 고정하기 + +:::warning +다운그레이딩이 가능하나 세이브 파일에 어떠한 영향이 있을지 알 수 없습니다. + +**본인의 책임하에 하세요!** +::: + +만약 **TARGET_MANIFEST_ID** 환경변수가 정해졌다면, 서버의 버전은 특정 manifest로 고정됩니다. +Manifest는 게임의 릴리즈 시간/업데이트 버젼에 따라 정해집니다. +Manifest는 SteamCMD나 [SteamDB](https://steamdb.info/depot/2394012/manifests/)와 같은 웹사이트에서 검색가능합니다. + +## Version To Manifest ID Table + +| Version | Manifest ID | +|---------|----------------------| +| 1.3.0 | 1354752814336157338 | +| 1.4.0 | 4190579964382773830 | +| 1.4.1 | 6370735655629434989 | +| 1.5.0 | 3750364703337203431 | +| 1.5.1 | 2815085007637542021 | diff --git a/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/guides/running-without-root.md b/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/guides/running-without-root.md new file mode 100644 index 000000000..716f9d6e0 --- /dev/null +++ b/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/guides/running-without-root.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 6 +--- + +# 루트권한 없이 실행하기 + +해당 항목은 고급사용자를 위한 항목입니다. + +해당 컨테이너는 [기본사용자 덮어씌우기](https://docs.docker.com/engine/reference/run/#user)가 가능합니다. 해당 이미지의 기본사용자는 루트입니다. + +사용자가 유저와 그룹을 설정하기 떄문에 `PUID`와 `PGID`가 무시됩니다. + +UID를 찾으려면: `id -u`를 사용합니다. +GID를 찾으려면: `id -g`를 사용합니다. + +반드시 유저를 `NUMBERICAL_UID:NUMBERICAL_GID`와 같이 설정하셔야합니다. + +아래는 UID를 1000으로 GID를 1001로 가정해 작성된 예제문입니다. + +* docker run에서 `--user 1000:1001 \`를 마지막 줄위에 추가하세요. +* docker compose에서 `user: 1000:1001`를 포트설정위에 추가하세요. + +만약 다른 UID/GID를 사용해 실행하려면 디렉토리의 소유권을 변경해야합니다: `chown UID:GID palworld/` 또는 모든 계정의 권한를 수정하셔야합니다: `chmod o=rwx palworld/` diff --git a/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/known-issues/known-issues.md b/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/known-issues/known-issues.md index 639bbf622..273576886 100644 --- a/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/known-issues/known-issues.md +++ b/docusaurus/i18n/ko/docusaurus-plugin-content-docs/current/known-issues/known-issues.md @@ -1,8 +1,28 @@ --- -sidebar_position: 4 +sidebar_position: 5 +title: 팔월드 데디케이트 서버 알려진 버그 +description: 현재 알려진 팔월드 데디케이트 서버 버그, including S_API FAIL, Setting breakpad minidump AppID = 2394010 그리고 더. +keywords: [Palworld, palworld dedicated server, Palworld dedicated server known issues, Palworld dedicated server issues] +image: ../../assets/Palworld_Banner.jpg +sidebar_label: Known issues --- + +# 팔월드 데디케이트 서버 알려진 버그 -# Known Issues +현재 알려진 팔월드 데디케이트 서버 버그, +including S_API FAIL, Setting breakpad minidump AppID = 2394010 그리고 더. + +## PalWorldSettings.ini가 계속 초기화되는 문제 + +`PalworldSettings.ini`가 서버 재시작시 계속 초기화된다면 `DISABLE_GENERATE_SETTINGS` 환경변수를 `true`로 변경해주세요. + +해당 환경변수가 설정되지 않으면 설정되어있는 도커의 환경변수로 덮어쓰려질 것입니다. [the environment variables](https://palworld-server-docker.loef.dev/getting-started/configuration/game-settings). + +:::tip +It is recommended you use the environment variables to set your game settings, instead of manually changing the `PalWorldSettings.ini` + +If you do want to change the file manually, please make sure the server is off when you make the changes. +::: ## Broadcast command can only send 1 word @@ -41,6 +61,38 @@ it means that you'll need to look at the following: * Firewall settings, make sure that you allow port 8211/udp and 27015/udp through your firewall * Make sure you've correctly port forwarded your 8211/udp 27015/udp +## Only ARM64 hosts with 4k page size is supported + +This error occurs when the container detects that the host kernel does not have a 4k page size, +which is required for the emulation used for ARM64 architecture. The container relies on this specific page +size for proper execution. + +If the host kernel does not have a 4k page size, you have a couple of alternatives: + +* **Download server files in a different machine**: The 4k page size limitation is only applicable for steamcmd +ARM emulation. You may try initializing the container in a fully supported machine (AMD64 or ARM64 with 4k page size) +and let it download the server files with `UPDATE_ON_BOOT` enabled. Make sure to disable `UPDATE_ON_BOOT` in the +problematic machine to prevent steamcmd from executing. + +* **Change/Modify Kernel**: You can consider changing the kernel of your host machine to one that supports a 4k page size. + * The Raspberry Pi 5 with Raspberry Pi OS has an easy [switch](https://github.com/raspberrypi/bookworm-feedback/issues/107#issuecomment-1773810662). + +* **Switch OS**: Another option is to switch OS to ones shipped with 4k page size kernels. + * Debian and Ubuntu are known working Linux distros. + +* **Run within a VM**: Another option is to run the container within a virtual machine (VM) that is configured + with a kernel supporting a 4k page size. By doing so, you can ensure compatibility and proper execution of the + container. + +## /usr/local/bin/box86: cannot execute binary file: Exec format error (ARM64 hosts) + +This means that the Docker host is unable to run AArch32 binaries such as Box86 without an additional +compatibility layer which is the case for Apple Silicon. + +Docker Desktop solves this by running its containers inside a VM (QEMU) with a compatible kernel. +However, if you're unable to use Docker Desktop, then try setting `ARM_COMPATIBILITY_MODE` to `true`. +This will switch the container from using Box86 to QEMU when running steamcmd. + ## FAQ [A useful FAQ that gets updated regularly](https://gist.github.com/Toakan/3c78a577c21a21fcc5fa917f3021d70e#file-palworld-server-faq-community-md) diff --git a/docusaurus/i18n/nl/docusaurus-plugin-content-docs/current/getting-started/configuration/server-commands.md b/docusaurus/i18n/nl/docusaurus-plugin-content-docs/current/getting-started/configuration/server-commands.md index 9593363d3..4606d8385 100644 --- a/docusaurus/i18n/nl/docusaurus-plugin-content-docs/current/getting-started/configuration/server-commands.md +++ b/docusaurus/i18n/nl/docusaurus-plugin-content-docs/current/getting-started/configuration/server-commands.md @@ -38,4 +38,4 @@ Dit opent een CLI die RCON gebruikt om opdrachten naar de Palworld Server te sch | Info | Toon serverinformatie. | | Save | Sla de wereldgegevens op. | -Voor een volledige lijst met opdrachten ga naar: [https://tech.palworldgame.com/server-commands](https://tech.palworldgame.com/server-commands) +Voor een volledige lijst met opdrachten ga naar: [https://tech.palworldgame.com/settings-and-operation/commands](https://tech.palworldgame.com/settings-and-operation/commands) diff --git a/docusaurus/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/configuration/server-commands.md b/docusaurus/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/configuration/server-commands.md index 56d698e29..e0481a254 100644 --- a/docusaurus/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/configuration/server-commands.md +++ b/docusaurus/i18n/zh/docusaurus-plugin-content-docs/current/getting-started/configuration/server-commands.md @@ -42,4 +42,4 @@ docker exec -it palworld-server rcon-cli "Broadcast Hello everyone" | Info | 显示服务器信息。 | | Save | 保存游戏。 | -请查看 [官方文档](https://tech.palworldgame.com/server-commands) 以获取所有命令。 +请查看 [官方文档](https://tech.palworldgame.com/settings-and-operation/commands) 以获取所有命令。 diff --git a/scripts/backup.sh b/scripts/backup.sh index 0feaa802a..88437ad4c 100644 --- a/scripts/backup.sh +++ b/scripts/backup.sh @@ -2,7 +2,7 @@ # shellcheck source=scripts/helper_functions.sh source "/home/steam/server/helper_functions.sh" -DiscordMessage "Creating backup..." "in-progress" +DiscordMessage "Backup" "Creating backup..." "in-progress" if [ "${RCON_ENABLED,,}" = true ]; then save_server fi @@ -18,7 +18,7 @@ if [ "$(id -u)" -eq 0 ]; then chown steam:steam "$FILE_PATH" fi LogInfo "Backup created at ${FILE_PATH}" -DiscordMessage "Backup created at ${FILE_PATH}" "success" +DiscordMessage "Backup" "Backup created at ${FILE_PATH}" "success" if [ "${DELETE_OLD_BACKUPS,,}" != true ]; then exit 0 @@ -26,18 +26,18 @@ fi if [ -z "${OLD_BACKUP_DAYS}" ]; then LogWarn "Unable to delete old backups, OLD_BACKUP_DAYS is empty." - DiscordMessage "Unable to delete old backups, OLD_BACKUP_DAYS is empty." "warn" + DiscordMessage "Backup" "Unable to delete old backups, OLD_BACKUP_DAYS is empty." "warn" exit 0 fi if [[ "${OLD_BACKUP_DAYS}" =~ ^[0-9]+$ ]]; then LogAction "Removing Old Backups" LogInfo "Removing backups older than ${OLD_BACKUP_DAYS} days" - DiscordMessage "Removing backups older than ${OLD_BACKUP_DAYS} days..." "in-progress" + DiscordMessage "Backup" "Removing backups older than ${OLD_BACKUP_DAYS} days..." "in-progress" find /palworld/backups/ -mindepth 1 -maxdepth 1 -mtime "+${OLD_BACKUP_DAYS}" -type f -name 'palworld-save-*.tar.gz' -print -delete - DiscordMessage "Removed backups older than ${OLD_BACKUP_DAYS} days" "success" + DiscordMessage "Backup" "Removed backups older than ${OLD_BACKUP_DAYS} days" "success" exit 0 fi LogError "Unable to delete old backups, OLD_BACKUP_DAYS is not an integer. OLD_BACKUP_DAYS=${OLD_BACKUP_DAYS}" -DiscordMessage "Unable to delete old backups, OLD_BACKUP_DAYS is not an integer. OLD_BACKUP_DAYS=${OLD_BACKUP_DAYS}" "failure" \ No newline at end of file +DiscordMessage "Backup" "Unable to delete old backups, OLD_BACKUP_DAYS is not an integer. OLD_BACKUP_DAYS=${OLD_BACKUP_DAYS}" "failure" \ No newline at end of file diff --git a/scripts/compile-engine.sh b/scripts/compile-engine.sh new file mode 100644 index 000000000..17caab056 --- /dev/null +++ b/scripts/compile-engine.sh @@ -0,0 +1,60 @@ +#!/bin/bash +# shellcheck source=scripts/helper_functions.sh +source "/home/steam/server/helper_functions.sh" + +engine_file="/palworld/Pal/Saved/Config/LinuxServer/Engine.ini" +engine_dir=$(dirname "$engine_file") + +mkdir -p "$engine_dir" || exit +# If file exists then check if it is writable +if [ -f "$engine_file" ]; then + if ! isWritable "$engine_file"; then + LogError "Unable to create $engine_file" + exit 1 + fi +# If file does not exist then check if the directory is writable +elif ! isWritable "$engine_dir"; then + # Exiting since the file does not exist and the directory is not writable. + LogError "Unable to create $engine_file" + exit 1 +fi + +LogAction "Compiling Engine.ini" + +export LAN_SERVER_MAX_TICK_RATE=${LAN_SERVER_MAX_TICK_RATE:-120} +export NET_SERVER_MAX_TICK_RATE=${NET_SERVER_MAX_TICK_RATE:-120} +export CONFIGURED_INTERNET_SPEED=${CONFIGURED_INTERNET_SPEED:-104857600} +export CONFIGURED_LAN_SPEED=${CONFIGURED_LAN_SPEED:-104857600} +export MAX_CLIENT_RATE=${MAX_CLIENT_RATE:-104857600} +export MAX_INTERNET_CLIENT_RATE=${MAX_INTERNET_CLIENT_RATE:-104857600} +export SMOOTH_FRAME_RATE=${SMOOTH_FRAME_RATE:-true} +export SMOOTH_FRAME_RATE_UPPER_LIMIT=${SMOOTH_FRAME_RATE_UPPER_LIMIT:-120.000000} +export SMOOTH_FRAME_RATE_LOWER_LIMIT=${SMOOTH_FRAME_RATE_LOWER_LIMIT:-30.000000} +export USE_FIXED_FRAME_RATE=${USE_FIXED_FRAME_RATE:-false} +export FIXED_FRAME_RATE=${FIXED_FRAME_RATE:-120} +export MIN_DESIRED_FRAME_RATE=${MIN_DESIRED_FRAME_RATE:-60} +export NET_CLIENT_TICKS_PER_SECOND=${NET_CLIENT_TICKS_PER_SECOND:-120} + +if [ "${DEBUG,,}" = true ]; then +cat < "$engine_file" <