Skip to content

lights.toml

Generated from tools/pl-assets/src/profile_files.rs by ploom schema lights --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.

Tables of light through the day, each named and used by a map’s light (light = "cave_glow"). A table named day, bright, dim or warm replaces the engine’s. Each is a [<name>] with periods.

Pack record: the maps’ .pfa headers (their light periods).

It has no keys of its own.

<a id=“name”></a> One table of light: periods = [ { start = "00:00", sun = "#9494ef", night = true }, { start = "05:00", sun = "#cecef7" } ]. The first period starts at 00:00, in order of time; each lasts until the next.

Pack record: the maps’ .pfa headers.

Key Type Without it What it is
periods list of 1 to 16 tables, below must be given 1 to 16 periods, the first at 00:00, in order of time

<a id=“name-periods-n”></a> One period of a table of light.

Pack record: the maps’ .pfa headers.

Key Type Without it What it is
start hour "hh:mm" must be given the hour it begins, like “05:30”
sun colour "#rrggbb" must be given what multiplies everything that takes the day’s light
lamp colour "#rrggbb" "#ffffff" what multiplies window glass and lanterns
glow whole number, 0 to 31 0 how strongly pools of light show
night true or false false what battles and the like ask: it is night
lights list of 4: list of 4: colour "#rrggbb", then whole number, -512 to 511, then whole number, -512 to 511, then whole number, -512 to 511 none: the palettes are multiplied by sun and lamp the hardware’s four lights, as an original game lights its models: each [colour, x, y, z], the direction in the world in 512ths (x east, y up, z south); "#000000" is off. Materials with lights (and the characters) are lit by them; give every period of the table both this and material
material list of 4: colour "#rrggbb", then colour "#rrggbb", then colour "#rrggbb", then colour "#rrggbb" none: with lights: required the colours the lit materials reflect, [diffuse, ambient, specular, emission], unless a model gives its own
material_all true or false false material is every lit material’s, its own colours too (as an original game lights outdoors)
card_material list of 4: colour "#rrggbb", then colour "#rrggbb", then colour "#rrggbb", then colour "#rrggbb" none: the characters reflect material the colours the characters’ cards reflect, [diffuse, ambient, specular, emission] (as an original game draws its characters with a model of their own colours)
card_normal list of 3: whole number, -512 to 511, then whole number, -512 to 511, then whole number, -512 to 511 none: a face turned up the characters’ cards’ normal as the camera sees it, in 512ths (x right, y up, z toward the viewer)
clear colour "#rrggbb" none: the map’s clear colour under sun the colour behind the scene in this period, as given (the map’s grade and the weather still multiply it)
fog colour "#rrggbb" none: the map’s or the weather’s fog colour under sun the fog’s colour in this period, when fog shows, as given