Codex
Codex being a DLL-mod and relying on The Roost Machine mod, it only targets the beta gateofhorn branch. Make sure you have The Roost Machine subscribed to and enabled, and are on the correct branch.
Codex is a DLL-mod adding a new feature to the game, that other mods can use: the "codex".
It lets modders define entries (as elements), and add them to the codex via new properties (unlockCodexEntries, updateCodexEntries, removeCodexEntries). Check the modding documentation[docs.google.com] for detailed informations about their syntax. To make entries "dynamic", use the refinement syntax and the updateCodexEntries property to mutate aspects onto existing codex entries.
To get a better idea of how it works, check the images on this workshop page.
Controls:
- when a mod starts unlocking any entry, a new button will appear at the bottom of the screen. Left clicking it will open the Codex window
- When some entry is updated or added, the button will display a yellow dot to notify you that there is unread content. Left click on the button to open the codex, right click on the button to mark all content as read.
This mod adds the feature in itself, it doesn’t come with an encyclopaedia covering lore and/or mechanics from the base game.