The Codex

The Codex (典籍) is Cultivation's reference book, and it lives inside the game rather than on this wiki. Dozens of articles cover every system the mod ships, and each one is written against your server — it states the numbers this server is actually running and what you have actually reached. New in v0.6.0.

v0.11.2 Three new articles: Aura Sight and Pressure under The Self, and Retainers (门客) under The World. Each reads its numbers from your server's config - Aura Sight's reach and the realm that opens it, Pressure's radius, Qi drain and burst cooldown, the retainer fees, wages, slots and posts - and neither hides behind a gate: if the server has a feature switched off, its article says so in place instead of vanishing. There is no article yet for the death penalty, Spirit Stone grades, the rare places or the Technique Menu (which is itself the in-game list of your arts); those pages here are the reference.

v0.11.1 Four new articles: Dao Seals and Dao Domains under Self, and the Spirit Vein Compass and Sect Array Domain articles under The World.

v0.11.0 A new first article under Self, Reading Your HUD, explains the rebuilt corner HUD: the Qi orb and its rings, everything affecting you right now with the time left on each, and every blessing, affliction, state, warning and Dao badge the HUD can show, each beside its icon. Icons for features your server has switched off are left out.

v0.10.3 Six new articles joined this version: Transmission Array, Factions, Tea Ceremony, Weiqi, Path War, and the Depths.

That is the one thing a wiki cannot do. This site documents the defaults; the Codex documents your world.

Not every system has an article. The Void Rift and Divination have none, so their pages on this wiki are the reference for them.

Opening It

The Four Sections

Why It Reads Your Server

A wiki page can only ever state the defaults. If a server owner halves Base-Qi-Requirement or moves Spirit-Sense-Qualitative-Min-Realm and Spirit-Sense-Qualitative-Min-Stage, every number written here is wrong for that server — and the player has no way to know.

A Codex article is rebuilt from scratch every time somebody opens it, and it carries the reader with it. So it can say:

• the configured value on this server, read live from the config file;
• what the reader personally has reached, so an article can tell you that you are two realms short of what it describes;
• a crafting recipe, resolved live from the item's own asset — a server owner who edits a recipe sees the change in the Codex with nothing else to update.

Articles deliberately do not hide what you have not unlocked. A codex that hides what you cannot do yet cannot tell you how to get there; instead an article notes, in place, that a section is beyond your current realm.

The Cultivation Journal

One article takes "what the reader personally has reached" further than the rest: the Cultivation Journal doesn't just report where you stand, it writes itself as you get there. It logs breakthroughs, tribulations survived, techniques mastered, beasts bound and more the moment they happen, and reads back your running totals every time you open it.

Heavenly Dao, Personal Daos, and Dao Enlightenment

Three more articles cover The Way's newer tracks: your current Heavenly Dao rank and what the next one asks for, every Personal Dao you've comprehended (and, tastefully, that there is one more still hidden if you haven't found it), and how Dao Enlightenment actually works. The Personal Daos article needs no per-Dao knowledge of its own — it reads the same open registry the page itself does, so an add-on's own registered Way appears in it for free.

For Add-on Authors

The Codex is an open registry. Your own mod can file an article beside Cultivation's own, and it will look and behave identically:

CultivationAPI.registerCodexEntry(
        CodexEntry.builder("myMod:alchemy")
                .title("server.myMod.codex.alchemy.title")
                .summary("server.myMod.codex.alchemy.summary")
                .category(CodexCategory.CRAFT)
                .body(page -> page
                        .heading("server.myMod.codex.alchemy.costs")
                        .paragraph("server.myMod.codex.alchemy.intro")
                        .stat("server.myMod.codex.alchemy.brewTime", config.getBrewSeconds())
                        .recipe("MyMod_ElixirOfNight")))

An article describes itself in blocks — heading, paragraph, stat, note, recipe, divider — and the Codex decides how each one looks. That is what keeps entries free of any UI knowledge, and what lets the Codex's own appearance change without touching a single article.

Registering an existing id replaces it, which is how a mod rewrites a built-in article rather than adding beside it. Full details in Registries.