Codex

A codex entry is a piece of long-form content the host UI surfaces once the player has unlocked it. Writers create entries in the editor’s Codex panel (a title, body prose, an optional category, and tags), then fire Unlock Codex events at the right beats to reveal them to the player. The host game’s codex UI lists unlocked entries; locked ones remain hidden.

For conventions shared by all entity types, see Entities.

Fields

ID

The codex entry’s expression-namespace identifier. You’ll use this name in unlock codex events and in expressions that reference the entry. Pick from the editor’s codex picker. Renaming the ID updates expressions that mention the old name.

Convention: codex ids are prefixed codex_.

Title

The entry’s heading, shown in the codex list screen and in any host UI that displays the entry’s name. Free-form string, author-typed. This is the visible label (not the expression-namespace ID), and it’s what the host game renders as the article heading.

Body

The full article body: long-form prose that makes up the codex entry’s content. The codex screen renders this when the player selects an entry to read. Free-form string, author-typed.

Category

Optional category label used to group entries in the codex screen. The host UI typically organizes the list by this value, grouping all entries with the same category into a section. Free-form string, author-typed. If omitted, the entry appears in a default or ungrouped section.

Tags

List of tag ids (see Tag) attached to the codex entry. Used for cross-cutting filtering (e.g. hiding entries the player shouldn’t see yet, or grouping entries by topic in a codex filter view). Tags are checked with HasTag in expressions.

Translator notes

Title, Body, and Category can each carry a translator note: see Entities for more information.

When to reach for codex entries

Codex entries fit content the player should be able to look up after the moment has passed: backstory, character bios, location notes, lore the writer wants on record but does not want to interrupt the scene with. Author the article in the Body field directly; Category is the free-text grouping the host UI uses to bucket entries in the codex screen.

Unlocking is gated by the Unlock codex event, which a node fires when the runtime decides the player has earned the entry. The unlock is one-way: once unlocked, an entry stays unlocked for the rest of the run. If you want re-lockable state (something that can become hidden again), a variable fits better than a codex entry.

See also

• Unlock codex: the event that reveals a codex entry to the player.
• Tag: codex entries carry tags for filtering.
• Expressions: id conventions.