Config.module
README.md
umbral.Config
The one shared module. Every number UMBRAL obeys and every table it reads lives here so a system never invents its own copy.
Read by: scenes/main.scene/build.luau (which builds the map from MAP), umbral.Art
(region palettes and backdrop depths), umbral.Ilva (the PLAYER tuning table),
umbral.Enemies and umbral.Hud.
What it holds
| Table | What it is |
|---|---|
PALETTE | The seven colours the whole game is drawn in, as linear rgb. Void, stone, bronze, turquoise, amber, bone, blood. |
PLAYER | Ilva's tuning: health, the Coro's maximum and what fills and spends it, the healing ring, i-frames, the two swings' damage and timing, the Badajo's reach, the echo's radius and duration. |
REGIONS | The nine regions: id, display name, the palette tint it leans on, its musical bordón, and the depth band its backdrop sits at. |
MAP | The geometry: solids (solid rectangles), oneWay (jumped up through), braziers, bells, and the spawn point. |
Conventions
A tile is one world unit and the grid is whole units. Gameplay is the plane z = 0.
Rectangles are { x, y, w, h } with x, y the bottom-left corner. Ilva's collision box is
0.625 × 1.25, so a corridor is at least 3 units high and a doorway at least 2.
A bell is named bell_<name>; hidden geometry is named hidden_<anything>. Those two names
are the only contract between the art pass and the echo mechanic.
Config.colour(name) returns the three channels of a palette entry so a light can be built
from a name rather than from numbers repeated in five files.