Skip to content

Commit 71a5abf

Browse files
committed
add Don't Starve Together marketplace guide
- New DST game server guide covering Klei cluster token setup, first-launch Steam download wait, auto-generated password handling via Volume Browser, and domain-based connection. - Wire DST into sidebars.ts and the Games README. - Add OpenClaw entry under Marketplace in sidebars.ts. - Ignore CLAUDE.md in .gitignore.
1 parent 8c9ecbc commit 71a5abf

5 files changed

Lines changed: 458 additions & 0 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ npm-debug.log*
1919
yarn-debug.log*
2020
yarn-error.log*
2121

22+
CLAUDE.md

docs/fluxcloud/marketplace/games/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ You can currently deploy and manage the following game servers:
1515
* **Satisfactory**
1616
* **Enshrouded**
1717
* **Palworld**
18+
* **Don't Starve Together**
1819

1920
More titles are coming soon!
2021

Lines changed: 217 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,217 @@
1+
# Don't Starve Together
2+
3+
This guide walks you through the process of **deploying, managing, and connecting to a Don't Starve Together (DST) Game Server** using FluxCloud. Whether you're setting up a new server or maintaining an existing one, this page provides step-by-step instructions and key details for a seamless experience.
4+
5+
For more information on **Don't Starve Together Dedicated Servers** visit: [https://www.klei.com/games/dont-starve-together](https://www.klei.com/games/dont-starve-together)
6+
7+
***
8+
9+
### Before You Begin — Get Your Klei Cluster Token
10+
11+
Don't Starve Together requires a **Klei cluster token** to authenticate your dedicated server with Klei's servers. You'll need this token during deployment, so generate it first:
12+
13+
1. Visit [accounts.klei.com](https://accounts.klei.com) and sign in with the Klei account that owns DST.
14+
2. Go to **Game Servers → Add New Server**.
15+
3. Give your server a name and click **Add New Server**.
16+
4. Click **View** next to the server you just created to reveal the token.
17+
5. Copy the full token string — you'll paste it into the `CLUSTER_TOKEN` field during deployment.
18+
19+
> ⚠️ **Keep your cluster token private.** Anyone with this token can host a server that appears as yours. You can revoke and regenerate tokens anytime from the same Klei page.
20+
21+
***
22+
23+
### How To Install a Don't Starve Together Server
24+
25+
#### **Steps**
26+
27+
1. **Access FluxCloud**
28+
29+
* Visit [cloud.runonflux.com](https://cloud.runonflux.com) and sign in or create an account.
30+
31+
32+
2. **Find the Don't Starve Together Server**
33+
34+
* Navigate to the **Marketplace → Games** tab, then locate the **Don't Starve Together** tile and click **View Details**.
35+
36+
3. **Select Server Configuration**
37+
38+
* Choose your preferred configuration based on expected player count:
39+
* **DST 1.5GB** — good for small groups (up to \~4 players).
40+
* **DST 2GB** — balanced for medium groups (up to \~8 players).
41+
* **DST 4GB** — recommended for larger groups or heavily modded worlds (up to \~16 players).
42+
* Click **Install Now** to continue.
43+
44+
4. **Choose Subscription**
45+
46+
* Select your desired **subscription duration**.
47+
* Agree to the **Terms of Use** and **Privacy Policy**, and click the blue **Continue** arrow at the bottom.
48+
49+
5. **Provide Server Configuration Values**
50+
51+
* During deployment you will be asked to fill in the server parameters:
52+
* **CLUSTER\_TOKEN** *(required)* — paste the Klei cluster token you generated above.
53+
* **CLUSTER\_NAME** *(required)* — the name displayed in the in-game server browser (e.g. `My DST Server`).
54+
* **SHARD\_NAME** *(optional, advanced)* — defaults to `Master`. Leave as is for a single-shard server.
55+
* **MAX\_PLAYERS** *(optional, advanced)* — defaults to `6`. Adjust to fit the plan you chose.
56+
57+
6. **Deployment Location**
58+
59+
* Configure whether you want your DST server to deploy in specific geographic regions:
60+
* **Global (Recommended):** No geographic restrictions for best availability.
61+
* **Custom:** Restrict by continent or country.
62+
* Click the blue **Continue** arrow to proceed.
63+
64+
7. **Email Notifications**
65+
66+
* Optionally enter your email address to receive notifications about your game server, including:
67+
* When your application finishes launching.
68+
* When the primary server changes.
69+
* When your app expiration date is approaching.
70+
71+
8. **Launching the Application**
72+
73+
* Your application must be **signed and registered** on the Flux network.
74+
1. Click **Sign and Register**.
75+
2. Sign the message using the pop-up.
76+
* If you logged in via Google or Email, this step is completed automatically.
77+
78+
9. **Complete Payment**
79+
80+
* Choose your payment method:
81+
* **Fiat:** Stripe or PayPal
82+
* **Crypto:** FLUX coin (5% discount)
83+
* Payment is monitored automatically. Once confirmed, your application will be deployed, and a blue **Manage** button will appear—directing you to your application's management panel.
84+
85+
> ⚠️ **Important: FLUX Payments**
86+
>
87+
> FLUX payments are **only accepted via the FLUX Mainnet,** not through any of our EVM tokens.
88+
>
89+
> We **ALSO** strongly recommend **not sending FLUX payments from exchanges**, as:
90+
>
91+
> * Transactions or withdrawals may not complete within the required 30-minute window.
92+
> * Many exchanges do not support adding a **MEMO**, which is required for proper payment processing.
93+
94+
***
95+
96+
### First Launch — Allow Time for the Server to Download
97+
98+
When your DST server starts for the very first time, the container downloads the full **Don't Starve Together dedicated server files from Steam** via SteamCMD before it can accept connections. This is normal and only happens on first launch (or after a major game update).
99+
100+
* Expect the initial download and world generation to take **several minutes** (typically 5–15 minutes depending on network conditions and node performance).
101+
* During this time the server will **not appear** in the in-game browser and cannot be joined.
102+
* You can follow progress by opening **Applications → Management → Logs** in FluxCloud and watching the container output. Once you see the `Sim paused` / `Starting Master server` / `listening on port` messages, the server is ready.
103+
* Subsequent restarts are much faster — Steam data is cached on the persistent volume.
104+
105+
***
106+
107+
### Finding the IP of Your Game Server
108+
109+
Flux runs on a decentralized network, meaning your application is deployed across **three instances**.\
110+
For game servers, a **Primary/Standby** setup is used — your game runs on the primary instance, while others are on standby for redundancy.
111+
112+
To find your server's **primary IP address**:
113+
114+
1. Visit [**cloud.runonflux.com**](https://cloud.runonflux.com) and log in.
115+
2. Go to **Applications → Management**.
116+
3. Click the **Settings icon** on your Don't Starve Together Server.
117+
4. Open the **Instances** tab.
118+
* The **Primary IP address** is shown here.
119+
* You can also view geolocation details for all instances.
120+
121+
To connect to your server from the DST client:
122+
123+
* Launch **Don't Starve Together** and click **Browse Games**.
124+
* Open the **Servers** tab and search for your `CLUSTER_NAME`, **or** add your server directly by IP:
125+
* Click **Dedicated** / **Add Dedicated Server**.
126+
* Enter your **Primary IP** with port `11000` (e.g. `123.45.67.89:11000`).
127+
* Enter the server password when prompted (see below for how to retrieve or change it).
128+
129+
#### Connecting via Domain Instead of IP
130+
131+
Every FluxCloud Marketplace game server is also reachable through its **application domain**. Flux's load balancer forwards UDP traffic over DNS and is already configured with the correct game port, so you do **not** need to append a port when using the domain — this keeps working even if the primary instance changes due to failover.
132+
133+
* Find your app domain under **Applications → Management → Information**.
134+
* Use it in the DST client in place of the IP, without specifying a port:
135+
136+
```
137+
your-app-domain.app.runonflux.io
138+
```
139+
140+
***
141+
142+
### Managing the Auto-Generated Server Password
143+
144+
The DST server ships with an **auto-generated password** on first launch. This password protects your server from public join attempts. You'll need to retrieve it to share with friends — or change it to something easier to remember.
145+
146+
Both actions happen through the **Volume Browser**:
147+
148+
1. Go to **Applications → Management** on [cloud.runonflux.com](https://cloud.runonflux.com) and select your DST app.
149+
2. Click the **Settings icon**, open the **Secure Shell** tab and scroll to **Volume Browser**.
150+
3. Navigate into the persistent volume and open:
151+
152+
```
153+
/home/dst/dst_server/DoNotStarveTogether/Cluster_1/cluster.ini
154+
```
155+
156+
4. Locate the `[GAMEPLAY]` section and look for the `password =` line. This is the current server password.
157+
5. To change it, click **Edit**, replace the value with your own password, and save.
158+
6. Open the **Control** tab, select **Global**, and click **Restart Application** so the new password takes effect.
159+
160+
> ⚠️ **Important:** Be cautious when modifying values in `cluster.ini`. Incorrect changes may prevent your server from starting. If that happens, restore the file to a working state or redeploy.
161+
162+
***
163+
164+
### Adjusting Other Server Settings
165+
166+
Most gameplay and world options live in two files on the same persistent volume:
167+
168+
* `cluster.ini` — cluster-wide settings: server name, password, max players, PvP, game mode, intention (cooperative / madness / social / competitive).
169+
* `DoNotStarveTogether/Cluster_1/Master/server.ini` — shard-specific settings for the Master shard (port, bind IP, etc.). Most users do **not** need to change this.
170+
171+
Open either file from the **Volume Browser**, edit the values, save, and restart the application from the **Control** tab to apply.
172+
173+
World customisation (season length, resource regrowth, boss presets) is controlled by `worldgenoverride.lua` in the same `Master` folder. Delete the world save (`save/` directory) if you want the next restart to regenerate the world with your new settings.
174+
175+
***
176+
177+
### Frequently Asked Questions
178+
179+
#### Why can't I see my server in the in-game browser right after deployment?
180+
181+
The first launch has to download the dedicated server binaries from Steam and generate the world. This typically takes 5–15 minutes. Watch the container logs from **Applications → Management → Logs** and wait for the `Sim paused` / `listening on port` messages. After that, the server will register with Klei and appear in the browser.
182+
183+
***
184+
185+
#### Where is the server password stored, and how do I change it?
186+
187+
The password is auto-generated into `cluster.ini` under the `[GAMEPLAY]` section on first launch. You can view or change it from **Secure Shell → Volume Browser → `DoNotStarveTogether/Cluster_1/cluster.ini`**. Restart the app from the **Control** tab after saving.
188+
189+
***
190+
191+
#### Do I really need a Klei cluster token? Can I skip it?
192+
193+
Yes, the token is **required**. DST dedicated servers must authenticate with Klei to appear online, display Steam avatars, and allow connections. Generate one for free at [accounts.klei.com](https://accounts.klei.com) under **Game Servers**.
194+
195+
***
196+
197+
#### How can I update my game server to the latest version?
198+
199+
Your DST server automatically checks for updates from Steam during startup. If you'd like to update immediately, open the **Applications → Management** section, select your DST server, go to the **Control** tab, choose **Global**, and click **Restart Application**. This will pull the latest dedicated server files on the next boot.
200+
201+
***
202+
203+
#### What happens if the primary server goes down?
204+
205+
If your current primary server becomes unavailable or experiences downtime, one of the standby instances automatically takes over as the new primary after a short delay. Your world save and configuration are preserved on the persistent volume, so the game resumes where you left off once the switch is complete. You can check which instance is currently the primary from your application's management panel under the **Instances** tab.
206+
207+
***
208+
209+
#### Can I enable the Caves shard?
210+
211+
The default deployment runs a single **Master** shard, which is enough for most groups. Running Caves requires a second shard process and extra ports, which is not part of this template. Advanced users can edit `cluster.ini` to set `shard_enabled = true` and add a second shard manually, but expect to do additional container-level configuration.
212+
213+
***
214+
215+
#### Can I install mods?
216+
217+
Yes. Add your desired Steam Workshop mod IDs to `DoNotStarveTogether/Cluster_1/Master/modoverrides.lua` via the Volume Browser, then restart the app. Mods are downloaded on the next startup — allow extra time on first launch after adding them.

0 commit comments

Comments
 (0)