feat: add steam downloading support. Bypassing self-packaging (#17)

Co-authored-by: DaanSelen <dselen@systemec.nl>

Author: DaanSelen

.gitignore

@@ -1,10 +1,10 @@
 save*
-*.tar.gz
+*.tar.gz*
 conf*
 !*configure*
 
 # The mods I cannot directly present
 AutoLoadGame
 DefaultOnCheats
 Multi-UserChest
-NoFenceDecayRedux
+NoFenceDecayRedux

Dockerfile

@@ -1,14 +1,32 @@
+# Install Microsoft's DotNet for the game
+
 FROM alpine:latest AS dotnet-installer
 
 RUN apk add --no-cache \
         bash curl \
     && curl -o /tmp/dotnet-install.sh https://raw.githubusercontent.com/dotnet/install-scripts/refs/heads/main/src/dotnet-install.sh \
     && bash /tmp/dotnet-install.sh --install-dir /usr/local/share/dotnet
 
+# Download the Stardew Valley game files from Steam (bypasses self-packaging)
+
+FROM steamcmd/steamcmd:debian-trixie AS steam-downloader
+
+ARG STEAM_USER
+ARG STEAM_PASS
+
+RUN if [ -n "$STEAM_USER" ] && [ -n "$STEAM_PASS" ]; then \
+      echo "Trying to use Steam credentials!"; \
+      steamcmd +force_install_dir /tmp/stardew +login ${STEAM_USER} ${STEAM_PASS} +app_update 413150 +quit; \
+    else \
+      mkdir /tmp/stardew; \
+      echo "Steam username or Password not provided"; \
+    fi
+
 # Unpack Stardew Valley
 FROM debian:stable-slim AS unpacker
 # You'll need to supply your own Stardew Valley game files, in the followin name: 'latest.tar.gz' or change the following line.
 
+ARG METHOD="LOCAL"
 ARG SMAPI_VERSION="4.3.2"
 
 RUN apt-get update \
@@ -17,11 +35,23 @@ RUN apt-get update \
         unzip \
         libicu-dev
 
-COPY ./latest.tar.gz /tmp/latest.tar.gz
-RUN mkdir -p /game/nexus \
-    && tar zxf /tmp/latest.tar.gz -C /game \
-    && rm /tmp/latest.tar.gz \
-    && mv /game/Stardew\ Valley /game/stardewvalley
+### UNPACKER PROVIDE GAME FILES
+COPY ./latest.tar.gz /tmp/local-stardew.tar.gz
+COPY --from=steam-downloader /tmp/stardew /tmp/steam-stardew
+
+RUN mkdir -p /game/nexus; \
+    echo "METHOD: $METHOD"; \
+    if [ "$METHOD" = "LOCAL" ]; then \
+        tar -zxf /tmp/local-stardew.tar.gz -C /game; \
+        \
+        if [ -d "/game/Stardew Valley" ]; then \
+            echo "Renaming Stardew Valley folder."; \
+            mv -v "/game/Stardew Valley" "/game/stardewvalley"; \
+        fi; \
+    elif [ "$METHOD" = "STEAM" ]; then \
+        mv /tmp/steam-stardew /game/stardewvalley; \
+    fi; \
+    rm -rfv /tmp/*-stardew.*
 
 RUN curl -L -o /tmp/nexus.zip https://github.com/Pathoschild/SMAPI/releases/download/${SMAPI_VERSION}/SMAPI-${SMAPI_VERSION}-installer.zip \
     && unzip /tmp/nexus.zip -d /game/nexus \

README.md

@@ -11,10 +11,15 @@ Therefor this project, it tries to modernize the packages with the same function
 
 # Overview:
 
+Just new! Steam downloading also supported now! Might be janky sometimes in terms of Steam Guard Authentication. But it works.<br>
+
 This container setup has a couple things to know. First off you need to get the game files yourself. I cannot legally present them here.<br>
 Furthermore you'll have to know that this server exposes at least 1 port, and at most 3 ports for a succesful server.<br>
 These are:
 
+For peace of mind, Chromium based browsers did perform the best for me.<br>
+Though I use Firefox for everything else.<br>
+
 ```
 - 24642/udp # This is the Stardew Valley Server port
 - 3000/tcp  # This is the raw-VNC port. For remote connections
@@ -23,17 +28,39 @@ These are:
 
 Steps to get it running:
 
-1. Package the game files.
+1. Package the game files. (Steam or Local)
 2. Build the container.
 3. Run the container.
 4. Go to the (web)-VNC port and access the server.
-5. Create a world and prepare for multiplayer.
+5. Create a world and prepare for multiplayer. (Be mindful you need the Autoload mod!)
 6. Once its done, you can join the server.
 
 # Getting the game files.
 
-Getting the game files is arguably the hardest part. I love this game, and I do recommend buying it for yourself.<br>
-Have fun!<br>
+Steam is now supported, so there are two methods. Local and Steam.
+
+Steam:
+
+For the Steam method, you need to have purchased the game on Steam and have your credentials ready.<br>
+In my case I also needed to have my authenticator mobile app ready to confirm.<br>
+
+When building just pass the following arguments:
+
+```sh
+--build-arg METHOD="STEAM"
+--build-arg STEAM_USER="<Your Steam Username>"
+--build-arg STEAM_PASS="<Your Steam Password>"
+```
+
+Alternatively you can also use/change the predefined fields inside the `./compose.yaml`<br>
+
+Be mindful that even though you are not supplying the game files locally, you still need to have an empty file present at `./latest.tar.gz`.<br>
+This is because the Dockerfile expects it to.
+
+Local:
+
+I love this game, and I do recommend buying it for yourself.<br>
+However if you are unable or unwilling to give Steam credentials, you can also use the packaging guide!<br>
 
 For indication on how to package the game yourself look at this document: [Packaging Guide](./guides/packaging.md).
 

compose.yaml

@@ -8,13 +8,17 @@ services:
     build:
       context: .
       dockerfile: ./Dockerfile
+      args:
+          METHOD: "LOCAL"
+#          STEAM_USER: "<your-steam-username>"
+#          STEAM_PASS: "<your-steam-password>"
     environment:
       - TZ=Europe/Amsterdam
       - CUSTOM_USER=stardew
       - PASSWORD=stardew
       - TITLE=Stardew Valley Game Server
     ports:
-#      - 3000:3000/tcp # Real VNC
+      - 3000:3000/tcp # Real VNC
       - 3001:3001/tcp # Web VNC
       - 24642:24642/udp # Stardew Valley Game Server
     volumes:

guides/mods.md

@@ -13,7 +13,7 @@ Mods/ (folder)
   ..other mods
 ```
 
-## AutoLoadGame (Nexus Mods)
+## AutoLoadGame (Nexus Mods) HIGHLY RECOMMENDED
 
 The first mod, AutoLoadMods is needed for automatically loading the save game when the container is restarted.
 
@@ -39,4 +39,4 @@ https://www.nexusmods.com/stardewvalley/mods/20802
 
 ## Closing
 
-Hopefully this satisfies the copyright set by the owners and the ease-of-use for the players.
+Hopefully this satisfies the copyright set by the owners and the ease-of-use for the players.