Settlement Layouts

This layout is aimed at documenting cities, towns, metropoleis and other settlements, as well as their structures of power, shops and houses.

This layout has two columns:

The left column contains the first-level header, author name, date, contents and, below these, a list of both shops and/or houses, where available.
The right column contains the settlement metadata, which, as the shops and houses, are defined in the front matter.

Settlement Metadata

These are the metadata shown on the right column of the layout.

Metadata	Type	Description
`name`	`string`	The name of the settlement
`type`	`string`	The type of settlement
`size`	`string`	The size (area) of the settlement, with unit
`demographics`	`array` of `object`s	An array of objects, each of which defines a fraction of the population
`race.race`	`string`	The race of this fraction
`race.percent`	`integer`	How much of the population is this fractions (without `%`)
`population`	`integer`	Total number of people on this settlement
`gp-limit`	`integer`	The maximum price any single item may cost
`wealth`	`integer`	The total wealth of the settlement
`centres`	`array` of `object`s	An array of objects, each of which defines a single center of power.
`centre.type`	`string`	The type of power structure
`centre.name`	`string`	The name of the power structure
`centre.align`	`string`	The alignment of the power structure
`authorities`	`array` of `object`s	An array of objects, each of which defines one authority figure of the settlement
`authority.class`	`string`	The class of the authority, or the 5E template
`authority.level`	`integer`	The level of the authority
`authority.title`	`string`	The title the authority holds
`authority.name`	`string`	The name of the authority

This variable is an array of objects, each of which is explained below.

Defining any shops is optional, but should you define them, most variables are required, see below.

Metadata	Type	Description
`type`	`string`	The type of shop
`name`	`string`	The name of the shop
`owner`	`object`	An object defining the owner of the shop
`owner.name`	`string`	The name of the owner
`owner.gender`	`string`	The gender of the owner
`owner.race`	`string`	The race of the owner
`owner.class`	`string`	The class of the owner
`owner.level`	`integer`	The level of the owner
`prices`	`object`	An object defining the price rates of the shop
`prices.sell`	`integer` or `boolean`	The price percentage (without the `%`) of selled goods, or `false` if don’t sell
`prices.buy`	`integer` or `boolean`	The price percentage (without the `%`) of buyed goods, of `false` if don’t buy
`location`	`string`	The location of the shop
`desc`	`string`	The description of the shop
`goods`	`object`	An object defining the type and list of selled goods
`goods.name`	`string`	The name of the selled goods (e.g. `Potions` or `Weapons`)
`goods.list`	`array` of `object`s	As array of objects, each of which is a single selling item
`goods.item.name`	`string`	The name of the item
`goods.item.cost`	`string`	The price of the item (with currency, e.g. `8 cp`)

This variable is also an array of objects, each of which is explained below.

Defining any houses is optional, but should you define them, most variables are required, see below.

Metadata	Type	Description
`type`	`string`	The type of house (e.g. `Tiny Cottage`)
`name`	`string`	If appliable, the unique name of the house
`location`	`string`	The location of the house within the settlement
`desc`	`string`	A description of the house
`people`	`array` of `object`s	An array of objects, each of which defines one person who lives in the house
`person.name`	`string`	The name of the inhabitant
`person.gender`	`string`	The gender of the inhabitant
`person.race`	`string`	The race of the inhabitant
`person.class`	`string`	The class of the inhabitant
`person.level`	`integer`	The level of the inhabitant
`person.owner`	`boolean`	Whether or not this inhabitant is the owner of the house
`items`	`array` of `object`s	An array of objects, each of which defines one item of note within the house
`item.name`	`string`	The name of the object or type of object
`item.desc`	`string`	The description of the object or type of object

This variable is also an array of objects, with a settled pattern.

Detailing the demographics of the settlement is optional, but should you want to detail it further, most of the variables are required, see below.

Metadata	Required?	Type	Description
`title`		`string`	Name of the class of demographic
`desc`		`array`	An array of objects, each detailing the subclass of demographics

See the example for how to format.

Each class of demographic can contain any number of subclasses. Each subclass contains a title and a quantity, both of which are required.

Metadata	Required?	Type	Description
`title`		`string`	Name of the subclass of demographic
`qtt`		`integer`	The number of members of this subclass of demographic

The quantity of buildings is now also customizable. Under the buildings variable, which is optional, one may define any number of building count.

Metadata	Required?	Type	Description
`title`		`string`	Name of the class of building
`qtt`		`integer`	The number of buildings of this class