Skip to content

Commit b5a6843

Browse files
committed
Document region settings changes
1 parent 26795db commit b5a6843

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

doc/JSON/REGION_SETTINGS.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@ see their info later in this document.
1616
| `type` | | Type identifier. Must be "region_settings". |
1717
| `id` | | Unique identifier for this region. |
1818
| `tags` | array of string | An arbitrary list of tags for overlays to apply to. |
19+
| `place_swamps` | boolean | Controls whether or not swamps will be placed (requires forests to be placed) |
20+
| `place_roads` | boolean | Whether or not to generate road connections |
21+
| `place_railroads` | boolean | Whether or not to generate railroad connections |
22+
| `place_railroads_before_roads` | boolean | Generates railroads before roads if true |
23+
| `place_specials` | boolean | Controls placement of overmap specials |
24+
| `neighbor_connections` | boolean | Generate connections between neighboring overmaps |
25+
| `max_urbanity` | integer | Max urbanity (a multiplier on city size) |
26+
| `urbanity_increase` | array of numbers | Increase in urbanity to the [ north, east, south, west ] of overmap (0,0) |
1927
| `rivers` | `region_settings_river` | River generation parameters; Use `null` to disable river generation. |
2028
| `lakes` | `region_settings_lake` | Defines parameters for generating lakes in the region. `null` to disable. |
2129
| `ocean` | `region_settings_ocean` | Defines parameters for generating oceans in the region. `null` to disable. |
@@ -260,6 +268,8 @@ on the overmap. The actual placement of these features is determined globally ac
260268
so that the edges of the features align, and these parameters are mostly about how those global
261269
features are interpreted.
262270

271+
Two noise functions with values between 0 and 1 are generated over the entire map. The noise threshold values control which values from the noise function correspond to what terrain.
272+
263273
### Fields
264274

265275
| Identifier | Description |
@@ -270,6 +280,8 @@ features are interpreted.
270280
| `noise_threshold_swamp_isolated` | [0, 1], x > value spawns `forest_water` if forest isolated from water. |
271281
| `river_floodplain_buffer_distance_min` | Minimum buffer distance in overmap terrains for river floodplains. |
272282
| `river_floodplain_buffer_distance_max` | Maximum buffer distance in overmap terrains for river floodplains. |
283+
| `forest_threshold_limit` | Number. Maximum increase in forest threshold value due to distance from overmap (0,0) |
284+
| `forest_threshold_increase` | Array of numbers. [ north, east, south, west ] change in forest noise threshold per overmap from overmap (0,0) |
273285

274286
### Example
275287

0 commit comments

Comments
 (0)