Add: StarRupture

README.md

@@ -266,6 +266,8 @@ Below is a categorized list of games with links to their respective server confi
 
 #### [Soldat 2](./soldat_2)
 
+#### [StarRupture](./starrupture)
+
 #### [Sunkenland](./sunkenland)
 
 ### [Voyager of Nera](./voyagers_of_nera)

starrupture/README.md

@@ -0,0 +1,134 @@
+# StarRupture
+
+StarRupture is a first-person open-world base-building game with advanced combat and tons of exploration. Play alone or in a group on this sublime and ever-changing planet, extract and manage resources, create your complex industrial system, and fight off hordes of alien monsters.
+
+> ⚠️ **Note:** Server software is still in an experimental phase. Expect some issues in future updates!
+
+## Contributors
+
+| Name       | GitHub Profile                          |
+|------------|-----------------------------------------|
+| brainshead | https://github.com/brainshead           |
+| SavageCore | https://github.com/SavageCore           |
+
+## Server Ports
+
+| Name | Default |
+|------|---------|
+| Game | 7777    |
+
+> ⚠️ **Important:** You must connect to the server using the **WAN IP** and port, even if running locally.
+
+## System Requirements
+
+| Type        | Memory | Storage |
+|-------------|--------|---------|
+| Minimal     | 2 GB   | 25 GB   |
+| Recommended | 4+ GB  | 40 GB+  |
+
+## Configuration Files
+
+| File                | Purpose                      | Path                                       |
+|---------------------|------------------------------|--------------------------------------------|
+| DSSettings.txt      | Server configuration for save management   | /home/container/DSSettings.txt |
+| Password.json       | Admin password configuration | /home/container/Password.json              |
+| PlayerPassword.json | Server join password configuration | /home/container/PlayerPassword.json        |
+| .pteroignore        | Files/folders to ignore during backups | /home/container/.pteroignore               |
+
+Unofficial documentation: https://wiki.starrupture-utilities.com/en/dedicated-server/configuration
+
+---
+
+# Setup Methods
+
+There are two ways to configure your server: via the **Panel** (recommended) or **In-Game**. Choose one method and follow it consistently.
+
+---
+
+## Method 1: Panel Configuration (Recommended)
+
+This method uses the Pterodactyl Panel and DSSettings.txt for all configuration. It is the recommended approach because settings persist across server restarts, and the in-game management system has known vulnerabilities, such as wiping saves and changing admin passwords. Read more: https://wiki.starrupture-utilities.com/en/dedicated-server/Vulnerability-Announcement
+
+> ⚠️ **Important:** Always stop the server before making configuration changes.
+
+### Password Setup
+
+> ⚠️ **Warning:** Anyone who knows your IP and port can join your server if no password is set!
+
+#### Automatic Setup (Recommended)
+
+If you set the `[SERVER] Admin Password` and `[SERVER] Player Password` variables in the **Startup** tab before installing the server, the password files will be created automatically during installation.
+
+#### Manual Setup
+
+If you didn't set passwords during installation, you can create them manually:
+
+1. Visit https://starrupture-utilities.com/passwords
+2. Generate both an Admin password and a Player password
+3. Create `Password.json` in the root of the container (`/home/container/`) and paste the generated content
+4. Create `PlayerPassword.json` in the root of the container (`/home/container/`) and paste the generated content
+5. Start the server
+
+### Save Game Settings
+
+The egg manages `DSSettings.txt` automatically via the Panel's **Startup** tab.
+
+| Panel Option               | DSSettings.txt Key | Description                                                    |
+|----------------------------|--------------------|----------------------------------------------------------------|
+| `[SERVER] Session Name`    | `SessionName`      | Name of the save game session (max 20 characters)              |
+| `[SERVER] Save Interval`   | `SaveGameInterval` | Time between automatic saves in seconds (e.g., `300` = 5 mins) |
+| `[SERVER] Start new Savegame` | `StartNewGame`  | `true` to create a new world (use only once!)                  |
+| `[SERVER] Load saved Game` | `LoadSavedGame`    | `true` to load an existing save on startup                     |
+| `[SERVER] Savegame Name`   | `SaveGameName`     | Filename of the save to load (e.g., `AutoSave0.sav`)           |
+
+### Creating a New World
+
+> ⚠️ **Important:** Only enable `Start new Savegame` for initial world creation - disable it immediately after!
+
+1. Stop the server
+2. Go to the **Startup** tab in the Panel
+3. Set `[SERVER] Load saved Game` to `false`
+4. Set `[SERVER] Start new Savegame` to `true`
+5. Start the server and wait for it to finish loading
+    1. Join using the server's WAN IP and port
+    2. Press ESC to open the menu and then select Save. This will instruct the server to save the file to `StarRupture\Saved\SaveGames\SessionName`
+    3. Disconnect from the server
+6. Stop the server
+7. Set `[SERVER] Load saved Game` to `true`
+8. Set `[SERVER] Start new Savegame` to `false`
+9. Start the server - your world will now load automatically on every startup
+
+### Loading an Existing Save
+
+1. Stop the server
+2. Go to the **Startup** tab in the Panel
+3. Set `[SERVER] Load saved Game` to `true`
+4. Set `[SERVER] Start new Savegame` to `false`
+5. Set `[SERVER] Savegame Name` to match your save file (e.g., `AutoSave0.sav`)
+6. Set `[SERVER] Session Name` to match your session folder name (e.g., `StarRuptureServer`)
+7. Start the server
+
+---
+
+## Method 2: In-Game Configuration
+
+This method uses the game's built-in **Manage Server** feature. Only use this method if you have issues with DSSettings.txt and are aware of the vulnerabilities mentioned above.
+
+> ⚠️ **Important:** For this method to work, `DSSettings.txt` must **not** exist. Shutdown the server and delete it if present. You'll be stuck on a loading spinner when trying to connect if it exists. You must also remove `-RCWebControlDisable` and `-RCWebInterfaceDisable` from the startup parameters in the **Startup** tab.
+
+### Password Setup
+
+1. Start your server
+2. Open the StarRupture game client
+3. From the main menu, select **Manage Server** and connect to your server
+4. When prompted, configure an **Admin Password**
+5. Click **Change Password** to set the player join password
+
+### Save Game Management
+
+1. Start your server
+2. Open the StarRupture game client
+3. From the main menu, select **Manage Server** and connect to your server
+4. Use the in-game interface to create a new world or load an existing save
+
+> ⚠️ **Note:** With this method, you will need to load your save via the in-game interface each time the server restarts.

starrupture/egg-star-rupture.json

@@ -0,0 +1,132 @@
+{
+    "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO",
+    "meta": {
+        "version": "PTDL_v2",
+        "update_url": null
+    },
+    "exported_at": "2026-01-17T02:55:26+00:00",
+    "name": "StarRupture",
+    "author": "[email protected]",
+    "description": "StarRupture is a first-person open world base-building game with advanced combat and tons of exploration. Play alone or in a group on this sublime and ever-changing planet, extract and manage resources, create your complex industrial system and fight off hordes of alien monsters.",
+    "features": [],
+    "docker_images": {
+        "ghcr.io\/ptero-eggs\/steamcmd:proton": "ghcr.io\/ptero-eggs\/steamcmd:proton"
+    },
+    "file_denylist": [],
+    "startup": "proton run \/home\/container\/StarRupture\/Binaries\/Win64\/StarRuptureServerEOS-Win64-Shipping.exe -Log -Port=${SERVER_PORT} -RCWebControlDisable -RCWebInterfaceDisable & SR_PID=$!; tail -c0 -F \/home\/container\/StarRupture\/Saved\/Logs\/StarRupture.log --pid=$SR_PID | grep -v -E \"LogCore: Warning|LogUObjectBase: Error\"",
+    "config": {
+        "files": "{\r\n    \"DSSettings.txt\": {\r\n        \"parser\": \"json\",\r\n        \"find\": {\r\n            \"SessionName\": \"{{server.build.env.SESSION_NAME}}\",\r\n            \"SaveGameInterval\": \"{{server.build.env.SAVE_INTERVAL}}\",\r\n            \"StartNewGame\": \"{{server.build.env.START_NEW}}\",\r\n            \"LoadSavedGame\": \"{{server.build.env.LOAD_SAVE}}\",\r\n            \"SaveGameName\": \"{{server.build.env.SAVEGAME_NAME}}\"\r\n        }\r\n    }\r\n}",
+        "startup": "{\r\n    \"done\": \"LogCommonSession: OnUpdateSessionComplete(SessionName: GameSession, bWasSuccessful: true\"\r\n}",
+        "logs": "{}",
+        "stop": "^C"
+    },
+    "scripts": {
+        "installation": {
+            "script": "#!\/bin\/bash\r\n# steamcmd Base Installation Script\r\n#\r\n# Server Files: \/mnt\/server\r\n# Image to install with is 'ghcr.io\/ptero-eggs\/installers:debian'\r\n\r\n##\r\n#\r\n# Variables\r\n# STEAM_USER, STEAM_PASS, STEAM_AUTH - Steam user setup. If a user has 2fa enabled it will most likely fail due to timeout. Leave blank for anon install.\r\n# WINDOWS_INSTALL - if it's a windows server you want to install set to 1\r\n# SRCDS_APPID - steam app id found here - https:\/\/developer.valvesoftware.com\/wiki\/Dedicated_Servers_List\r\n# SRCDS_BETAID - beta branch of a steam app. Leave blank to install normal branch\r\n# SRCDS_BETAPASS - password for a beta branch should one be required during private or closed testing phases.. Leave blank for no password.\r\n# INSTALL_FLAGS - Any additional SteamCMD  flags to pass during install.. Keep in mind that steamcmd auto update process in the docker image might overwrite or ignore these when it performs update on server boot.\r\n# AUTO_UPDATE - Adding this variable to the egg allows disabling or enabling automated updates on boot. Boolean value. 0 to disable and 1 to enable.\r\n# ADMIN_PASSWORD - admin password if any\r\n# PLAYER_PASSWORD - server password if any\r\n#\r\n ##\r\n\r\n# Install packages. Default packages below are not required if using our existing install image thus speeding up the install process.\r\n#apt -y update\r\n#apt -y --no-install-recommends install curl lib32gcc-s1 ca-certificates\r\n\r\n## just in case someone removed the defaults.\r\nif [[ \"${STEAM_USER}\" == \"\" ]] || [[ \"${STEAM_PASS}\" == \"\" ]]; then\r\n    echo -e \"steam user is not set.\\n\"\r\n    echo -e \"Using anonymous user.\\n\"\r\n    STEAM_USER=anonymous\r\n    STEAM_PASS=\"\"\r\n    STEAM_AUTH=\"\"\r\nelse\r\n    echo -e \"user set to ${STEAM_USER}\"\r\nfi\r\n\r\n## download and install steamcmd\r\ncd \/tmp\r\nmkdir -p \/mnt\/server\/steamcmd\r\ncurl -sSL -o steamcmd.tar.gz https:\/\/steamcdn-a.akamaihd.net\/client\/installer\/steamcmd_linux.tar.gz\r\ntar -xzvf steamcmd.tar.gz -C \/mnt\/server\/steamcmd\r\nmkdir -p \/mnt\/server\/steamapps # Fix steamcmd disk write error when this folder is missing\r\ncd \/mnt\/server\/steamcmd\r\n\r\n# SteamCMD fails otherwise for some reason, even running as root.\r\n# This is changed at the end of the install process anyways.\r\nchown -R root:root \/mnt\r\nexport HOME=\/mnt\/server\r\n\r\n## install game using steamcmd\r\n.\/steamcmd.sh +force_install_dir \/mnt\/server +login ${STEAM_USER} ${STEAM_PASS} ${STEAM_AUTH} $( [[ \"${WINDOWS_INSTALL}\" == \"1\" ]] && printf %s '+@sSteamCmdForcePlatformType windows' ) +app_update ${SRCDS_APPID} $( [[ -z ${SRCDS_BETAID} ]] || printf %s \"-beta ${SRCDS_BETAID}\" ) $( [[ -z ${SRCDS_BETAPASS} ]] || printf %s \"-betapassword ${SRCDS_BETAPASS}\" ) ${INSTALL_FLAGS} validate +quit ## other flags may be needed depending on install. looking at you cs 1.6\r\n\r\n## set up 32 bit libraries\r\nmkdir -p \/mnt\/server\/.steam\/sdk32\r\ncp -v linux32\/steamclient.so ..\/.steam\/sdk32\/steamclient.so\r\n\r\n## set up 64 bit libraries\r\nmkdir -p \/mnt\/server\/.steam\/sdk64\r\ncp -v linux64\/steamclient.so ..\/.steam\/sdk64\/steamclient.so\r\n\r\n## create DSSettings.txt\r\nif [ ! -f \/mnt\/server\/DSSettings.txt ]; then\r\n    echo \"Creating default DSSettings.txt\"\r\n    cat << EOF > \/mnt\/server\/DSSettings.txt\r\n    {\r\n        \"SessionName\": \"StarRuptureServer\",\r\n        \"SaveGameInterval\": \"300\",\r\n        \"StartNewGame\": \"false\",\r\n        \"LoadSavedGame\": \"true\",\r\n        \"SaveGameName\": \"AutoSave0.sav\"\r\n    }\r\nEOF\r\nfi\r\n\r\n## create .pteroignore to only back up necessary files\r\nif [ ! -f \/mnt\/server\/.pteroignore ]; then\r\n    echo \"Creating default .pteroignore\"\r\n    cat << EOF > \/mnt\/server\/.pteroignore\r\n    *\r\n    !Password.json\r\n    !PlayerPassword.json\r\n    !DSSettings.txt\r\n    !StarRupture\/Saved\/SaveGames\/*\/AutoSave0.met\r\n    !StarRupture\/Saved\/SaveGames\/*\/AutoSave0.sav\r\n    !StarRupture\/Saved\/SaveGames\/SaveData.dat\r\nEOF\r\nfi\r\n\r\n## Generate password files if passwords are set\r\nif [[ -n \"${ADMIN_PASSWORD}\" ]] || [[ -n \"${PLAYER_PASSWORD}\" ]]; then\r\n    # Only generate if at least one password file is missing\r\n    if [[ ! -f \/mnt\/server\/Password.json ]] || [[ ! -f \/mnt\/server\/PlayerPassword.json ]]; then\r\n        echo \"Generating password files...\"\r\n\r\n        RESPONSE=$(curl -s --request POST \\\r\n            --url https:\/\/starrupture-utilities.com\/passwords\/ \\\r\n            --header 'Content-Type: multipart\/form-data' \\\r\n            --form \"adminpassword=${ADMIN_PASSWORD}\" \\\r\n            --form \"playerpassword=${PLAYER_PASSWORD}\")\r\n\r\n        if [[ -n \"${RESPONSE}\" ]]; then\r\n            # Extract and save admin password if set and file doesn't exist\r\n            if [[ -n \"${ADMIN_PASSWORD}\" ]] && [[ ! -f \/mnt\/server\/Password.json ]]; then\r\n                echo \"${RESPONSE}\" | jq '{password: .adminpassword}' > \/mnt\/server\/Password.json\r\n                echo \"Password.json created successfully\"\r\n            fi\r\n\r\n            # Extract and save player password if set and file doesn't exist\r\n            if [[ -n \"${PLAYER_PASSWORD}\" ]] && [[ ! -f \/mnt\/server\/PlayerPassword.json ]]; then\r\n                echo \"${RESPONSE}\" | jq '{password: .playerpassword}' > \/mnt\/server\/PlayerPassword.json\r\n                echo \"PlayerPassword.json created successfully\"\r\n            fi\r\n        else\r\n            echo \"Warning: Failed to generate password files\"\r\n        fi\r\n    fi\r\nfi\r\n\r\n## install end\r\necho \"-----------------------------------------\"\r\necho \"Installation completed...\"\r\necho \"-----------------------------------------\"",
+            "container": "ghcr.io\/ptero-eggs\/installers:debian",
+            "entrypoint": "bash"
+        }
+    },
+    "variables": [
+        {
+            "name": "[STEAM] SRCDS_APPID",
+            "description": "Steam App ID",
+            "env_variable": "SRCDS_APPID",
+            "default_value": "3809400",
+            "user_viewable": false,
+            "user_editable": false,
+            "rules": "required|numeric",
+            "field_type": "text"
+        },
+        {
+            "name": "[STEAM] Auto Update",
+            "description": "Should Auto Update",
+            "env_variable": "AUTO_UPDATE",
+            "default_value": "1",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|boolean|in:0,1",
+            "field_type": "text"
+        },
+        {
+            "name": "[STEAM] WINDOWS_INSTALL",
+            "description": "",
+            "env_variable": "WINDOWS_INSTALL",
+            "default_value": "1",
+            "user_viewable": false,
+            "user_editable": false,
+            "rules": "required|boolean|in:1",
+            "field_type": "text"
+        },
+        {
+            "name": "[SERVER] Load saved Game",
+            "description": "true \u2192 Loads an existing save; false \u2192 Skips loading saved data",
+            "env_variable": "LOAD_SAVE",
+            "default_value": "true",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|string|in:true,false",
+            "field_type": "text"
+        },
+        {
+            "name": "[SERVER] Save Intervall",
+            "description": "Time between automatic saves (in seconds)\r\n\r\n300 = 5 minutes",
+            "env_variable": "SAVE_INTERVAL",
+            "default_value": "300",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|numeric",
+            "field_type": "text"
+        },
+        {
+            "name": "[SERVER] Savegame Name",
+            "description": "Filename of the save to load; Must exist in the server save directory under `\/StarRupture\/Saved\/SaveGames\/{SESSION_NAME}`",
+            "env_variable": "SAVEGAME_NAME",
+            "default_value": "AutoSave0.sav",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|string",
+            "field_type": "text"
+        },
+        {
+            "name": "[SERVER] Session Name",
+            "description": "Name of the save game session",
+            "env_variable": "SESSION_NAME",
+            "default_value": "StarRuptureServer",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|string",
+            "field_type": "text"
+        },
+        {
+            "name": "[SERVER] Start new Savegame",
+            "description": "Setting this to `true` forces the creation of a new world. Be careful!",
+            "env_variable": "START_NEW",
+            "default_value": "false",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|string|in:true,false",
+            "field_type": "text"
+        },
+        {
+            "name": "[SERVER] Admin Password",
+            "description": "The admin password used for \"Manage Server\"  In-Game",
+            "env_variable": "ADMIN_PASSWORD",
+            "default_value": "",
+            "user_viewable": false,
+            "user_editable": false,
+            "rules": "string|nullable",
+            "field_type": "text"
+        },
+        {
+            "name": "[SERVER] Player Password",
+            "description": "The password used to join the server",
+            "env_variable": "PLAYER_PASSWORD",
+            "default_value": "",
+            "user_viewable": false,
+            "user_editable": false,
+            "rules": "string|nullable",
+            "field_type": "text"
+        }
+    ]
+}