Getting Started - Faith-and-Code-Technologies/mDirt GitHub Wiki
Getting Started
Welcome to mDirt! This guide walks you through creating your first Minecraft datapack using mDirt's simple GUI.
1. Launch mDirt
Open mDirt! Installation instructions can be found here.
2. Create a New Project
- Go to File -> New Project
- Fill in the required fields:
- Name: The display name of your datapack (e.g.
The Ruby Pack
) - Namespace: A short, no space, no uppercase identifier (e.g.
ruby_pack
) - Description: A brief summary of what your pack adds (e.g.
A pack with Rubies and Ruby Armor!
) - Author: Your name or username (e.g.
jupiterdev
) - Version: The target Minecraft version (e.g.
1.21.4
)
- Name: The display name of your datapack (e.g.
3. Explore the Interface
Once the project is created:
- The left sidebar shows all finished Elements (blocks, structures, items, etc.).
- Use the Menu Bar to create a new Element (New Element > Block, Item, etc).
- The main area lets you view and edit properties of an element.
4. Add Your Elements
Add any Elements you want in your pack! For a first pack, we recommend keeping it simple.
5. Export Your Pack
- Click File -> Export
- mDirt will automatically export your project to the
exports/
folder inside the mDirt directory. - You will see both a data pack and a resource pack. Bring them into Minecraft.
6. Load It in Minecraft
- Place the exported data pack inside your world's
datapacks/
directory - Place the exported resource pack inside Minecraft's
resourcepacks/
directory - Launch Minecraft and open the world
- Run
/reload
in game to activate the datapack - Pause the game and go to
Resource Packs
, and enable your pack. - Test your custom content:
/function YOURNAMESPACE:give_blocks
to get custom blocks/function YOURNAMESPACE:give_items
to get custom items/function YOURNAMESPACE:give_paintings
to get custom paintings/function YOURNAMESPACE:give_equipment
to get custom equipment
Replace
YOURNAMESPACE
with the namespace you entered in your project setup
Next Steps
Explore the documentation to learn more about each Element.