Skip to content

Commit

Permalink
Merge pull request #77466 from Milopetilo/mapgen-md
Browse files Browse the repository at this point in the history
Add recommended palettes to MAPGEN.md
  • Loading branch information
Maleclypse authored Oct 31, 2024
2 parents c19a1e8 + fcde404 commit defe926
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions doc/MAPGEN.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
* [Pre-load a base mapgen with "predecessor_mapgen"](#pre-load-a-base-mapgen-with-predecessor_mapgen)
* [Palettes](#palettes)
* [Palette ids as mapgen values](#palette-ids-as-mapgen-values)
* [Recommended palettes to use](#recommended-palettes-to-use)
* [Using update_mapgen](#using-update_mapgen)
* [Overmap tile specification](#overmap-tile-specification)
* ["assign_mission_target"](#assign_mission_target)
Expand Down Expand Up @@ -1482,6 +1483,32 @@ For example, the following JSON used in a cabin mapgen definition
causes half the cabins generated to use the regular `cabin_palette` and the
other half to use `cabin_palette_abandoned`.

## Recommended palettes to use

These are a few palettes that have been generalized to be used in almost any map, usually to provide variation to terrain:

| Palette | Usage
| --- | ---
| `parametrized_walls_palette` | For having randomized inner and outer walls
| `parametrized_fences_palette` | For having randomized fences
| `parametrized_linoleum_palette` | For having randomized linoleum colors
| `parametrized_carpets_palette` | For having randomized carpet colors


These can all be found within [common_parameters.json](/data/json/mapgen_palettes/common_parameters.json)

The following are recommended for use when making houses or similar domestic environments:

| Palette | Usage
| --- | ---
| [`domestic_general_and_variant_palette`](/data/json/mapgen_palettes/house_general_palette.json) | A palette which has most of the things needed for houses with additional palettes available within the file
| [`construction_general_palette`](/data/json/mapgen_palettes/construction.json) | A palette for buildings that are under construction, for a more concrete example of using this palette, look at [house_02](/data/json/mapgen/house/house02.json)
| [`commercial`](/data/json/mapgen_palettes/commercial.json) | For having randomized fridges/freezers **You will still need to add the parameters to your own symbols**
| Any in [basement.json](/data/json/mapgen_palettes/basement.json) | Palettes for usage within basements
| [`roof_palette`](/data/json/mapgen_palettes/roof_palette.json) | Palette that is be used in every roof

There are many more within [`/data/json/mapgen_palettes`](/data/json/mapgen_palettes/) but these are the most important ones and will be used in many buildings.

# Using `update_mapgen`

**update_mapgen** is a variant of normal JSON mapgen. Instead of creating a new overmap tile, it
Expand Down

0 comments on commit defe926

Please sign in to comment.