Skip to content

Installation

aristocratos edited this page Sep 27, 2026 · 1 revision

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

You need a Rust dedicated server (Harmony 2.3 is included). A separate copy for generation is best, but any server works while it isn't running.

With the launcher (recommended)

  1. Download CustomGenerator-<version>.zip from Releases and unpack it into any folder, for example on the desktop. This is the mod folder: your config, monuments, maps and previews live here.
  2. Double-click CustomGeneratorLauncher.exe. The config editor opens in your browser.
  3. On the Generate tab set the folder of your Rust server (the one with RustDedicated.exe), pick a size and a seed and press Save & generate.

The launcher copies HarmonyMods/CustomGenerator.dll into the server's HarmonyMods only while a map is generating, runs the server on its own ports with a temporary identity, and removes both afterwards. Nothing else is written to the server. It refuses to generate while a server from that folder is running, or when that server already has CustomGenerator.dll installed by hand.

By hand, without the launcher

Unpack the archive into the server folder, next to RustDedicated.exe, and start the server yourself (see First run). The mod folder is then the server folder. Remove HarmonyMods/CustomGenerator.dll before running that server as a live one. The launcher works from the server folder too: it uses that server and doesn't move the DLL.

Where things are (paths are relative to the mod folder):

Path Contents
CustomGeneratorLauncher.exe Config editor with map generation from the browser
HarmonyMods/CustomGenerator.dll The mod. With the launcher it goes into the server only for the time of a generation
HarmonyConfig/CustomGenerator.json Config
HarmonyConfig/launcher.json Launcher settings: the server folder
HarmonyConfig/CustomGenerator.schema.json Config schema for editor hints (regenerated, don't edit)
HarmonyConfig/CustomGenerator.editor.html Config editor: open it in a browser (regenerated, don't edit)
HarmonyConfig/CustomGenerator.lastrun.json, CustomGenerator.prefabs.json Last run and the prefab names of each group, for the editor (regenerated)
HarmonyConfig/logs/ Mod logs (cgen_*.log) and server logs of launcher runs (launcher_*.log)
maps/ Generated maps (.map) and generation reports (.report.txt)
maps/custom/ Your custom monuments
maps/prefabs/ Your monuments for swapping
mapimages/ Map previews (.png)
mapimages/resources/ Fonts for previews (in the release archive, otherwise downloaded automatically)
live-server/HarmonyMods/CustomGenerator.Server.dll For the live server, not for generation

Clone this wiki locally