SirenHytale
In this section
  1. Cultivation
  2. Addons
  3. Compatible Mods

Add-ons & Compatible Mods

Since v0.5.0 Cultivation is a foundation as much as a mod. Another plugin can replace the entire progression ladder, re-word every message, add a playable race or register new techniques — and everything else keeps working on top.

How Compatibility Works

Cultivation exposes four extension points that matter to players. An add-on picks whichever it needs; it does not have to take all of them.

Replace the ladder

A mod supplies its own levels, rank names and curve. Cultivation stops reading its own realms and reads that mod's numbers instead.

Re-word everything

Chat, HUD, menus, item names and tooltips can all be renamed without changing a single behavior.

Add a race

New races appear in the race menu beside Human, Demon and Deity, with their own unlock realm, bonuses and Yin bias.

Add techniques

Third-party arts register into the same open registry the built-in arts use, with their own realm gates, Qi costs and cooldowns.

The important guarantee

Your original Cultivation progress is never overwritten while an add-on is running. It sits untouched underneath, so removing that add-on hands you straight back the realm you had. The realm an add-on says you count as is never written to your save file.

Known Add-ons

Eleven add-ons are made by the same author as Cultivation. Ten ship from the Treasure Pavilion: two are free, the rest come with a Cultivation subscription, and all of those but Jade Slip can also be bought outright. SoulRings is still in development. Every one needs Cultivation v0.11.0 or newer on a Hytale Update 7 server.

Add-onWhat it addsCost
Jade Slip · 玉简Ten palettes that recolor every menu, brighter auras, thirteen sect banners, eleven titles and seven Codex articles. Purely cosmetic.Subscription
Sacred Bodies · 圣体Sixteen sacred bodies and eight physiques rolled once at birth, plus Heaven's Favored, a seasonal fortune that can be taken. Changes balance.Subscription or one-time
Heavenly Flames · 天火Twenty-two ranked living fires. Devour one, and it burns until something stronger replaces it.Subscription or one-time
REVERSE · 逆行Mortal Backsliding: an opt-in profile where kills, hoards and wins drag you down, and poverty, alms and defeat lift you.Subscription or one-time
Classes · 职业Six classes, each with a perk tree, a signature technique and a mastery title.Subscription or one-time
Hardcore Tribulation · 九死一生A failed tribulation burns hardcore lives; run out and your foundation is severed or your realm cast down.Subscription or one-time
Rubber Duck · 橡皮鸭A joke eleventh Dao that beats every element, claimed with a Carved Wooden Duck.Subscription or one-time
Tribulation Karaoke · 渡劫天问The Heavens question you mid-tribulation; survive by typing the answer back.Subscription or one-time
Landlord · 房东Rent your Cave Abode's Spirit Spring to one tenant for a cut, and evict them when it sours.Free
Snail Realm · 蜗族秘境The Snailkin race: slow, patient, and fastest while perfectly still.Free
SoulRings · 斗罗大陆A Soul Land re-theme of the whole ladder. In development, not yet released.Not yet available

Mermaids, a separate mod by the same author, is covered below. If you want the detail behind any of the others, follow its link.

Add-ons that show what the API can do

Four are worth a closer look, because each leans on a different extension point.

SoulRings · 斗罗大陆

A full re-theme that swaps the Xianxia ladder for a Soul Land one — martial souls, soul rings absorbed from slain spirit beasts, and a 1–100 curve in place of seven realms and twenty-eight sub-stages.

It uses the progression hook to replace the ladder, the theme hook to re-word the mod's vocabulary, registers its own techniques, and adds its own sections to Cultivation's admin config editor. Sects, formations, abodes, duels, alchemy, spirit beasts and the skill tree all continue to work unchanged on top of it — which is the scenario the 0.5.0 API was built for. See SoulRings.

It is not released yet: there is no download or store listing, and Cultivation's own Info page shows it as Coming soon. The build in development is v0.1.0.

in developmentsame author
Mermaids

Registers Merfolk as a playable Cultivation race. It appears in /cultivation race alongside the built-in three, with its own unlock realm, stat bonuses and Yin bias, and runs through exactly the same code path as Human, Demon and Deity.

race integrationsame author
Cultivation: Jade Slip · 玉简

A paid add-on, included with a Cultivation subscription: ten palettes that recolor every menu, the HUD and the skill tree (eight you buy in, two you earn), brighter auras, thirteen more sect banners, eleven cosmetic titles and seven Codex articles.

It is purely cosmetic — nothing in it changes progression, balance, or what any player can do, and a server without it plays exactly the same game. See Jade Slip.

cosmetic onlysubscriptionsame author
Cultivation: Sacred Bodies · 圣体

A paid add-on, available with a Cultivation subscription or bought outright. The rare constitutions a cultivator is born with. Sixteen sacred bodies and eight stackable anatomical physiques, each rolled once on a player's first login and carried for life — re-pricing Qi, damage, charge time, rituals and the aura. Since v0.3.0 it also carries Heaven's Favored, one fortune a season that moves between players.

Unlike Jade Slip this one is not cosmetic, so it is worth knowing what it does before installing it: roughly one cultivator in forty is born with a sacred body, and every body, physique and rate can be disabled individually. It is built entirely on the standing-modifier registry added in 0.7.4. See Sacred Bodies.

changes balancesubscription or one-timesame author
Running an add-on

Install it the same way as Cultivation — the jar goes in your server's mods\ folder. Cultivation must be installed too; add-ons extend it rather than replace it. Only one mod may replace the progression ladder at a time.

Purchases reach the buyer in game

New in 0.8.0. Anything bought from the Treasure Pavilion at xianxia.dev/store now applies on any server running Cultivation, not only one you own — and brings its own cosmetic title with it.

v0.10.3 This is not only for one-time, name-bound purchases. A live family subscription, and an addon bought outright, both reach the game the same way — as a Treasure Pavilion title. Only a purchase's own account-binding rules differ; whether it applies in game does not.

How it works, and what it does not do:

  • The mod reads a public list of account IDs from https://xianxia.dev/api/get/entitlements/, every 6 hours by default (Check-Interval-Hours).
  • Nothing about your server is ever sent. It is a plain read of a static list; there is no telemetry, no server identifier, no player list going the other way.
  • A refund revokes itself at the next check, because the account simply stops appearing on the list.
  • It fails open. An offline server, an unreachable endpoint or a malformed response leaves everybody exactly as they were.

Web-Store-Enabled in WebStoreConfig.json switches the whole thing off in one line. Admins can inspect it with /cultivation store status and force an early read with /cultivation store recheck (rate-limited, and disablable with Allow-Recheck-Command).

An open registry, for add-on authors

A benefit is registered through the same public API Cultivation's own product uses — CultivationAPI.registerStoreBenefit(StoreBenefit.builder("myMod:store:crown", "my-mod-crown")...). Your add-on names its product key and, optionally, a title to unlock; the shared sync does the fetching, the caching and the revoking for you. See Registries.

Web Store is one of the two config sections wired into the in-game /cultivation admin editor in 0.8.0 (the other is Ascension).

Compatibility Notes

v0.11.0 Cultivation v0.11.0 and every first-party add-on released with it (Jade Slip 0.4.0, Sacred Bodies 0.4.0, Heavenly Flames 0.3.0, REVERSE 0.2.0, Landlord 0.2.0, Classes 0.2.0, Hardcore Tribulation 0.2.0, Rubber Duck 0.2.0, Snail Realm 0.2.0, Tribulation Karaoke 0.2.0, with SoulRings, still in development, at 0.1.0) require a Hytale Update 7 server and do not run on Update 6. Keep the previous version of each on an Update 6 server. The version table is on Compatibility.

SituationWhat happens
You remove a progression add-onYou return to the Cultivation realm you had before it was installed. Nothing was overwritten.
Two add-ons both try to replace the ladderOnly one can hold the hook. Run one at a time.
An add-on renames things only partiallyAnything it does not rename keeps Cultivation's own wording — and stays translated in every language Cultivation ships.
You see settings not documented on this wikiThey belong to an add-on. Any mod can add its own section to the /cultivation admin config editor.
A language pack tries to override Cultivation's textIt is silently discarded. The engine merges language files first-come, and Cultivation's own pack always loads first — which is exactly why the theme hook exists.

Building Your Own

Everything above is public API, documented in full with its threading rules. Start with the API Overview, then:

  • Add-ons — replacing the ladder, re-wording the vocabulary, and adding your own admin config sections.
  • Registries — adding races, techniques and other open registry entries.
  • Events — 377 events, pre and post, across 53 classes, covering nearly every mechanic in the mod.
  • Reference — the facade methods and their contracts.
Made something?

If you have built a mod that works with Cultivation and want it listed here, get in touch through the CurseForge page.