MiXianTu

MiXianTu is a cultivation mod framework: it provides the generic rules and runtime that cultivation gameplay needs — cultivation, aura environment, realms and resources, abilities, formations, tribulations, forging, alchemy, economy — without prescribing any particular setting or numbers.

The actual items, blocks and recipes are provided by datapacks, KubeJS or other content mods, and MiXianTu's data tables and binding tables give them gameplay.

• Players: installing the mod on its own only gives you framework items, Curios slots, HUD and commands; what you can actually play depends on the datapack or content pack you use.
• Content and mod authors: define your own cultivation rules, aura distribution, abilities, formations, crafts and item bindings with datapacks, KubeJS or the Java API, without changing the mod itself.

The project is still in development. Datapack formats and other interfaces are not final, and updates may no longer be compatible with old saves or old datapacks. Changes that can cause crashes or data loss will be called out explicitly in the changelog.

Links

• Documentation: full documentation for datapacks, KubeJS and Java development. Still being written, and will keep being updated.
• Datapack Visual Editor: edit this mod's datapacks in the browser as a form, with field descriptions and registry completion, so you never have to write JSON by hand.

What the Mod Provides

For Players

• Keybinds: C toggles cultivation mode, Z opens the character information panel, R opens the wheel (the one way abilities and spirit power are triggered), the arrow keys turn its pages; "Swap Main Hand with Back Weapon Slot" is unbound by default. All of them can be changed in the controls settings.
• Interface: the wheel is a main wheel plus pages read from what you carry, all strung together by one continuous cell numbering - you arrange the main wheel's twelve cells yourself, and the pages behind it come from your main hand, offhand, artifacts and the contract beast your Beast Taming Bell is tuned to, opening another page whenever one is not enough; plus resource bars and an aura HUD.
• Blocks: Spirit Crafting Table (uses aura recipes and deducts aura when the result is taken out), Forge Table, Exchange Station, Trade Station, Cheque Table, Display Stand, plus Spirit Stone Ore and Spirit Stone Block. An alchemy furnace is hand-built as a 3×3×3: core at the front, main bin on the left when you face it, auxiliary bin on the right, output on top, and 18 material walls - the two layers above the base are filled, and the base only needs its four corners, so the five cells between them are not checked. No herb block is among them: a herb definition claims existing blocks with blocks and its own fruit with growth.drops, and the mod registers no herb block.
• Items: materials such as Lesser to Supreme Spirit Stones, Spirit Iron, Spirit Wood and Cinnabar; generic items such as Spirit Ring, Spirit Stone Bag, Spirit Vessel, Identification Mirror, Cultivation Jade Slip, Blank Talisman Paper, Talisman Brush and Talisman (written with a sigil, poured full of aura, and spent the moment it fires), Contract Scroll, Beast Taming Bell, Spirit Beast Bag, Formation Plate, Wooden and Stone Tokens, Secret Realm Token and Recall Talisman.
• Talismans: a Talisman Brush writes ability definitions onto a carrier, and pouring aura in loads it; the moment the bill is full every inscribed ability fires and one carrier is spent. A carrier that would not fire - or one billed nothing at all - fires from a right-click instead, and a definition may declare durability for its carrier (durability / consume), which spends wear instead of whole carriers until the carrier breaks and hands back whatever it never burned; costs is what the invocation takes from the holder, and a talisman's tier comes from the grades[].quality a drawing recipe hits written into the mxt:quality component at inscription time, with the default_quality registry as the carrier's fallback (the talisman definition has no quality field of its own). A drawing workstation shows a formula's shape, the player traces it with a brush that carries its own pigment, and how well it was traced decides success and tier.
• Display Stand: any item can be put on one to be shown; a talisman there fires the moment a spirit burst fills it, from the stand's own position - the formulas' block_x/block_y/block_z, the centre of an area selector and where a projectile is launched from all use the stand, not whoever filled it.
• Slots: three Curios slots — Back Weapon, Belt Item and Cultivation Technique — swappable with the main hand by keybind.
• Commands: the /mxt family (registry validation, resource and aura queries, cultivation status, breakthrough and more) and /display to show equipment.

The actual gameplay content — realm values, aura distribution, abilities, formations and recipes — is provided by datapacks or content packs; installing the mod alone does not give you a complete progression.

For Datapack / Mod / Modpack Authors

• Datapacks: define resources, realms, aura, abilities, formations, crafts, economy and other rules with native datapack registries; they are validated on load and synced to the client.
• Actions and conditions: five families — entity, bi-entity, block, item and damage — freely combinable in datapacks.
• Numbers: constants, exp4j expressions or structured number providers, able to read context variables such as level and resources.
• Item integration: binding tables hook existing items into weapons, pills, resources and aura fuel, which makes integration with other mods easy; items implementing AuraItemAccess (spirit stones) can additionally be charged by holding them down and pouring the holder's own aura into them. Per-stack additions carry no binding object: quality (mxt:quality), element, pill data, technique reading, forging methods and blueprints are components written onto the stack itself, layered on top of whatever a definition grants.
• KubeJS: extension points such as action, condition, cost, number provider, target selector, trigger matcher and loot callbacks, the MxtEvents server lifecycle events, and the MxtTriggers custom trigger signals a script can publish and subscribe to; register items from a script first and let the binding tables handle them.
• Java API: interfaces for data table registration, attachments, networking, screens and client rendering.

Module Status

• ✅ Done: everything is implemented and passed basic tests; minor changes may still happen later.
• 🚧 In Progress: only part of the feature set is done, the rest is still being developed.
• 🔲 Planned: only data structures or assets exist, or there is only a development plan.

FAQ

Why does nothing change in game after installing the mod?

The mod only provides the framework, generic items, slots, HUD and commands; it contains no realm values, abilities or recipes. You need a datapack or content pack (including content written with KubeJS) before real gameplay appears.

What dependencies are required?

Jupiter and ApricityUI are required dependencies needed manual installation, and every other required dependency is bundled inside the mod. KubeJS is only needed if you want to register content from scripts. JEI and Jade are optional compatibility mods, and the game works fine without them.

Can I make my own content pack and distribute it?

You can build content packs on this framework, and distributing them is not restricted in any way.

NOTE: the mod's code and assets are All Rights Reserved, and commercial distribution (such as a paid server) requires extra permission — see LICENSE for details.

Got Ideas, Want to Contribute, or Have More Questions?

Join our Discord to discuss.