Release v2 (#10)

* Palworld to GSM

* Update gsm-reference

* GSM reference

* GSM reference

* with branches main

* sha for release

Author: mbround18

.github/workflows/release.yaml

@@ -1,6 +1,9 @@
 name: Docker Release
 
-on: 
+on:
+  pull_request:
+    branches:
+      - main
   workflow_dispatch:        
   push:
     tags:

Dockerfile

@@ -12,35 +12,30 @@ RUN apt-get update                        \
     && apt-get install -y -qq             \
         build-essential                   \
         htop net-tools nano gcc g++ gdb   \
-        netcat curl wget zip unzip        \
+        curl wget zip unzip               \
         cron sudo gosu dos2unix  jq       \
-        tzdata python3 python3-pip        \
+        tzdata                            \
     && rm -rf /var/lib/apt/lists/*        \
     && gosu nobody true                   \
     && dos2unix
 
-RUN addgroup --system steam     \
-    && adduser --system         \
-      --home /home/steam        \
-      --shell /bin/bash         \
-      steam                     \
-    && usermod -aG steam steam  \
+# Remove any existing user or group with ID 1000
+RUN if getent passwd 1000 > /dev/null; then userdel $(getent passwd 1000 | cut -d: -f1); fi \
+    && if getent group 1000 > /dev/null; then groupdel $(getent group 1000 | cut -d: -f1); fi \
+    && groupadd -g 1000 steam \
+    && useradd -u 1000 -g 1000 \
+      -d /home/steam \
+      -s /bin/bash \
+      -m steam \
     && chmod ugo+rw /tmp/dumps
-#COPY --chown=steam:steam /root/.steam /home/steam/.steam
-#COPY --chown=steam:steam /root/.local /home/steam/.local
 
 
 # Container informaiton
 ARG GITHUB_SHA="not-set"
 ARG GITHUB_REF="not-set"
 ARG GITHUB_REPOSITORY="not-set"
 
-ENV PUID=1000
-ENV PGID=1000
-
-RUN usermod -u ${PUID} steam                                \
-    && groupmod -g ${PGID} steam                            \
-    && echo "steam ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers
+RUN echo "steam ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers
 
 USER steam
 
@@ -55,19 +50,20 @@ COPY --chown=${PUID}:${PGID} ./Pipfile ./Pipfile.lock /home/steam/scripts/
 
 ENV PATH="/home/steam/.local/bin:${PATH}"
 
-RUN pip3 install pipenv \
-    && cd /home/steam/scripts \
-    && pipenv install --system --deploy --ignore-pipfile
+COPY --chown=${PUID}:${PGID} ./scripts/entrypoint.sh /entrypoint.sh
 
-COPY --chown=${PUID}:${PGID} ./scripts /home/steam/scripts
+RUN mkdir -p $HOME/.steam \
+    && mkdir -p $HOME/palworld \
+    && ln -s $HOME/.local/share/Steam/steamcmd/linux32 $HOME/.steam/sdk32 \
+    && ln -s $HOME/.local/share/Steam/steamcmd/linux64 $HOME/.steam/sdk64 \
+    && ln -s $HOME/.steam/sdk32/steamclient.so $HOME/.steam/sdk32/steamservice.so || true \
+    && ln -s $HOME/.steam/sdk64/steamclient.so $HOME/.steam/sdk64/steamservice.so || true
 
+WORKDIR /home/steam/palworld
 
 EXPOSE 8211/udp
 EXPOSE 27015/udp
 
-RUN echo "source /home/steam/scripts/utils.sh" >> /home/steam/.bashrc
-
-#HEALTHCHECK --interval=1m --timeout=3s \
-#    CMD pidof valheim_server.x86_64 || exit 1
+COPY --from=mbround18/gsm-reference:sha-7ec6fa9 /app/palworld /usr/local/bin/palworld
 
-ENTRYPOINT ["/bin/bash","/home/steam/scripts/entrypoint.sh"]
+ENTRYPOINT ["/entrypoint.sh"]

Makefile

@@ -0,0 +1,14 @@
+.PHONY: docker-build docker-dev docker-push
+GIT_TAG := $(shell git rev-parse --short HEAD)
+export COMPOSE_BAKE=true
+
+docker-build:
+	@docker compose build
+
+docker-dev: docker-build
+	@docker compose up --abort-on-container-exit
+
+docker-push: docker-build
+	@docker tag mbround18/palworld-docker:latest mbround18/palworld-docker:sha-$(GIT_TAG)
+	@docker image push mbround18/palworld-docker:sha-$(GIT_TAG)
+	@echo "Pushed mbround18/palworld-docker:sha-$(GIT_TAG)"

README.md

@@ -1,7 +1,8 @@
-# Palworld Server 
+# Palworld Server   
 
-🌟 Welcome to the ultimate Palworld Server Setup! 🌍 This GitHub repository is your go-to toolkit 🛠️ for launching a Palworld server in a snap using Docker! Choose from preset worlds like 'casual' 🏖️, 'normal' 🌆, or 'hard' 🌋, or dive deep into customization with flexible settings 🎛️.
+[![Managed by GSM](https://img.shields.io/badge/Managed%20By-GSM-blue)](https://github.com/mbround18/game-server-management)
 
+🌟 Welcome to the ultimate Palworld Server Setup! 🌍 This GitHub repository is your go-to toolkit 🛠️ for launching a Palworld server in a snap using Docker! Choose from preset worlds like 'casual' 🏖️, 'normal' 🌆, or 'hard' 🌋, or dive deep into customization with flexible settings 🎛️.
 
 ## !!Notice!! Bug with saves, developers of Palworld working hard to fix!
 
@@ -22,18 +23,61 @@ The server can be configured either through environment variables or by passing
 - `normal`
 - `hard`
 
-Additionally, you can customize the following settings:
-
-- `DAY_TIME_SPEED_RATE`: Control the speed of day time.
-- `NIGHT_TIME_SPEED_RATE`: Control the speed of night time.
-- `EXP_RATE`: Experience points rate.
-- (And so on for each configurable option...)
+### Environment Variables
+
+Below is a list of available environment variables to customize your server:
+
+#### General Server Settings
+- `SERVER_NAME`: The name of your server.
+- `SERVER_DESCRIPTION`: A short description of your server.
+- `PUBLIC_IP`: Set the public IP of the server.
+- `PUBLIC_PORT`: The public port for connections.
+- `PORT`: The internal port of the game server.
+- `ADMIN_PASSWORD`: The password for admin access.
+- `SERVER_PASSWORD`: The password required to join the server.
+- `REGION`: Define the server’s region.
+- `USE_AUTH`: Enable authentication (`true` or `false`).
+
+#### Performance and Networking
+- `MULTITHREADING`: Enable multithreading (`true` or `false`).
+- `RCON_ENABLED`: Enable remote console (`true` or `false`).
+- `RCON_PORT`: Port for RCON access.
+- `RESTAPI_ENABLED`: Enable REST API (`true` or `false`).
+- `RESTAPI_PORT`: Port for the REST API.
+- `MAX_BUILDING_LIMIT_NUM`: Maximum number of buildings allowed.
+
+#### Gameplay and Balance
+- `EXP_RATE`: Modify experience rate multiplier.
+- `PAL_CAPTURE_RATE`: Adjust the Pal capture success rate.
+- `DAY_TIME_SPEED_RATE`: Adjust how fast daytime progresses.
+- `NIGHT_TIME_SPEED_RATE`: Adjust how fast nighttime progresses.
+- `DEATH_PENALTY`: Define what happens on player death.
+- `ENABLE_FAST_TRAVEL`: Allow fast travel (`true` or `false`).
+- `ENABLE_INVADER_ENEMY`: Enable invader enemies (`true` or `false`).
+- `HARDCORE`: Enable hardcore mode (`true` or `false`).
+- `PAL_LOST`: Determine if Pals are lost upon death (`true` or `false`).
+- `ITEM_WEIGHT_RATE`: Adjust item weight multiplier.
+- `PAL_DAMAGE_RATE_ATTACK`: Modify Pal attack damage.
+- `PAL_DAMAGE_RATE_DEFENSE`: Modify Pal defense rate.
+- `PLAYER_DAMAGE_RATE_ATTACK`: Modify player attack damage.
+- `PLAYER_DAMAGE_RATE_DEFENSE`: Modify player defense rate.
+- `WORK_SPEED_RATE`: Adjust work speed multiplier.
+- `AUTO_SAVE_SPAN`: Set the frequency of autosaves (in minutes).
+
+#### Multiplayer and Guild Settings
+- `GUILD_PLAYER_MAX_NUM`: Maximum number of players per guild.
+- `BASE_CAMP_MAX_NUM_IN_GUILD`: Maximum number of camps per guild.
+- `ALLOW_CONNECT_PLATFORM`: Restrict platform connections (`Steam`, `Epic`, etc.).
+- `SHOW_PLAYER_LIST`: Display the online player list (`true` or `false`).
+- `CHAT_POST_LIMIT_PER_MINUTE`: Limit chat messages per minute.
+- `EXIST_PLAYER_AFTER_LOGOUT`: Keep players visible after logout (`true` or `false`).
+- `ENABLE_DEFENSE_OTHER_GUILD_PLAYER`: Enable defense against other guilds (`true` or `false`).
 
 To see a full list of supported configuration options, see the [Environment Configuration Options](./docs/environment_variables.md) page.
 
 ## Using Docker Compose
 
-To run the server with Docker Compose, you first need to create a `docker-compose.yml` file in the root of this repository with the following content:
+To run the server with Docker Compose, create a `docker-compose.yml` file with the following content:
 
 ```yaml
 version: "3.8"
@@ -42,14 +86,14 @@ services:
     image: mbround18/palworld-docker:latest
     environment:
       PRESET: "casual" # Options: casual, normal, hard
-      MULTITHREADING: true # Optional, Allows for multithreading the server. 
-      # Optionally override specific settings:
-      # DAY_TIME_SPEED_RATE: '1'
-      # NIGHT_TIME_SPEED_RATE: '1'
-      # And so on...
+      MULTITHREADING: true # Enables multithreading
+      PUBLIC_IP: "0.0.0.0"
+      PUBLIC_PORT: "8211"
+      SERVER_NAME: "My Palworld Server"
+      EXP_RATE: "1.5"
     ports:
       - "8211:8211" # Default game port
-      - "27015:27015" # steam query port
+      - "27015:27015" # Steam query port
     volumes:
       - "./data:/home/steam/palworld"
 ```
@@ -82,8 +126,9 @@ docker-compose down
 docker-compose up
 ```
 
-This process ensures that your server configuration is always up to date with your specifications.
+This ensures that your server configuration remains up to date.
 
 ## Contributions
 
 Contributions to this project are welcome! Please submit a pull request or open an issue for any bugs, features, or improvements.
+

docker-compose.yml

@@ -8,6 +8,8 @@ services:
         - linux/amd64
     environment:
       PRESET: "Normal"
+      SERVER_PASSWORD: "secure-password"
+      ADMIN_PASSWORD: "super-secret-password"
     ports:
       - "8211:8211"
       - "27015:27015"