Codex

Official compatibility

Element	Reference
TypeWriter	Required. Use the official TypeWriter release supported by the extension release.
Related extensions	Install the related extensions listed on this page before using entries that depend on them.

The Codex Extension allows you to create comprehensive discovery logs where players unlock entries through exploration, crafting, or specific actions. It handles tracking, percentage completion, and automatic GUI generation for browsing unlockables.

Features

• Discovery Logs — Group items or monsters into categories that unlock as the player encounters them.
  • Recipe Books — Display custom crafting recipes in a dedicated, navigable UI.
  • Progression Tracking — Automatically calculates % completion for categories.
  • Auto-Generated GUIs — Menus are built automatically based on your definitions.
  • Fragments & Treasure Hunts — Collectible fragments grouped into collections, with treasure hunt definitions that reward completing a set.

Fragments

The former Fragment extension is now part of the Codex: fragments are collectible pieces (fragment_definition) organized into groups (fragment_group) and collections (fragment_collection_config). A treasure_hunt_definition turns a set of fragments into a hunt with completion rewards. Player collection state persists in fragment_artifact.

observação

If you previously used the standalone Fragment extension, its entries now live in the Codex extension — same entry names, same data shape.

Entries

• Definitions — Discovery Category: Define unlocking categories and progression logs. Recipe Definition: Create custom recipe books and crafting guides. Fragments: fragment_definition, fragment_group, fragment_collection_config, treasure_hunt_definition.
  • Actions & Menus — Open Codex: Action to open specific codex menus. Global Menu: codex_global_menu — OmniGUI-layout codex hub.
  • Artifacts — fragment_artifact: player fragment collections. codex_unlock_artifact: which unlock triggers already fired per player — unlock rewards fire exactly once.

User guide

• 1. Define — Add definition entries: discovery_categ_definition, discovery_recipe_definition, discovery_categ_open. These define the structures, entities, or rules the extension operates on. → discovery_categ_definition → discovery_recipe_definition

Commands

Command	Description	Aliases
/tw codex open <category>	Open a specific codex category menu.	/tw dcx open

Placeholders

Global placeholders for tracking progress.

Placeholder	Description
%discoverycodex_category_<id>_name%	Display name of the category.
%discoverycodex_category_<id>_unlocked%	Count of discovered entries.
%discoverycodex_category_<id>_total%	Total entries in the category.
%discoverycodex_category_<id>_percent%	Completion percentage (0-100).
%discoverycodex_item_<id>_unlocked%	true/false if specific item is unlocked.

Dependencies

Extension	Required	Usage
GUI Extension	Required	Menu rendering and layout system.
PlaceholderAPI	Optional	For @Placeholder fields.

Troubleshooting

The extension is not visible

Check that the installed release matches the supported TypeWriter release and that the related extensions listed in the compatibility section are present.

An entry is missing

In the Typewriter Web panel, use the Search bar or the + button to find or create the entry with its exact identifier. Entry IDs and field names are case-sensitive; do not translate them.

The entry saves but nothing happens

Check that the entry is connected to the trigger, command, objective, event, or menu interaction required by its type. Test with optional permissions and criteria removed, then add them back one at a time.

An integration does not work

Verify the dependency and version shown in the extension card, then check the server log for the first error. Do not replace a missing dependency with a similarly named plugin unless the extension source explicitly supports it.