Custom Generation 1.1.2

1. Add a prefab container together with its layers to the required category.
2. Start the server. A separate configuration file will be created for the container.
3. Stop the server and configure its placement.
4. On the next wipe, start the server normally. No additional action is required.

All generation changes are applied only when a new map is created during a wipe. Reloading the plugin or restarting the server does not modify an existing map. A new wipe is required for changes to placement, terrain, WorldConfig or generation components to take effect.

If you plan to use the full feature set, it is strongly recommended to configure and verify the map on a separate test server first. Placement, terrain and component settings may require several test wipes to get right.

Be aware that Facepunch may ban the server IP address for frequent wipes. Use a local server for testing or be prepared for this risk.

Custom structures are added to /data/FCustomGeneration/CustomMonuments/. Place the .prefab file and the layers saved with it in the appropriate folder:

The category provides the initial configuration values. After the file is created, the placement type and all other parameters can be changed manually. Other folders directly inside CustomMonuments are also read, but they do not receive a special preset. For example, a Rail folder is used only for organisation and receives the regular ground settings. Folders nested inside them are not read.

The /data/FCustomGeneration/Monuments/ folder accepts .map files used to extend standard monuments. The .map filename must match the root prefab name of the standard monument. That prefab must also be present inside the map: the plugin uses it as the origin, rotation and scale reference, then copies the remaining objects and paths onto every instance created by the server.

This method does not create a new monument and has no separate placement configuration. It modifies the matching standard monument while the map is being created. A wipe is required for changes to appear.

A prefab container does not have to be a full monument. It can contain a small shed with a recycler and a few crates, a single object, flat terrain or a prepared building area, an island, a group of structures or an entire city.

The world size count multiplier contains a list of points:

The multiplier is interpolated linearly between points. Outside the defined range, the nearest end point is used.

Distance mode is configured separately for the same prefab and for other prefabs. Both fields accept these values:

Larger counts, structure bounds, spacing values and filter sets reduce the chance that every requested copy can be placed.

The meaning of -1 and 0 depends on the field:

Do not use 0 for Splat layers, Biomes or Topology any. The server reports that mask as invalid. In the current version it effectively applies no restriction, but -1 is the supported value for "any". An empty string in All topologies or Topology not has the same effect as 0.

For a large structure, do not check only its centre. Increase the topology radius and leave enough clearance from forbidden areas. A wide radius combined with a long exclusion list can remove almost every available position.

Search area mode accepts one of three values:

Additional settings:

For an offshore structure outside the playable island, OutsideTerrain usually needs a minimum outward distance and a maximum distance limit. Without an upper limit, the structure may be placed far from the island.

For ExtendedTerrain and OutsideTerrain, set Extra bounds or a positive maximum distance outside terrain. If both are 0, the search area does not extend beyond the map and OutsideTerrain cannot find a position. When terrain filters outside the map are disabled, splat, biome, topology and the placement map are skipped there; height, water, terrain difference and monument distances are still checked.

Roadside requires a correctly prepared road or trail inside the container. The first such path is used for alignment; rail paths are skipped. Direction and height come from the selected server road segment, so height mode, random yaw and a fixed map point do not apply to Roadside.

For Ground placement outside the main map, Auto uses ocean level instead of terrain height.

Height offset is applied after the base height is calculated. A positive value raises the structure and a negative value lowers it.

Terrain height sample mode accepts one of four values:

Terrain height sample radius multiplier changes the sampled area. A value of 1 uses the regular structure bounds. A value that is too large may include a nearby slope.

Max terrain height difference rejects uneven areas. A small value produces flatter placement but reduces the number of available positions. A larger value makes placement easier but increases the chance that an edge will be above ground or inside a slope.

The maximum terrain difference check applies only to Ground placement. When terrain layers are disabled, a height layer stored in the container is not used for height selection or terrain difference checks.

Minimum water depth rejects shallow water. Maximum water depth prevents placement in excessively deep water. A value of 0 disables the upper limit.

Require nearby ocean coastline keeps positions with a centre at least 1 m above ocean level when terrain in one of 16 directions at the Coastline check radius is more than 2 m below ocean level. A radius below 10 is treated as 10.

The full structure area is checked, so a large platform or island needs sufficient depth at its edges as well.

When Apply terrain layers is enabled, the container supplies:

• terrain shape;
• surface textures;
• terrain transparency;
• biome data;
• topology data.

Smoothing joins the new terrain to the map:

Increase the outside distance to correct a sharp edge. If the centre is being deformed, reduce the inside distance and smoothing strength.

If a container or shop uses a custom RustEdit preset, copy the preset file into the plugin folder:

For loot containers, the plugin uses the preset item list, minimum and maximum item count, blueprint chance and refresh time. NPC vending machines receive the sell orders from the vending preset.

Loaded presets are stored inside the generated map file. The map can then be moved to another server without separate .lprof and .vprof files, but FCustomGeneration must be installed. The version embedded in the map takes priority. Generate the map again after changing a preset, otherwise the map will continue using the older embedded version.

The map also stores entities added by the plugin, building blocks, IO connections and the required topology data. FCustomGeneration restores them on the destination server.

The plugin transfers every path from the prefab container. A single structure can contain multiple roads, trails and railway paths at the same time.

The connection type is selected automatically: Rail for a path with railway topology, Trail for a path whose name starts with Trail, and Road for other paths. Every detected path receives its own entry in the custom structure configuration, where the first and last ends can be enabled independently. A road and a railway path inside the same prefab container can therefore use different settings.

When the configuration is first created, it uses the values stored in the prefab container. If RustEdit saved both ends of a railway path as disabled, enable the required ends in the configuration and wipe the server so the railway generator can use the structure on the new map.

The path direction inside the container determines which side connects to the external path. Roadside placement also requires enough free road length and no nearby intersection.

Use map point enables a fixed map region. When disabled, the plugin searches the complete selected search area.

The map is divided into nine regions from left to right: 1-3 are at the top, 4-6 in the middle and 7-9 at the bottom. 5 is the centre. Map point offset X and Map point offset Z move the position within the selected region.

Water depth, terrain, topology and distance rules are still checked. If the selected point does not satisfy them, the plugin searches for another valid position.

With a map point enabled, no more than one copy is created regardless of Target count. The fixed Yaw value is used; Random yaw does not apply in this mode.

• Yaw sets a fixed rotation.
• Random yaw selects the angle automatically. It is normally disabled for roads, entrances and bridges.
• Scale changes the model size, bounds, paths, check radius and required free area.
• Create Monument topology marks the occupied area as a monument.
• Clear topologies after spawn removes selected topology types inside the structure area.
• Map marker text creates a map label. An empty value disables it.

After increasing the scale, you may also need more spacing from other objects, the map boundary and the shore.

Replacement count is determined by the number of matching standard monuments and the replacement chance. Target count, attempts, filters, distances and map point are not used for replacement. Minimum world size still applies. Height offset, scale, layers, paths, topology and the map marker are applied to every completed replacement.

Use a sufficiently specific part of the original path. A short generic match can affect several different objects. Keeping both the original and custom structures is suitable only for an overlay prepared for that monument.

This section raises and smooths the seabed within the selected depth range.

A wider depth range and smoothing radius produce a larger shallow-water area and a more visible change to the shore.

This processing runs immediately after height generation and before roads, rivers and monuments are placed.

Values of 1 for size, width and steepness do not change the result. Strong land expansion leaves less room for offshore monuments, while shrinking the land reduces the area available to land monuments and roads.

Rotations use regular degrees. Each direction has its own switch. When disabled, the server derives the angle from the seed. When enabled, 0, 90, 180 and 270 represent quarter turns of the map; intermediate values are also valid.

Biome rotation changes the direction of Arid, Temperate, Tundra, Arctic and Jungle. Tier rotation changes the direction of Tier 0, Tier 1 and Tier 2 areas. Their proportions are still controlled through WorldConfig.

Use precise entries in the prefab blacklist. A generic word may remove several unrelated groups of decoration.

This blacklist operates independently from WorldConfig. Inside WorldConfig, its blacklist is checked before its whitelist. A whitelist entry does not restore an object that has already been blocked by the blacklist.

Each map-point prefab entry contains:

A larger map requires more memory and more generation time. When road building is enabled, players can block traffic. A long monument priority list leaves less space for other objects.

When RustEdit storage is disabled, this data remains in FCustomGeneration's internal map layers. This is fully self-contained on the server, but RustEdit removes those layers when the map is saved.

Use WorldConfig replaces the standard world settings with values from this section.

Tier 0 to Tier 2 values are normalised against their total. Arid, Temperate, Tundra and Arctic are normalised in the same way; Jungle is handled separately. Setting all four main biome values to zero produces a fully temperate distribution. A very small biome share reduces the available space for monuments restricted to that biome.

The list comes from the current server build and is written to the configuration when the server starts. The section may be empty before the first start. Once the list appears, stop the server, change the required values and create a new map on the next wipe. These changes are not applied to an existing map.

Component names are not translated in the configuration. Use the exact English name.

If an entry only contains Enabled, that component can only be enabled or disabled. Apply values and Values only appear for components with available parameters. Components without Values are therefore not listed separately in this guide.

PlaceMonuments components commonly expose:

TargetCount does not create multiple copies of the same standard prefab. If a set contains three eligible variants, a value of 1000 still places no more than three. This applies to sets such as Desert Military (PlaceMonuments), Fishing Villages (PlaceMonuments), Oasis (PlaceMonuments), Lakes (PlaceMonuments), Caves (PlaceMonuments) and Underwater Labs (PlaceMonuments).

For PlaceMonuments, TargetCount 0 means no overall limit; it does not disable the component. Use Enabled to disable it. This differs from Target count in a custom monument configuration, where 0 prevents the structure from being created.

Main Monuments (PlaceMonuments) is a set of different main monuments. Increasing TargetCount above the number of available prefabs adds nothing, while lowering it limits how many different monuments can be selected from the set. The final count also depends on world size, each prefab's minimum world size, filters and available space.

Road, trail, river and rail components expose length and count limits. A MaxPathCount below 0 keeps the standard number of paths, 0 removes all paths and a positive value sets the maximum. MaxPathSelection accepts First, Last, Random, Longest, Shortest, Nearest or Farthest and decides which paths remain when the count is limited. Random selection is derived from the seed and is repeatable with the same map settings.

Road Ring and Rail Ring contain RingRadiusMultiplier. A value of 1 keeps the standard radius, values below 1 move the ring towards the centre, and values above 1 move it towards the map edge.

River Layout additionally contains:

The server handles separate jungle rivers outside the regular limit. To remove every river, disable River Layout or the Rivers field in WorldConfig.

Terrain Erosion contains:

A lower Iterations value makes this stage faster and reduces terrain modification. Higher values increase Processing World time. Values are only used when Apply values is enabled.

A minimum value must not exceed its matching maximum; the plugin raises the maximum to the minimum automatically.

Tunnels (GenerateDungeonGrid) can only be enabled or disabled. Internal grid and link dimensions are not exposed because the standard subway segments are built for fixed geometry.

Tunnel Entrances (PlaceMonuments) controls placement of the available entrance variants. TargetCount can reduce the number of variants used, while distance and filter settings change where they may be placed. Increasing TargetCount does not create additional copies of one entrance.

Underwater Labs (GenerateDungeonBase) exposes segment count, budget and floor limits for the initial section, start extension, end extension and open-socket filling stages.

Only change fields added by the plugin to the Values section of that component. Disabling an early stage affects later stages. Without the road topology pass there is no road texture, road mesh or roadside decoration. Without a river there is nothing for later river stages to process.

This experimental section changes the shape of the procedural map. When it is disabled, the server uses standard terrain generation.

Thresholds and transition widths belong to different terrain layers, not a single sequence of heights. Frequency changes feature size; amplitude changes the strength of a layer. More octaves add detail and increase processing time. Changes take effect on a new wipe after a full server startup; an existing map remains unchanged.

Check the following in order:

1. The structure is enabled, target count is above zero, and world size is not below the configured minimum.
2. Biome, surface and topology settings do not conflict.
3. Distance values and check radius are not excessive.
4. The permitted terrain height difference is not too small.
5. Water is deep enough across the complete structure area.
6. Search area matches the selected placement type.
7. Attempts per structure is sufficient for the selected restrictions.