Merge branch 'main' into cron-backup

.github/workflows/release.yml

@@ -4,7 +4,9 @@ on:
     types: [published]
 
 jobs:
+  # Builds the Dockerfile and pushes it to dockerhub
   release:
+    name: Release - Docker image
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -34,3 +36,35 @@ jobs:
         with:
           push: true
           tags: ${{ steps.meta.outputs.tags }}
+
+  # Generates a new release specifically for the helm chart, using the helm charts version
+  # Only generates a new release if the helm charts version has changed since the last release
+  # Will then update the gh-pages branch & helm repository
+  release-helm:
+    name: Release - Helm chart
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pages: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Git - Configure
+        run: |
+          git config user.name "$GITHUB_ACTOR"
+          git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
+
+      # Will push updates to a index.yaml file in the gh-pages branch
+      - name: Helm - chart-releaser
+        uses: helm/chart-releaser-action@v1.6.0
+        with:
+          charts_dir: charts
+          pages_branch: gh-pages
+          mark_as_latest: false
+          skip_existing: true
+          config: ./charts/cr.yaml
+        env:
+          CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

.gitignore

@@ -1,4 +1,4 @@
 palworld
 .idea
+!charts/*
 values*.yaml
-!chart/values.yaml

README.md

@@ -48,6 +48,7 @@ services:
       image: thijsvanloef/palworld-server-docker:latest
       restart: unless-stopped
       container_name: palworld-server
+      stop_grace_period: 30s # Set to however long you are willing to wait for the container to gracefully stop
       ports:
         - 8211:8211/udp
         - 27015:27015/udp
@@ -97,6 +98,10 @@ docker run -d \
 
 ```
 
+> [!TIP]
+> If you want to stop the container with a custom stop grace period then run:
+> `docker stop --name palworld-server --time 30`
+
 ### Kubernetes
 
 All files you will need to deploy this container to kubernetes are located in the [k8s folder](k8s/).
@@ -105,7 +110,7 @@ Follow the steps in the [README.md here](k8s/readme.md) to deploy it.
 
 #### Using helm chart
 
-Follow up the docs on the [README.md for the helm chart](./chart/README.md) to deploy.
+Follow up the docs on the [README.md for the helm chart](./charts/palworld/README.md) to deploy.
 
 ### Environment variables
 
@@ -297,12 +302,12 @@ BACKUP_ENABLED=true
 
 When the server starts, a `PalWorldSettings.ini` file will be created in the following location: `<mount_folder>/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini`
 
-Any changes made while the server is live will be overridden.
-
 Please keep in mind that the ENV variables will always overwrite the changes made to `PalWorldSettings.ini`.
 
 > [!IMPORTANT]
 > Changes can only be made to `PalWorldSettings.ini` while the server is off.
+>
+> Any changes made while the server is live will be overwritten when the server stops.
 
 For a more detailed list of explanations of server settings go to: [shockbyte](https://shockbyte.com/billing/knowledgebase/1189/How-to-Configure-your-Palworld-server.html)
 

charts/cr.yaml

@@ -0,0 +1 @@
+release-name-template: "chart-{{ .Version }}"

charts/palworld/Chart.yaml

@@ -1,7 +1,7 @@
 apiVersion: v2
 name: palworld
-version: 0.0.1
+version: 0.0.2
-description: This chart can provide an rAthena emulator installation on a Kubernetes cluster.
+description: This chart will provide a Palworld server installation on a kubernetes cluster.
 type: application
 keywords:
   - palworld

charts/palworld/VALUES_SUMMARY.md

@@ -1,10 +1,10 @@
 # palworld
 
-![Version: 0.0.0](https://img.shields.io/badge/Version-0.0.0-informational)
+![Version: 0.0.2](https://img.shields.io/badge/Version-0.0.2-informational)
 ![Type: application](https://img.shields.io/badge/Type-application-informational)
 ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational)
 
-This chart can provide an rAthena emulator installation on a Kubernetes cluster.
+This chart will provide a Palworld server installation on a kubernetes cluster.
 
 **Homepage:** <https://github.com/thijsvanloef/palworld-server-docker>
 
@@ -32,11 +32,17 @@ This chart can provide an rAthena emulator installation on a Kubernetes cluster.
 | server.config.labels | object | `{}` | Additional labels to the resources |
 | server.config.max_players | int | `16` | The max number of players supported. |
 | server.config.multithreading | bool | `true` | Enables the multithreading, allowing the usage of up to 4 cores (needs citation) |
+| server.config.public_ip | string | `""` | You can manually specify the global IP address of the network on which the server running. If not specified, it will be detected automatically. If it does not work well, try manual configuration. |
+| server.config.public_port | string | `""` | You can manually specify the port number of the network on which the server running. If not specified, it will be detected automatically. If it does not work well, try manual configuration. |
 | server.config.query_port | string | `27015` | The query port of the game. |
 | server.config.rcon | dict |  | Remote connection configuration. Allows the remote connection and management for the server. Those are directly connected with the container image, providing multiple environment variables to the scripts. |
 | server.config.rcon.enable | bool | `true` | Enables/disables the rcon port. |
 | server.config.rcon.password | string | `""` | If not provided, a random password will be generated and stored on the secret. |
 | server.config.rcon.port | string | `25575` | The port for rcon. If you change this, make sure to change the service.ports and server.ports accordingly. |
+| server.config.server_description | string | `""` | Your server description to be shown in game |
+| server.config.timezone | string | `"UTC"` | The timezone used for time stamping backup server. Use the IANA TZ format with Area/Location See the [list of TZ database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#Time_Zone_abbreviations) |
+| server.config.update_on_boot | string | `true` | Update/Install the server when the container starts. THIS HAS TO BE ENABLED THE FIRST TIME YOU RUN THE CONTAINER |
+| server.config.world_parameters | object |  | Configures the game world settings. The key:values here should represent in game accepted values. Wrap all values with quotes here to avoid validation issues. |
 | server.image | dict |  | Define the parameters for the server image container |
 | server.image.imagePullPolicy | string | `"IfNotPresent"` | Define the pull policy for the server image. |
 | server.image.name | string | `"thijsvanloef/palworld-server-docker"` | Name of the image, without the tag. |
@@ -63,6 +69,7 @@ This chart can provide an rAthena emulator installation on a Kubernetes cluster.
 | server.storage.preventDelete | bool | `false` | Keeps helm from deleting the PVC. By default, helm does not delete pvcs. |
 | server.storage.size | string | `"12Gi"` | The size of the pvc storage. |
 | server.storage.storageClassName | string | `""` | The storage class name. |
+| server.strategy | string | `"Recreate"` | Change the deployment strategy |
 
 ----------------------------------------------
 Autogenerated from chart metadata using [helm-docs v1.12.0](https://github.com/norwoodj/helm-docs/releases/v1.12.0)

charts/palworld/templates/configmaps.yaml

@@ -38,3 +38,14 @@ data:
   {{ else }}
   SERVER_NAME: {{ printf "%s_%s" "palworld" (randAlphaNum 6 | nospace) }}
   {{ end }}
+  TZ: {{ .Values.server.config.timezone }}
+  PUBLIC_IP: {{ .Values.server.config.public_ip | quote }}
+  PUBLIC_PORT: {{ .Values.server.config.public_port | quote }}
+  SERVER_DESCRIPTION: {{ .Values.server.config.server_description }}
+  UPDATE_ON_BOOT: {{ .Values.server.config.update_on_boot | quote }}
+  QUERY_PORT: {{ .Values.server.config.query_port | quote }}
+  {{ if .Values.server.config.world_parameters }}
+  {{- with .Values.server.config.world_parameters }}
+  {{- toYaml . | nindent 2  }}
+  {{- end }}
+  {{ end }}

charts/palworld/templates/services.yaml

@@ -15,7 +15,7 @@ metadata:
     {{- toYaml . | nindent 4 }}
     {{- end }}
   annotations:
-    {{- with .Values.server.config.annotations }}
+    {{- with .Values.server.service.annotations }}
     {{- toYaml . | nindent 4 }}
     {{- end }}
 spec:

charts/palworld/values.yaml

@@ -137,3 +137,74 @@ server:
       password: ""
       # -- (string) If not provided, a random server name will be generated with the "palworld_" prefix.
     server_name: ""
+    # -- (string) The timezone used for time stamping backup server. Use the IANA TZ format with Area/Location
+    # See the [list of TZ database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#Time_Zone_abbreviations)
+    timezone: "UTC"
+    # -- (string) You can manually specify the global IP address of the network on which the server running.
+    # If not specified, it will be detected automatically. If it does not work well, try manual configuration.
+    public_ip: ""
+    # -- (string) You can manually specify the port number of the network on which the server running.
+    # If not specified, it will be detected automatically. If it does not work well, try manual configuration.
+    public_port: ""
+    # -- (string) Your server description to be shown in game
+    server_description: ""
+    # -- (string) Update/Install the server when the container starts.
+    # THIS HAS TO BE ENABLED THE FIRST TIME YOU RUN THE CONTAINER
+    update_on_boot: true
+    # -- (object) Configures the game world settings.
+    # The key:values here should represent in game accepted values.
+    # Wrap all values with quotes here to avoid validation issues.
+    # @notationType -- bigValue
+    world_parameters:
+      DAYTIME_SPEEDRATE: "1.000000"
+      NIGHTTIME_SPEEDRATE: "1.000000"
+      EXP_RATE: "1.000000"
+      PAL_CAPTURE_RATE: "1.000000"
+      PAL_SPAWN_NUM_RATE: "1.000000"
+      PAL_DAMAGE_RATE_ATTACK: "1.000000"
+      PAL_DAMAGE_RATE_DEFENSE: "1.000000"
+      PLAYER_DAMAGE_RATE_ATTACK: "1.000000"
+      PLAYER_DAMAGE_RATE_DEFENSE: "1.000000"
+      PLAYER_STOMACH_DECREASE_RATE: "1.000000"
+      PLAYER_STAMINA_DECREASE_RATE: "1.000000"
+      PLAYER_AUTO_HP_REGEN_RATE: "1.000000"
+      PLAYER_AUTO_HP_REGEN_RATE_IN_SLEEP: "1.000000"
+      PAL_STOMACH_DECREASE_RATE: "1.000000"
+      PAL_STAMINA_DECREASE_RATE: "1.000000"
+      PAL_AUTO_HP_REGEN_RATE: "1.000000"
+      PAL_AUTO_HP_REGEN_RATE_IN_SLEEP: "1.000000"
+      BUILD_OBJECT_DAMAGE_RATE: "1.000000"
+      BUILD_OBJECT_DETERIORATION_DAMAGE_RATE: "1.000000"
+      COLLECTION_DROP_RATE: "1.000000"
+      COLLECTION_OBJECT_HP_RATE: "1.000000"
+      COLLECTION_OBJECT_RESPAWN_SPEED_RATE: "1.000000"
+      ENEMY_DROP_ITEM_RATE: "1.000000"
+      DEATH_PENALTY: "All"
+      ENABLE_PLAYER_TO_PLAYER_DAMAGE: "False"
+      ENABLE_FRIENDLY_FIRE: "False"
+      ENABLE_INVADER_ENEMY: "True"
+      ACTIVE_UNKO: "True"
+      ENABLE_AIM_ASSIST_PAD: "True"
+      ENABLE_AIM_ASSIST_KEYBOARD: "False"
+      DROP_ITEM_MAX_NUM: "3000"
+      DROP_ITEM_MAX_NUM_UNKO: "1000"
+      BASE_CAMP_MAX_NUM: "128"
+      BASE_CAMP_WORKER_MAXNUM: "15"
+      DROP_ITEM_ALIVE_MAX_HOURS: "1.000000"
+      AUTO_RESET_GUILD_NO_ONLINE_PLAYERS: "False"
+      AUTO_RESET_GUILD_TIME_NO_ONLINE_PLAYERS: "72.000000"
+      GUILD_PLAYER_MAX_NUM: "3"
+      PAL_EGG_DEFAULT_HATCHING_TIME: "72.000000"
+      WORK_SPEED_RATE: "1.000000"
+      IS_MULTIPLAY: "False"
+      IS_PVP: "False"
+      CAN_PICKUP_OTHER_GUILD_DEATH_PENALTY_DROP: "False"
+      ENABLE_NON_LOGIN_PENALTY: "True"
+      ENABLE_FAST_TRAVEL: "True"
+      IS_START_LOCATION_SELECT_BY_MAP: "True"
+      EXIST_PLAYER_AFTER_LOGOUT: "False"
+      ENABLE_DEFENSE_OTHER_GUILD_PLAYER: "False"
+      COOP_PLAYER_MAX_NUM: "4"
+      REGION: ""
+      USEAUTH: "True"
+      BAN_LIST_URL: "https://api.palworldgame.com/api/banlist.txt"

docker-compose.yml

@@ -3,6 +3,7 @@ services:
       image: thijsvanloef/palworld-server-docker:latest
       restart: unless-stopped
       container_name: palworld-server
+      stop_grace_period: 30s # Set to however long you are willing to wait for the container to gracefully stop
       ports:
         - 8211:8211/udp
         - 27015:27015/udp # Required if you want your server to show up in the community servers tab