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
docs: Add documentation for PRESET environment variable (#572)
- Add PRESET to the environment variables table
- Include detailed explanation of available preset values
- Add example showing how to use PRESET when generating a new map
- Document that PRESET is optional and only used with GENERATE_NEW_SAVE=true
Fixes#571
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-authored-by: Claude <[email protected]>
Copy file name to clipboardExpand all lines: README.md
+31Lines changed: 31 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -203,6 +203,22 @@ sudo docker run -d \
203
203
factoriotools/factorio
204
204
```
205
205
206
+
To generate a new map with a specific preset (e.g., death-world):
207
+
208
+
```shell
209
+
sudo docker run -d \
210
+
-p 34197:34197/udp \
211
+
-p 27015:27015/tcp \
212
+
-v /opt/factorio:/factorio \
213
+
-e LOAD_LATEST_SAVE=false \
214
+
-e GENERATE_NEW_SAVE=true \
215
+
-e SAVE_NAME=replaceme \
216
+
-e PRESET=death-world \
217
+
--name factorio \
218
+
--restart=unless-stopped \
219
+
factoriotools/factorio
220
+
```
221
+
206
222
### Mods
207
223
208
224
Copy mods into the mods folder and restart the server.
@@ -321,6 +337,7 @@ These are the environment variables which can be specified at container run time
321
337
| BIND | IP address (v4 or v6) the server listens on (IP\[:PORT]) | | 0.15+ |
322
338
| RCON_PORT | TCP port the rcon server listens on | 27015 | 0.15+ |
323
339
| SAVE_NAME | Name to use for the save file | _autosave1 | 0.17+ |
340
+
| PRESET | Map generation preset when GENERATE_NEW_SAVE is true | | 0.17+ |
324
341
| TOKEN | factorio.com token | | 0.17+ |
325
342
| UPDATE_MODS_ON_START | If mods should be updated before starting the server | | 0.17+ |
326
343
| USERNAME | factorio.com username | | 0.17+ |
@@ -330,6 +347,20 @@ These are the environment variables which can be specified at container run time
330
347
331
348
**Note:** All environment variables are compared as strings
332
349
350
+
#### PRESET Values
351
+
352
+
The `PRESET` environment variable is used when generating a new map (when `GENERATE_NEW_SAVE=true`). It corresponds to Factorio's built-in map generation presets. Common values include:
353
+
354
+
- `default`- Normal settings
355
+
- `rich-resources`- Resources are more abundant
356
+
- `marathon`- Recipes and technologies are more expensive
357
+
- `death-world`- Biters are more aggressive and numerous
358
+
- `death-world-marathon`- Combines death-world and marathon settings
359
+
- `rail-world`- Resources are further apart, encouraging train usage
360
+
- `ribbon-world`- Map height is limited for a unique challenge
361
+
362
+
If PRESET is not specified or left empty, the map will be generated using the settings from `map-gen-settings.json` and `map-settings.json` without a preset.
363
+
333
364
## Container Details
334
365
335
366
The philosophy is to [keep it simple](http://wiki.c2.com/?KeepItSimple).
0 commit comments