Maps

A generator with a map returns cells or nodes that the application draws; each is filled by the same cell — a template, or {generate: name} — which sees its place and the generator's variables.

Square and hex maps

generators:
  village:
    map: { layout: square, width: 4, height: 3, cell: "{{ pick('village.place') }}" }
  region:
    map: { layout: hex, width: 8, height: 6, cell: { generate: region.terrain } }

A square map gives each cell x and y; a hex map, in rows where every odd row is pushed half a cell to the right, gives each cell its offset coordinates col and row and its axial coordinates q (col - floor(row / 2)) and r (row). The cell template sees these variables.

[
    'layout' => 'hex', 'width' => 8, 'height' => 6,
    'cells' => [['col' => 0, 'row' => 0, 'q' => 0, 'r' => 0, 'value' => 'forest'], …],
]

Graphs

generators:
  dungeon:
    map: { layout: graph, nodes: '1d4+3', extra_edges: 2, cell: { generate: dungeon.room } }

A graph has a number of nodes — a number, or a dice expression rolled for each map, at least one — each filled by the cell, which sees index and count. Each node after the first is joined to an earlier one chosen at random, so that every node can be reached; then extra_edges more passages join two nodes not yet joined, making loops, as many as the graph can still take. Edges are pairs of node identifiers, the smaller first, in order.

[
    'layout' => 'graph',
    'nodes' => [['id' => 0, 'value' => ['kind' => 'hall', 'feature' => 'a locked chest']], …],
    'edges' => [[0, 1], [0, 3], [1, 2], …],
]

A map has at most Limits::$cells cells or nodes. Placing the nodes in space, the terrain that follows its neighbours and the drawing are left to the application or to more specific packages.