Skip to content
Open
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,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)
Expand Down
131 changes: 131 additions & 0 deletions starrupture/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
# 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

StarRupture requires 1 port:

| Port | Default |
|------|---------|
| Game | 7777 |

This can be changed to any port.

## System Requirements

| Type | Memory | Storage |
|-------------|--------|---------|
| Bare Minimal| 4 GB | 25 GB |
| Recommended | 12~16+ GB | 40 GB+ |

---

## Configuration

### Password Protection

> ⚠️ **Warning:** Anyone who knows your IP and port can join your server if no password is set!
### Option 1: In-Game Server Management
1. Start your server (ensure no `DSSettings.txt` file exists).
2. Open the StarRupture game client.
3. From the main menu, open **Manage Server** and connect to your server.
4. When prompted, configure an **Admin Password**.
5. Click **Change Password** and enter the join password for players.
6. Press **Back** (or ESC). **Do not** create or load a game at this point.
7. Stop your server.
8. Continue with the `DSSettings.txt` configuration below.


### Option 2: Manual way
1. Visit https://starrupture-utilities.com/passwords
2. Generate both an Admin password and a Player Password
3. Create `Password.json` in root of the container (`/home/container/`) and paste the contents of the site's password.json field into it
4. Create `PlayerPassword.json` in root of the container (`/home/container/`) and paste the contents of the site's playerpassword.json field into it
5. Start server or following Save Game Management below.

---

## Save Game Management

There are two ways to manage save games:

### Option 1: In-Game Server Management

1. From the main menu, click **Manage Server**.
2. Enter your server IP and port to connect.
3. From here, you can create a new world or load an existing save.

### Option 2: Manual Configuration (Loading save when server starts.)

Create a `DSSettings.txt` file in the root directory (`/home/container/`) with the following content:

```json
{
"SessionName": "MySaveGame",
"SaveGameInterval": "300",
"StartNewGame": "false",
"LoadSavedGame": "true",
"SaveGameName": "AutoSave0.sav"
}
```

---

## Configuration Options

| Option | Description |
|------------------|-----------------------------------------------------------------------------|
| `SessionName` | Name of the save game session. Maximum 20 characters. |
| `SaveGameInterval` | Time between automatic saves in seconds (e.g., `300` = 5 minutes). |
| `StartNewGame` | `true` to create a new world, `false` to prevent new save creation. |
| `LoadSavedGame` | `true` to load an existing save, `false` to skip loading saved data. |
| `SaveGameName` | Filename of the save to load (e.g., `AutoSave0.sav`). |

---

## Creating a New World

> ⚠️ **Important:** Only set `StartNewGame` to `true` once when creating a new world!
1. Stop the server.
2. Update `DSSettings.txt`:
```json
"StartNewGame": "true",
"LoadSavedGame": "false"
```
3. Start the server and wait for it to finish loading.
4. Stop the server.
5. Revert `DSSettings.txt`:
```json
"StartNewGame": "false",
"LoadSavedGame": "true"
```
6. Start the server and join.

---

## Loading an Existing Save

1. Stop the server.
2. Ensure `DSSettings.txt` contains:
```json
"StartNewGame": "false",
"LoadSavedGame": "true",
"SaveGameName": "AutoSave0.sav"
```
3. Upload your `.sav` and `.met` files to:
```
/home/container/StarRupture/Saved/SaveGames
```
4. Rename the files to `AutoSave0.sav` and `AutoSave0.met`.
5. Start the server and join.


142 changes: 142 additions & 0 deletions starrupture/egg-star-rupture.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
{
"_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO",
"meta": {
"version": "PTDL_v2",
"update_url": null
},
"exported_at": "2026-01-08T15:36:50+01: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": {
"Wine Latest": "ghcr.io\/ptero-eggs\/yolks:wine_latest"
},
"file_denylist": [],
"startup": "cd \/home\/container\/StarRupture\/Binaries\/Win64; wine .\/StarRuptureServerEOS-Win64-Shipping.exe -Log -Port=${SERVER_PORT} & SR_PID=$!; tail -c0 -F \/home\/container\/StarRupture\/Saved\/Logs\/StarRupture.log --pid=$SR_PID | grep -v -E \"LogCore: Warning|LogUObjectBase: Error\"",
"config": {
"files": "{}",
"startup": "{\r\n \"done\": \"OnUpdateSessionComplete\"\r\n}",
"logs": "{}",
"stop": "^C"
},
"scripts": {
"installation": {
"script": "#!\/bin\/bash\r\n# steamcmd Base Installation Script\r\n\r\n\r\n## just in case someone removed the defaults.\r\nif [ \"${STEAM_USER}\" == \"\" ]; 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\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\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#Custom Commands\r\n\r\n\r\necho \"-----------------------------------------\"\r\necho \"Installation completed...\"\r\necho \"-----------------------------------------\"",
"container": "ghcr.io\/ptero-eggs\/installers:debian",
"entrypoint": "bash"
}
},
"variables": [
{
"name": "[STEAM] Steam User",
"description": "This is a required setting and cannot be set to anonymous.",
"env_variable": "STEAM_USER",
"default_value": "",
"user_viewable": false,
"user_editable": false,
"rules": "nullable|string",
"field_type": "text"
},
{
"name": "[STEAM] Steam Password",
"description": "Steam User Password",
"env_variable": "STEAM_PASS",
"default_value": "",
"user_viewable": false,
"user_editable": false,
"rules": "nullable|string",
"field_type": "text"
},
{
"name": "[STEAM] Game ID",
"description": "The ID corresponding to the game to download and run using SRCDS",
"env_variable": "SRCDS_APPID",
"default_value": "3809400",
"user_viewable": false,
"user_editable": false,
"rules": "string",
"field_type": "text"
},
{
"name": "[STEAM] Steam Auth",
"description": "Steam account auth code. Required if you have 2fa enabled",
"env_variable": "STEAM_AUTH",
"default_value": "",
"user_viewable": false,
"user_editable": false,
"rules": "nullable|string|max:5",
"field_type": "text"
},
{
"name": "[STEAM] WINDOWS_INSTALL",
"description": "",
"env_variable": "WINDOWS_INSTALL",
"default_value": "1",
"user_viewable": false,
"user_editable": false,
"rules": "required|string|in:1",
"field_type": "text"
},
{
"name": "[STEAM] Auto Update Server",
"description": "This is to auto-update the game server",
"env_variable": "AUTO_UPDATE",
"default_value": "1",
"user_viewable": true,
"user_editable": true,
"rules": "required|boolean",
"field_type": "text"
},
{
"name": "[SYSTEM] Winetricks",
"description": "",
"env_variable": "WINETRICKS_RUN",
"default_value": "vcrun2022",
"user_viewable": false,
"user_editable": false,
"rules": "required|string|max:20",
"field_type": "text"
},
{
"name": "[SYSTEM] Wine Debug",
"description": "",
"env_variable": "WINEDEBUG",
"default_value": "-all",
"user_viewable": false,
"user_editable": false,
"rules": "required|string|max:20",
"field_type": "text"
},
{
"name": "[SYSTEM] WINEARCH",
"description": "",
"env_variable": "WINEARCH",
"default_value": "win64",
"user_viewable": false,
"user_editable": false,
"rules": "required|string|max:20",
"field_type": "text"
},
{
"name": "[SYSTEM] WINEPREFIX",
"description": "Wine root directory for the container",
"env_variable": "WINEPREFIX",
"default_value": "\/home\/container\/.wine",
"user_viewable": false,
"user_editable": false,
"rules": "required|string|max:100",
"field_type": "text"
},
{
"name": "[SYSTEM] WINEDLLOVERRIDES",
"description": "",
"env_variable": "WINEDLLOVERRIDES",
"default_value": "mscoree,mshtml=",
"user_viewable": false,
"user_editable": false,
"rules": "required|string|max:20",
"field_type": "text"
}
]
}