THE TREASURENAUTS - DEMO FACADE MOD
===================================

A working mod to start from: three facades (brownstone, mediterranean,
shopterrace) and the facades.json that describes them.

Try it:  in the game, Map menu > User Mod > Choose zip file... > this zip.
Make your own:  change the pictures, write their sizes in facades.json, zip
the folder again.

Full guide (pictures, examples, every rule):
  https://www.thetreasurenauts.com/mods/guide.html


WHAT IS IN THE ZIP
------------------
  facades.json                       the mod's settings and the sizes
  facade_<name>_top.png              roof edge + the building's last floor
  facade_<name>_floors.png           whole floors that repeat upwards
  facade_<name>_ground.png           the ground floor
  (.png, .jpg or .webp; all three of a facade the same width)


FACADES.JSON - THE MOD
----------------------
  $schema       optional  help for code editors (hover, completion); the game
                          ignores it
  title         optional  name shown in the game, up to 60 characters
  map           optional  "roadmap" (default) or "satellite"
  roofs         optional  satellite map only: "flat" (default) or "photo"
                          (the satellite photo of the real roof)
  roofColor     optional  satellite map only: flat roof colour, "#rrggbb"
                          (default "#3b3e44")
  floorMetres   optional  metres per floor on the buildings, 2 to 6
                          (default 3.1)
  facades       REQUIRED  list of 1 to 24 facades


FACADES.JSON - EACH FACADE (sizes in pixels of the pictures)
------------------------------------------------------------
  name          REQUIRED  names the pictures: facade_<name>_top.png ...
                          letters, digits, _ and -, up to 40, unique
  w             REQUIRED  width of all three pictures
  top           REQUIRED  height of _top: roof edge + one floor
                          (more than floorRows)
  floors        REQUIRED  height of _floors: floorsInPart x floorRows
  ground        REQUIRED  height of _ground
  floorRows     REQUIRED  height of one floor; sets the scale
                          (floorRows px = floorMetres m)
  floorsInPart  optional  floors in the _floors picture, 1 to 12 (default 3)

Every size is a whole number from 1 to 4096.


LIMITS
------
  zip 25 MB and 400 files - 24 facades - a picture 8 MB and 4096 x 4096 px


CREDITS
-------
The facade pictures are from "Pixel Facades - 100 Building Textures" by
najjar320:  https://najjar320.itch.io/pixel-facades-100-building-textures
If you share a mod made from them, follow that pack's licence and credit it.
