Start Here/The Codex·起

The Codex

The Codex (典籍) is Cultivation's reference book, and it lives inside the game rather than on this wiki. Twenty-eight 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.

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

Opening It

How	Notes
The Codex item	Right-click it. Craftable, and the recipe is shown in the Codex itself.
The menu bar	The 典籍 button on any Cultivation menu.
`/cultivation codex`	Straight to the index.
ALT+4	Bound to the Codex out of the box — see Keybinds.

The Four Sections

Section	Covers
The Path	Realms, Qi, breakthroughs, tribulation
The Self	Race, Spiritual Root, The Way, techniques, companions
The World	Spirit veins, sects, abodes, formations
The Craft	Alchemy, refinement, manuals

Why It Reads Your Server

A wiki page can only ever state the defaults. If a server owner halves Qi-Required-Base or moves Spirit-Sense-Min-Realm, 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.