Tutorials

The reference pages on this site describe one file, one field or one API at a time. These tutorials do the opposite: each one starts from an empty data pack and ends with something you can watch working in game, so you can see how the tables fit together before you look up every field.

The Example Pack

Every tutorial extends the same small content pack in the example namespace, and each one assumes the previous pages have been done. By the end of the series it looks like this:

data/example/
├── mxt/
│   ├── element/common.json                  Aura kind marker
│   ├── element/fire.json                    Element for the fire spirit root
│   ├── resource/qi.json                     The aura pool
│   ├── realm_stage/qi_condensation.json     Realm chain
│   ├── realm_stage/foundation.json
│   ├── realm_stage/core_formation.json
│   ├── cultivate_action/meditation.json     What the player does to absorb aura
│   ├── aura_zone/common_land.json           Where the aura is
│   ├── aura_zone/misty_valley.json          A denser zone (aura environment tutorial)
│   ├── block_aura/spirit_stone_ore.json     Blocks that emit aura
│   ├── item_aura/spirit_stone.json          Items that act as cultivation fuel
│   ├── spirit_root/fire_root.json           Granted by a pill
│   ├── cultivation_technique/azure_breath.json
│   ├── ability/qi_bolt.json                 An active ability
│   ├── ability/qi_recovery.json             A triggered ability
│   ├── item_quality/common.json             Quality tiers
│   ├── item_quality/refined.json
│   ├── item_binding/qi_pill.json            Bindings attach rules to real items
│   ├── item_binding/root_pellet.json
│   ├── pill_binding/qi_pill.json
│   ├── weapon_binding/spirit_sword.json
│   └── technique_binding/azure_manual.json
├── tags/mxt/item_quality/group/pill.json    Quality groups
├── tags/mxt/item_quality/group/weapon.json
└── (kubejs/startup_scripts/mxt_items.js)    The items themselves, registered by KubeJS

The Tutorials

Tutorial	You build	Read it when
Define Aura and Realms	An aura resource, a linear realm chain, a cultivation action and a minimal aura zone — the core cultivation loop.	You want a player to be able to cultivate and break through.
Build the Aura Environment	Layered aura zones, block aura, item fuel, noise, fluctuation, fog and HUD bars.	The basic loop works and you want the world to matter.
Create Items with KubeJS and Bind Them	Real items registered by a script, plus the four binding tables, quality tiers and recipes that give them gameplay.	You need pills, weapons or manuals of your own.
Add an Ability	An active ability, a triggered ability, and the ways to grant them.	You want something for the player to spend aura on.

Conventions

• Namespace. All examples use example. Rename it to your own modpack or content pack id, and keep the ids of the files and the references between them in sync.
• File locations. Data pack files go under data/<namespace>/mxt/<registry>/<path>.json; tags go under data/<namespace>/tags/.... The full list is in JSON Data Formats.
• Applying changes. MiXianTu data tables are native data pack registries, which Minecraft reads while the world loads, so /reload does not re-read them. After editing a data pack file, leave to the title screen and open the world again (or restart the server). /reload only refreshes recipes, loot tables, advancements, functions and the KubeJS server scripts. Registering new items or blocks with KubeJS also needs a game restart.
• Broken files block the world. There is no previous snapshot to fall back on: if a definition fails to decode, the world will not load until the file is fixed. The log names the file and the codec error, so keep the last working copy of a file you are editing.
• Verifying. /mxt registries validate reports whether the registries loaded, and /mxt registries list shows entry counts. The other commands are listed in Commands.
• Version. The mod is still in development and the data pack format is not frozen. These pages follow the current source; when a field changes, the reference page changes with it.

Where to Go Next

• Datapack Overview — file locations, IDs, holder references, the disabled tag and error reporting, if you have not read it yet.
• Datapack Examples — the same shapes as short, isolated snippets.
• KubeJS API Reference — the script objects used in the third tutorial.