You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: starrupture/README.md
+80-99Lines changed: 80 additions & 99 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,28 +3,19 @@
3
3
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.
4
4
5
5
> ⚠️ **Note:** Server software is still in an experimental phase. Expect some issues in future updates!
This method uses the Pterodactyl Panel and `DSSettings.txt` for all configuration. This is the recommended approach as settings persist across server restarts.
49
+
50
+
> ⚠️ **Important:** Always stop the server before making configuration changes.
51
+
52
+
### Password Setup
45
53
46
54
> ⚠️ **Warning:** Anyone who knows your IP and port can join your server if no password is set!
2. Generate both an Admin password and a Player Password
51
-
3. Create `Password.json` in the root of the container (`/home/container/`) and paste the contents of the site's Password.json field into it
52
-
4. Create `PlayerPassword.json` in the root of the container (`/home/container/`) and paste the contents of the site's PlayerPassword.json field into it
53
-
5. Start server!
54
-
55
-
### Option 2: In-Game Server Management
56
-
1. Start your server (ensure no `DSSettings.txt` file exists).
57
-
2. Open the StarRupture game client.
58
-
3. From the main menu, open **Manage Server** and connect to your server.
59
-
4. When prompted, configure an **Admin Password**.
60
-
5. Click **Change Password** and enter the join password for players.
61
-
6. Press **Back** (or ESC). **Do not** create or load a game at this point.
62
-
7. Stop your server.
63
-
8. Continue with the `DSSettings.txt` configuration below.
64
-
65
-
## Save Game Management
66
-
67
-
There are two ways to manage save games:
68
-
69
-
### Option 1: Manual Configuration (Loading save when server starts.)
70
-
71
-
Create/Edit the `DSSettings.txt` file in the root directory (`/home/container/`) with the following contents:
|`[SERVER] Session Name`|`SessionName`| Name of the save game session (max 20 characters) |
69
+
|`[SERVER] Save Interval`|`SaveGameInterval`| Time between automatic saves in seconds (e.g., `300` = 5 mins) |
70
+
|`[SERVER] Start new Savegame`|`StartNewGame`|`true` to create a new world (use only once!) |
71
+
|`[SERVER] Load saved Game`|`LoadSavedGame`|`true` to load an existing save on startup |
72
+
|`[SERVER] Savegame Name`|`SaveGameName`| Filename of the save to load (e.g., `AutoSave0.sav`) |
73
+
74
+
### Creating a New World
75
+
76
+
> ⚠️ **Important:** Only enable `Start new Savegame` for initial world creation - disable it immediately after!
77
+
78
+
1. Stop the server
79
+
2. Go to the **Startup** tab in the Panel
80
+
3. Set `[SERVER] Load saved Game` to `false`
81
+
4. Set `[SERVER] Start new Savegame` to `true`
82
+
5. Start the server and join to verify it works
83
+
6. Stop the server
84
+
7. Set `[SERVER] Load saved Game` to `true`
85
+
8. Set `[SERVER] Start new Savegame` to `false`
86
+
9. Start the server - it will now load your new world on each restart
87
+
88
+
### Loading an Existing Save
89
+
90
+
1. Stop the server
91
+
2. Go to the **Startup** tab in the Panel
92
+
3. Set `[SERVER] Load saved Game` to `true`
93
+
4. Set `[SERVER] Start new Savegame` to `false`
94
+
5. Set `[SERVER] Savegame Name` to match your save file (e.g., `AutoSave0.sav`)
95
+
6. Set `[SERVER] Session Name` to match your session folder name (e.g., `StarRuptureServer`)
96
+
7. Start the server
92
97
93
98
---
94
99
95
-
## Creating a New World
96
-
97
-
> ⚠️ **Important:** Only set `StartNewGame` to `true` once when creating a new world!
98
-
1. Stop the server.
99
-
2. Update `DSSettings.txt`:
100
-
```json
101
-
"StartNewGame": "true",
102
-
"LoadSavedGame": "false"
103
-
```
104
-
3. Start the server and wait for it to finish loading.
105
-
4. Stop the server.
106
-
5. Revert `DSSettings.txt`:
107
-
```json
108
-
"StartNewGame": "false",
109
-
"LoadSavedGame": "true"
110
-
```
111
-
6. Start the server and join.
100
+
## Method 2: In-Game Configuration
112
101
113
-
---
102
+
This method uses the game's built-in **Manage Server** feature. Only use this method if you have issues with DSSettings.txt.
114
103
115
-
## Loading an Existing Save
104
+
> ⚠️ **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.
0 commit comments