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 and sects — 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, LAlt shows the ability hotbar, V fires spirit power; "Swap Main Hand with Back Weapon Slot" is unbound by default. All of them can be changed in the controls settings.
• Interface: resource bars, an aura concentration HUD, and a hotbar shared by abilities and spirit power (number keys 1–9 select entries).
• 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.
• Items: materials such as Lesser to Supreme Spirit Stones, Spirit Iron and Spirit Wood; generic items such as Spirit Ring, Spirit Stone Bag, Spirit Vessel, Identification Mirror, Cultivation Jade Slip, Blank Talisman Paper with Talisman Brush and Ink, Contract Scroll, Beast Taming Bell, Spirit Beast Bag, Formation Plate, Wooden and Stone Tokens, Realm Token and Recall Talisman.
• 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, sect territory 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, techniques, resources and aura fuel, which makes integration with other mods easy.
• KubeJS: extension points such as action callbacks and number providers; 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 usable right away; 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 is a required dependency, 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.

How do I disable a piece of content temporarily?

Add the entry to the mxt:disabled tag; disabled definitions stop taking part in gameplay, and you do not have to delete any datapack files.

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.