midgard/mapcomplete
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Improve docs

Browse source
This commit is contained in:
pietervdvn 2021-02-23 19:43:35 +01:00
parent 7a98bf583b
commit bd7cba420c
1 changed files with 9 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
Customizations/JSON/LayoutConfigJson.ts
View file

@ -2,9 +2,16 @@ import {LayerConfigJson} from "./LayerConfigJson";
import {TagRenderingConfigJson} from "./TagRenderingConfigJson"; import {TagRenderingConfigJson} from "./TagRenderingConfigJson";
/** /**
* Defines what a JSON-segment defining a layout should look like. * Defines the entire theme.
*
* A theme is the collection of the layers that are shown; the intro text, the icon, ...
* It more or less defines the entire experience.
*
* Most of the fields defined here are metadata about the theme, such as its name, description, supported languages, default starting location, ...
*
* The main chunk of the json will however be the 'layers'-array, where the details of your layers are.
* *
* General remark: a type (string | any) indicates either a fixed or a translatable string * General remark: a type (string | any) indicates either a fixed or a translatable string.
*/ */
export interface LayoutConfigJson { export interface LayoutConfigJson {
/** /**