world.toml
Generated from tools/pl-assets/src/profile_files.rs by ploom schema world --markdown; do not edit it: cargo xtask bless rewrites it. docs/creating-a-game.md explains the keys with examples; this is the list of all of them, with their types, ranges and defaults.
The build reports every mistake in the file at once, each with its line. A key that is not here is an error.
The top level of maps/world.toml
Section titled “The top level of maps/world.toml”Worlds of maps that sit side by side: crossing from one map to the next changes the map without a load (docs/plans/28-world-grid.md). ploom import writes the file for an import; a creator writes it to join their own maps.
Pack record: WRLD, a row an area.
| Key | Type | Without it | What it is |
|---|---|---|---|
world |
table of at most 255 named entries, below | must be given | the worlds, each named; a world’s number is its place in the file, from 1 |
[world.<name>]
Section titled “[world.<name>]”<a id=“world-name”></a> One world.
Pack record: WRLD, a row for each of its maps.
| Key | Type | Without it | What it is |
|---|---|---|---|
maps |
table of at most 4096 named entries, each list of 2: whole number, 0 to 65535, then whole number, 0 to 65535 | must be given | each map and its north-west cell, town = [96, 864]; a map the game does not list is left out, a map is in one world |
matrix |
whole number, 0 to 9223372036854775807 | none: not read | the importer’s mark: the original’s map matrix |
chunks |
list of 2: whole number, 0 to 9223372036854775807, then whole number, 0 to 9223372036854775807 | none: not read | the importer’s mark: the original’s size in chunks |