Cultist Simulator

Cultist Simulator

Not enough ratings
Codex
   
Award
Favorite
Favorited
Unfavorite
File Size
Posted
Updated
124.750 KB
22 May, 2023 @ 8:50am
23 Jul, 2024 @ 5:29am
11 Change Notes ( view )

Subscribe to download
Codex

In 1 collection by [FR] Genroa
Mariner Complete Collection
3 items
Description
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.
17 Comments
[FR] Genroa  [author] 23 Jul, 2024 @ 5:34am 
Update 1.3.5:
- the "pale background" bug has been fixed. It was a missing asset that was supposed to be present in the Roost, but currently isn't. Was a bit hard to track down because a duplicate of this asset exists in Shelves, so I wasn't reproducing it locally and not everyone was reporting the same issue. Should be all good now!
inago 11 Jun, 2024 @ 3:47am 
Thanks for posting that was going to talk about the same issue.
[FR] Genroa  [author] 27 May, 2024 @ 11:25pm 
Sounds like an old bug, maybe unsubscribing and resubscribing might help. Steam has a habit of not properly updating DLL mods automatically.
getoffmeow 24 May, 2024 @ 6:27pm 
the background of the codex is a very bright pale color on my install, any ideas why that would be the case?
[FR] Genroa  [author] 7 Apr, 2024 @ 2:00pm 
Update 1.3.3:
- major rework, uses the new UI framework integrated into the Roost. The mod was rewritten from scratch
- support for subentries
初阶电脑 25 Aug, 2023 @ 1:55am 
Don't worry, I wrote a script to translate the description-related fields. If there are updates, I just need to run the script again.
[FR] Genroa  [author] 25 Aug, 2023 @ 1:25am 
Also, to discuss this further, please come talk to us on the cultist simulator fan discord. :)
[FR] Genroa  [author] 25 Aug, 2023 @ 1:24am 
You...tried translating it by hand? You know a lot of it is generated and might change a lot with each update, right?

Codex uses the same TMPro components for its UI so it should support all the fonts. Maybe it doesn't work. Codex is getting a big UI rework, we'll take a look at it. Thank you for your feedback!
初阶电脑 25 Aug, 2023 @ 1:20am 
I tried to translate "Mariner" into Chinese, but the Chinese font is missing in "Codex".
[FR] Genroa  [author] 30 Jun, 2023 @ 6:10am 
@Mensluguolo for the requirements:

Yes, you can check if an entry exists or has a specific mutation on it via the grandReqs property (Roost Machine specific, but Codex requires this mod to be enabled anyway). Example:

"grandReqs": {
"[*/codex : myentryid]" : 1
}

For more information, please consult the modding documentation written by the discord community, or even better, come talk to me in the #modding channel of the discord community server. :)