Config basics

🇷🇺 Русская версия

Language

The first field of the config:

"Language (en/ru)": "en"

A new config uses your system language. Keys are accepted in both languages: change the value to en or ru, restart the server, and the file is rewritten with keys in the selected language. All values are kept.

This guide uses English keys, with the Russian key in parentheses where it helps.

Config editor

The easiest way to change settings and generate maps. There are two ways to open it:

• With the launcher (recommended): double-click CustomGeneratorLauncher.exe in the mod folder (see Installation). It opens the editor in your browser at http://127.0.0.1:28190/ and can generate maps right from the page. Keep its window open while you work.
• As a file: on every run the mod writes HarmonyConfig/CustomGenerator.editor.html. Double-click it to edit the config offline, without generation.

What's inside:

• Generate (launcher only): pick sizes and seeds (🎲 for a random one, several maps in a queue), press Save & generate and watch the live log and the current generation step. Stop kills the run and clears the queue. Each map is a separate server run with its own ports (28915+), so a live server on the same machine doesn't clash. Opened as a file, this tab shows the commands to run by hand.
• Last run: the map preview, size, seed, time, warnings, how many monuments of each group were placed, custom monuments, swap results and the full report.
• Settings sections with descriptions and allowed values: toggles, biomes and topologies as chips, search in the monument list. A dot marks values changed from the default, ↺ puts the default back. Invalid values are marked red and can't be saved.
• Real names instead of typing blind: a monument group shows the prefab names the game actually has for it (after the group has been generated once) as chips for IncludePrefabs / ExcludePrefabs, and PrefabCopies as − N + steppers. File of a custom monument suggests the files of the folder, and the folder's files that aren't in the list yet can be added in one click. The swap section lists maps/prefabs and tells whether each file matches a game prefab.
• Tier and biome bars: drag the dividers, the sum stays 100.
• ✦ Presets: ready-made recipes (no rivers with rings, more snow, 5 harbors, no lighthouses, clean roads…). Each shows exactly what it changes before you apply it.
• Save (Ctrl+S): through the launcher straight to HarmonyConfig/CustomGenerator.json (the previous one is kept as .bak). As a file, in Chrome and Edge to the file you pick, in other browsers as a download.

Don't save while a map is generating: the mod rewrites the config when it starts. The launcher blocks saving while it's generating. The file version shows the values from the last run; if you edited the config by hand since then, press Open… and pick it.

The launcher listens only on 127.0.0.1 and accepts requests only from its own page. Options: --port <n> (default 28190), --server <folder> to set the Rust server folder, --root <folder> to use another mod folder, --no-browser.

Editor hints

Next to the config the mod writes CustomGenerator.schema.json, and the config's first line links to it ("$schema"). Open the config in VS Code (or another editor with JSON Schema support) and you get:

• a description of every option on hover, in the config's language;
• autocompletion of keys and allowed values (biomes, textures, topologies, HeightMode, distanceSame, etc.);
• underlined mistakes: a misspelled biome, a negative distance, text instead of a number.

The schema is rewritten on every run, so it always matches your mod version. Don't edit it and don't remove the "$schema" line.

Version and updates

Don't edit the "Version" field. When you update the mod:

• the old config is copied to CustomGenerator.json.<old version>.backup;
• new options are added with default values, your values are kept.

When the config has an error

• Broken JSON (extra comma, missing bracket): the file is saved as CustomGenerator.json.broken-<date> and the mod starts with the default config. Fix the copy and put it back.
• Invalid value (negative percentage, unknown biome in a filter, etc.): a [WARN] line explaining the problem goes to the log, and the value is replaced with a safe one for this run only. The file isn't changed. Always check the warnings in HarmonyConfig/logs after a run.

The mod reads and re-saves the config on every run, so the file formatting may change. That's expected.