From c33a2e4ff97cecd4d8067dc5531891ae93d5be36 Mon Sep 17 00:00:00 2001 From: Caleb <23466706+caleb-devops@users.noreply.github.com> Date: Tue, 30 Jan 2024 19:19:51 -0700 Subject: [PATCH 1/5] Add Helm deploy link and cleanup readme --- README.md | 38 ++++++++++++++++++++++++-------------- 1 file changed, 24 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 9c69906..f6c88e6 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@ [![Discord](https://img.shields.io/discord/532141442731212810?logo=discord&label=Discord&link=https%3A%2F%2Fdiscord.gg%2F7tacb9Q6tj)](https://discord.gg/7tacb9Q6tj) > [!TIP] -> Do you want to chat with the community? -> +> Do you want to chat with the community? +> > **[Join us on Discord](https://discord.gg/7tacb9Q6tj)** This Docker image includes a Palworld Dedicated Server based on Linux and Docker. @@ -24,6 +24,7 @@ ___ - [Requirements](#requirements) - [Minimum system requirements](#minimum-system-requirements) - [Getting started](#getting-started) + - [Deploy with Helm](#deploy-with-helm) - [Environment variables](#environment-variables) - [Docker-Compose examples](#docker-compose-examples) - [Gameserver with RCON-CLI-Tool](#gameserver-with-rcon-cli-tool) @@ -31,9 +32,9 @@ ___ - [FAQ](#faq) - [How can I use the interactive console in Portainer with this image?](#how-can-i-use-the-interactive-console-in-portainer-with-this-image) - [How can I look into the config of my Palworld container?](#how-can-i-look-into-the-config-of-my-palworld-container) - - [Im seeing S\_API errors in my logs when I start the container?](#im-seeing-s_api-errors-in-my-logs-when-i-start-the-container) - - [Im using Apple silicon type of hardware, can I run this?](#im-using-apple-silicon-type-of-hardware-can-i-run-this) - - [I have changed the BaseCampWorkerMaxNum settings, why are changes un-affected on the server?](#i-have-changed-the-basecampworkermaxnum-settings-why-are-changes-un-affected-on-the-server) + - [I'm seeing S\_API errors in my logs when I start the container?](#im-seeing-s_api-errors-in-my-logs-when-i-start-the-container) + - [I'm using Apple silicon type of hardware, can I run this?](#im-using-apple-silicon-type-of-hardware-can-i-run-this) + - [I changed the `BaseCampWorkerMaxNum` setting, why didn't this update the server?](#i-changed-the-basecampworkermaxnum-setting-why-didnt-this-update-the-server) - [Planned features in the future](#planned-features-in-the-future) - [Software used](#software-used) @@ -41,7 +42,7 @@ ___ If you need support for this Docker image: -- Feel free to create a new issue. +- Feel free to create a new issue. - You can reference other issues if you're experiencing a similar problem via #issue-number. - Follow the instructions and answer the questions of people who are willing to help you. - Once your issue is resolved, please close it and please consider giving this repo and the [Docker-Hub repository](https://hub.docker.com/repository/docker/jammsen/palworld-dedicated-server) a star. @@ -70,17 +71,20 @@ To run this Docker image, you need a basic understanding of Docker, Docker-Compo 2. Set up Port-Forwarding or NAT for the ports in the Docker-Compose file. 3. Pull the latest version of the image with `docker pull jammsen/palworld-dedicated-server:latest`. 4. Download the [docker-compose.yml](docker-compose.yml) and [default.env](default.env). -5. Set up the `docker-compose.yml` and `default.env` to your liking. +5. Set up the `docker-compose.yml` and `default.env` to your liking. 1. Refer to the [Environment-Variables](#environment-variables) section for more information. -6. Start the container via `docker-compose up -d && docker-compose logs -f`. +6. Start the container via `docker-compose up -d && docker-compose logs -f`. 1. Watch the log, if no errors occur you can close the logs with ctrl+c. 7. Now have fun and happy gaming! +## Deploy with Helm + +A Helm chart to deploy this container can be found at [palworld-helm](https://github.com/caleb-devops/palworld-helm). + ## Environment variables See [this file](README_ENV.md) for the documentation - ## Docker-Compose examples ### Gameserver with RCON-CLI-Tool @@ -90,6 +94,7 @@ See [example docker-compose.yml](docker-compose.yml). #### Run RCON commands Open a shell into your container via `docker exec -ti palworld-dedicated-server bash`, then you can run commands against the gameserver via the command `rcon` or `rconcli` + ```shell $:~/steamcmd$ rcon showplayers name,playeruid,steamid @@ -98,27 +103,32 @@ Welcome to Pal Server[v0.1.3.0] jammsen-docker-generated-20384 $:~/steamcmd$ rcon save Complete Save ``` + > **Important:** Please research the RCON-Commands on the official source: https://tech.palworldgame.com/server-commands ## FAQ ### How can I use the interactive console in Portainer with this image? + You can run this `docker exec -ti palworld-dedicated-server bash' or you could navigate to the **"Stacks"** tab in Portainer, select your stack, and click on the container name. Then click on the **"Exec console"** button. ### How can I look into the config of my Palworld container? + You can run this `docker exec -ti palworld-dedicated-server cat /palworld/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini` and it will show you the config inside the container. -### Im seeing S_API errors in my logs when I start the container? +### I'm seeing S_API errors in my logs when I start the container? + Errors like `[S_API FAIL] Tried to access Steam interface SteamUser021 before SteamAPI_Init succeeded.` are safe to ignore. -### Im using Apple silicon type of hardware, can I run this? +### I'm using Apple silicon type of hardware, can I run this? + You can try to insert in your docker-compose file this parameter `platform: linux/amd64` at the palworld service. This isnt a special fix for Apple silicon, but to run on other than x86 hosts. The support for arm exists only by enforcing x86 emulation, if that isnt to host already. Rosetta is doing the translation/emulation. -### I have changed the `BaseCampWorkerMaxNum` settings, why are changes un-affected on the server? +### I changed the `BaseCampWorkerMaxNum` setting, why didn't this update the server? -It is a confirm bug, that changing `BaseCampWorkerMaxNum` in the `PalWorldSettings.ini` has no affect on the server. There are tools out there to help with this, like this one: +This is a confirmed bug. Changing `BaseCampWorkerMaxNum` in the `PalWorldSettings.ini` has no affect on the server. There are tools out there to help with this, like this one: -**PLEASE NOTE** that adding `WorldOption.sav` will breaking `PalWorldSetting.ini` and if that happens all the other settings won't be changeable anymore unless that specific tool is used everytime. +**PLEASE NOTE** Adding `WorldOption.sav` will break `PalWorldSetting.ini`. To make changes, you must update your `WorldOption.sav` again. ## Planned features in the future From e949ba409d5ba1cf1269ba806a6a7b128e993ab2 Mon Sep 17 00:00:00 2001 From: Caleb <23466706+caleb-devops@users.noreply.github.com> Date: Tue, 30 Jan 2024 20:08:54 -0700 Subject: [PATCH 2/5] Move helm deploy docs --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f6c88e6..6a562e3 100644 --- a/README.md +++ b/README.md @@ -24,11 +24,11 @@ ___ - [Requirements](#requirements) - [Minimum system requirements](#minimum-system-requirements) - [Getting started](#getting-started) - - [Deploy with Helm](#deploy-with-helm) - [Environment variables](#environment-variables) - [Docker-Compose examples](#docker-compose-examples) - [Gameserver with RCON-CLI-Tool](#gameserver-with-rcon-cli-tool) - [Run RCON commands](#run-rcon-commands) + - [Deploy with Helm](#deploy-with-helm) - [FAQ](#faq) - [How can I use the interactive console in Portainer with this image?](#how-can-i-use-the-interactive-console-in-portainer-with-this-image) - [How can I look into the config of my Palworld container?](#how-can-i-look-into-the-config-of-my-palworld-container) @@ -77,10 +77,6 @@ To run this Docker image, you need a basic understanding of Docker, Docker-Compo 1. Watch the log, if no errors occur you can close the logs with ctrl+c. 7. Now have fun and happy gaming! -## Deploy with Helm - -A Helm chart to deploy this container can be found at [palworld-helm](https://github.com/caleb-devops/palworld-helm). - ## Environment variables See [this file](README_ENV.md) for the documentation @@ -106,6 +102,10 @@ Complete Save > **Important:** Please research the RCON-Commands on the official source: https://tech.palworldgame.com/server-commands +## Deploy with Helm + +A Helm chart to deploy this container can be found at [palworld-helm](https://github.com/caleb-devops/palworld-helm). + ## FAQ ### How can I use the interactive console in Portainer with this image? From 3524b689b34f7b3a2bc2172aed2f42d7da0d7bbc Mon Sep 17 00:00:00 2001 From: Caleb <23466706+caleb-devops@users.noreply.github.com> Date: Wed, 31 Jan 2024 11:01:45 -0700 Subject: [PATCH 3/5] fix merge conflict --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 8436090..7f63594 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,6 @@ Complete Save > **Important:** Please research the RCON-Commands on the official source: https://tech.palworldgame.com/server-commands -======= ## Webhook integration To enable webhook integration, you need to set the following environment variables in the `default.env`: From f3a89979e49d99ba735b7bc33e38f99c66753bc7 Mon Sep 17 00:00:00 2001 From: Caleb <23466706+caleb-devops@users.noreply.github.com> Date: Wed, 31 Jan 2024 11:04:22 -0700 Subject: [PATCH 4/5] fix TOC --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7f63594..86e6f45 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ ___ - [Environment variables](#environment-variables) - [Docker-Compose examples](#docker-compose-examples) - [Gameserver with RCON-CLI-Tool](#gameserver-with-rcon-cli-tool) - - [Run RCON commands](#run-rcon-commands) + - [Run RCON commands](#run-rcon-commands) - [Webhook integration](#webhook-integration) - [Supported events](#supported-events) - [Deploy with Helm](#deploy-with-helm) From 86148abe12cfab611be151d55d3aa93827898f4f Mon Sep 17 00:00:00 2001 From: Caleb <23466706+caleb-devops@users.noreply.github.com> Date: Wed, 31 Jan 2024 11:05:15 -0700 Subject: [PATCH 5/5] Fix TOC --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 86e6f45..9b252c3 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ ___ - [Gameserver with RCON-CLI-Tool](#gameserver-with-rcon-cli-tool) - [Run RCON commands](#run-rcon-commands) - [Webhook integration](#webhook-integration) - - [Supported events](#supported-events) + - [Supported events](#supported-events) - [Deploy with Helm](#deploy-with-helm) - [FAQ](#faq) - [How can I use the interactive console in Portainer with this image?](#how-can-i-use-the-interactive-console-in-portainer-with-this-image)