Skip to main content

Compile JavaScript-style MDL language or Python API into a Minecraft datapack (1.21+ ready). Features variables, control flow, error handling, and VS Code extension.

Project description

MDL Icon Minecraft Datapack Language (MDL)

A modern JavaScript-style compiler that lets you write Minecraft datapacks with real control structures, variables, and expressions that actually work.

๐Ÿ“– View Full Documentation - Complete guides, examples, and API reference
๐Ÿ“ฆ View on PyPI - Download and install from PyPI
๐Ÿ”ง VS Code Extension - Syntax highlighting, IntelliSense, and snippets

CI Test Examples Documentation PyPI Release

๐ŸŽฏ MODERN JavaScript-Style MDL Language

MDL uses a modern JavaScript-style language format with real control structures, variables, and expressions:

โœจ MODERN Features

  • ๐ŸŽฏ JavaScript-style syntax with curly braces {} and semicolons ;
  • ๐Ÿ“ Modern comments using // and /* */
  • ๐Ÿ”ข Number variables with var num type (stored in scoreboards)
  • ๐Ÿ”„ Full control structures including if/else if/else, while loops with method selection
  • ๐Ÿ’ฒ Variable substitution with $variable$ syntax
  • ๐Ÿงฎ Expressions with arithmetic operations (+, -, *, /)
  • ๐Ÿ“ฆ Namespace system for modular code organization
  • ๐ŸŽจ VS Code extension with full IntelliSense and snippets
  • ๐Ÿงช Comprehensive testing with E2E validation
  • ๐Ÿ“š Extensive documentation with examples for every feature

๐Ÿ—๏ธ Core Features

  • โœ… Modern pack format 82 by default for latest Minecraft features
  • โœ… JavaScript-style syntax with curly braces and semicolons
  • โœ… Real control structures - if/else if/else, while loops with recursion/schedule methods
  • โœ… Number variables stored in scoreboards with $variable$ substitution
  • โœ… Expressions with arithmetic operations and variable substitution
  • โœ… Multi-file projects with automatic merging and dependency resolution
  • โœ… Variable optimization - automatic load function generation for initialization
  • โœ… Selector optimization - proper @a usage for system commands
  • โœ… Easy hooks into minecraft:tick and minecraft:load via function tags
  • โœ… Tag support for function, item, block, entity_type, fluid, and game_event

Note: Version 12.0+ uses pack_format 82 by default for the modern JavaScript-style syntax.


๐Ÿš€ Install

Option A โ€” from PyPI (recommended for users)

Global, isolated CLI via pipx:

python3 -m pip install --user pipx
python3 -m pipx ensurepath    # reopen terminal
pipx install minecraft-datapack-language

mdl --help

Virtualenv (if you prefer):

python3 -m venv .venv
source .venv/bin/activate      # Windows: .\.venv\Scripts\Activate.ps1
pip install minecraft-datapack-language

Option B โ€” from source (for contributors)

# inside the repo
python -m pip install -e .

๐Ÿ”„ Update

  • pipx: pipx upgrade minecraft-datapack-language
  • pip (venv): pip install -U minecraft-datapack-language
  • Pin a version: pipx install "minecraft-datapack-language==<version>" (replace <version> with desired version)

๐Ÿ’ป CLI

Modern JavaScript-style MDL (v15.0+)

# Build JavaScript-style MDL files
mdl build --mdl my_pack/mypack.mdl -o dist --wrapper mypack
mdl check my_pack/mypack.mdl

# Validate generated mcfunction files
mdl check my_pack/mypack.mdl

# Multi-file projects
mdl build --mdl my_pack/ -o dist      # Build entire directory
mdl build --mdl "file1.mdl file2.mdl" -o dist  # Build specific files

# Create new projects
mdl new my_awesome_pack

๐Ÿ› Comprehensive Error Handling

MDL provides detailed error reporting with exact locations and helpful suggestions:

# Check for errors with detailed output
mdl check my_pack.mdl --verbose

Example Error Output:

Error 1: MDLSyntaxError in test.mdl:15:8
Missing closing brace for if statement
Context:
  13:   if (score > 10) {
  14:     say "High score!"
  15:     score = 0
  16:   }

Suggestion: Add closing brace '}' after line 15

Error 2: MDLLexerError in test.mdl:22:12
Unterminated string literal
Context:
  20:   say "Hello world
  21:   score = 10
  22:   say "Goodbye

Suggestion: Add closing quote '"' at the end of line 20

Error Features:

  • โœ… Exact Location: Line and column numbers for precise error location
  • โœ… Context Lines: Shows surrounding code for better debugging
  • โœ… Helpful Suggestions: Specific fix recommendations
  • โœ… Multiple Error Collection: Reports all errors, not just the first
  • โœ… Error Types: Syntax, Lexer, Parser, Validation, File, Build, and Configuration errors

Comments in MDL

MDL supports modern JavaScript-style comments:

// Single-line comments
/* Multi-line comments */

pack "My Pack" {
    function example() {
        // This comment will be properly converted to mcfunction
        say Hello World!;
    }
}

Generated mcfunction files will have proper # comments:

# This is a generated comment
say Hello World!

Build a whole folder of .mdl files

mdl build --mdl src/ -o dist
# Recursively parses src/**/*.mdl, merges into one pack (errors on duplicate functions).
# Only the first file should have a pack declaration - all others are modules.

Build multiple specific .mdl files

mdl build --mdl "src/core.mdl src/features.mdl src/ui.mdl" -o dist
# Parses multiple specific files and merges them into one datapack.
# Only the first file should have a pack declaration - all others are modules.

Validate a folder (JSON diagnostics)

mdl check --json src/

๐Ÿ“ Quick Start - MODERN MDL

Create your first modern MDL project:

// modern_pack.mdl
pack "Modern Pack" description "A modern example" pack_format 82;

namespace "example";

// Number variables with expressions
var num counter = 0;
var num health = 20;
var num level = 1;
var num experience = 0;

function "init" {
    say Initializing...;
    counter = 0;
    health = 20;
    level = 1;
    experience = 0;
}

function "tick" {
    counter = counter + 1;
    
    // Full if/else if/else control structure
    if "$health$ < 10" {
        say Health is low!;
        health = health + 5;
        effect give @a minecraft:regeneration 10 1;
    } else if "$level$ > 5" {
        say High level player!;
        effect give @a minecraft:strength 10 1;
    } else {
        say Normal player;
        effect give @a minecraft:speed 10 0;
    }
    
    // Variable substitution in strings
    say Counter: $counter$;
    
    // While loop with method selection
    while "$counter$ < 10" {
        counter = $counter$ + 1;
        say Counter: $counter$;
    }
    
    // Expressions with arithmetic
    experience = $level$ * 100 + $counter$;
    say Experience: $experience$;
}

// Lifecycle hooks
on_load "example:init";
on_tick "example:tick";

Build and test:

mdl build --mdl modern_pack.mdl -o dist
# โ†’ dist/modern_pack/... and dist/modern_pack.zip

๐Ÿ“ Multi-file Support

MDL supports building datapacks from multiple .mdl files. This is useful for organizing large projects into logical modules.

How it works

  • Directory scanning: When you pass a directory to --mdl, MDL recursively finds all .mdl files
  • File merging: Each file is parsed into a Pack object, then merged into a single datapack
  • Conflict resolution: Duplicate function names within the same namespace will cause an error
  • Pack metadata: Only the first file should have a pack declaration (name, description, format)
  • Module files: Subsequent files should not have pack declarations - they are treated as modules
  • Single file compilation: When compiling a single file, it must have a pack declaration

Best practices

  • One pack declaration per project: Only the first file should have a pack declaration
  • Module files: All other files should not have pack declarations - they are treated as modules
  • Single file requirement: When compiling a single file, it must have a pack declaration
  • Organize by namespace: Consider splitting files by namespace or feature
  • Use descriptive filenames: core.mdl, combat.mdl, ui.mdl etc.
  • Avoid conflicts: Ensure function names are unique within each namespace

Example project structure

my_datapack/
โ”œโ”€โ”€ core.mdl          # โœ… HAS pack declaration
โ”œโ”€โ”€ combat/
โ”‚   โ”œโ”€โ”€ weapons.mdl   # โŒ NO pack declaration (module)
โ”‚   โ””โ”€โ”€ armor.mdl     # โŒ NO pack declaration (module)
โ”œโ”€โ”€ ui/
โ”‚   โ””โ”€โ”€ hud.mdl       # โŒ NO pack declaration (module)
โ””โ”€โ”€ data/
    โ””โ”€โ”€ recipes.mdl   # โŒ NO pack declaration (module)

Important: Only core.mdl should have a pack "Name" declaration. All other files are modules that merge into the main pack.

Usage Examples

Build from directory:

mdl build --mdl my_datapack/ -o dist

Build from specific files:

mdl build --mdl "core.mdl combat.mdl ui.mdl" -o dist

Check entire project:

mdl check my_datapack/

Check with verbose output:

mdl build --mdl my_datapack/ -o dist --verbose

Complete Multi-File Example

Here's a complete example showing how to organize a datapack across multiple files:

core.mdl (main file with pack declaration):

// core.mdl - Main pack and core systems
pack "Adventure Pack" description "Multi-file example datapack" pack_format 82;

namespace "core";

// Number variables with expressions
var num system_version = 1;
var num player_count = 0;
var num total_experience = 0;

function "init" {
    say [core:init] Initializing Adventure Pack...;
    tellraw @a {"text":"Adventure Pack loaded!","color":"green"};
    system_version = 1;
    player_count = 0;
    total_experience = 0;
}

function "tick" {
    say [core:tick] Core systems running...;
    execute as @a run particle minecraft:end_rod ~ ~ ~ 0.1 0.1 0.1 0.01 1;
    player_count = player_count + 1;
    
    // Control structure example
    if "$player_count$ > 10" {
        say Many players online!;
        effect give @a minecraft:glowing 5 0;
    }
}

// Hook into vanilla lifecycle
on_load "core:init";
on_tick "core:tick";

combat/weapons.mdl (combat module):

// combat/weapons.mdl - Weapon-related functions
namespace "combat";

var num weapon_damage = 10;
var num critical_chance = 5;

function "weapon_effects" {
    say [combat:weapon_effects] Applying weapon effects...;
    execute as @a[nbt={SelectedItem:{id:'minecraft:diamond_sword'}}] run effect give @s minecraft:strength 1 0 true;
    weapon_damage = weapon_damage + 2;
    
    // Expression example
    critical_chance = $weapon_damage$ / 2;
}

function "update_combat" {
    function core:tick;
    function combat:weapon_effects;
}

combat/armor.mdl (armor module):

// combat/armor.mdl - Armor-related functions
namespace "combat";

var num armor_bonus = 5;
var num defense_rating = 0;

function "armor_bonus" {
    say [combat:armor_bonus] Checking armor bonuses...;
    execute as @a[nbt={Inventory:[{Slot:103b,id:"minecraft:diamond_helmet"}]}] run effect give @s minecraft:resistance 1 0 true;
    armor_bonus = armor_bonus + 1;
    
    // Expression with multiple variables
    defense_rating = $armor_bonus$ * 2 + 10;
}

function "update_armor" {
    function combat:armor_bonus;
}

ui/hud.mdl (UI module):

// ui/hud.mdl - User interface functions
namespace "ui";

var num hud_version = 1;
var num display_counter = 0;

function "show_hud" {
    say [ui:show_hud] Updating HUD...;
    title @a actionbar {"text":"Adventure Pack Active","color":"gold"};
    hud_version = hud_version + 1;
    
    // While loop example
    while "$display_counter$ < 5" {
        display_counter = $display_counter$ + 1;
        say HUD update: $display_counter$;
    }
}

function "update_ui" {
    function ui:show_hud;
    function combat:update_combat;
    function combat:update_armor;
}

Project structure:

adventure_pack/
โ”œโ”€โ”€ core.mdl              # โœ… HAS pack declaration
โ”œโ”€โ”€ combat/
โ”‚   โ”œโ”€โ”€ weapons.mdl       # โŒ NO pack declaration (module)
โ”‚   โ””โ”€โ”€ armor.mdl         # โŒ NO pack declaration (module)
โ””โ”€โ”€ ui/
    โ””โ”€โ”€ hud.mdl           # โŒ NO pack declaration (module)

Build the project:

mdl build --mdl adventure_pack/ -o dist --verbose

This will create a datapack with:

  • Core systems (initialization and tick functions)
  • Combat features (weapon and armor effects)
  • UI elements (HUD display)
  • Cross-module calls (UI calls combat functions)
  • Variable optimization (automatic load function generation)

CLI Options for Multi-file Builds

  • --mdl <path>: Path to .mdl file, directory, or space-separated file list
  • --src <path>: Alias for --mdl (same functionality)
  • -o, --out <dir>: Output directory for the built datapack
  • --wrapper <name>: Custom wrapper folder/zip name (default: first namespace or pack name slug)
  • --pack-format <N>: Minecraft pack format (default: 82 for modern syntax)
  • -v, --verbose: Show detailed processing information including file merging
  • --py-module <path>: Alternative: build from Python module with create_pack() function

Error Handling

  • Missing pack declaration: Single files must have a pack declaration
  • Duplicate pack declarations: Only the first file in a multi-file project should have a pack declaration
  • Function conflicts: Duplicate function names within the same namespace will cause an error
  • Clear error messages: Errors include file paths and line numbers for easy debugging

๐ŸŽฏ Advanced Multi-File Examples with Namespaces

Modern Namespace System

MDL's namespace system allows you to organize code across multiple files with proper separation:

game.mdl - Core Game Logic:

pack "multi_game" "A multi-file game example" 82;

namespace "game";

var num player_score = 0;
var num game_timer = 0;
var num health = 20;

function "main" {
    // If-else if-else chain
    if "$health$ < 10" {
        say "Health is low: $health$";
        health = $health$ + 5;
    } else if "$health$ > 15" {
        say "Health is good: $health$";
    } else {
        say "Health is moderate: $health$";
    }
    
    // While loop with counter
    while "$game_timer$ < 5" {
        game_timer = $game_timer$ + 1;
        say "Game Timer: $game_timer$";
    }
}

function "score_update" {
    player_score = $player_score$ + 10;
    say "Score updated: $player_score$";
}

on_tick "game:main";

ui.mdl - User Interface:

namespace "ui";

var num menu_state = 0;
var num selected_option = 1;

function "main" {
    // Show menu based on state
    if "$menu_state$ == 0" {
        say "=== Main Menu ===";
        say "1. Start Game";
        say "2. Options";
        say "3. Exit";
    }
    
    // Handle selection
    if "$selected_option$ == 1" {
        say "Starting game...";
    } else if "$selected_option$ == 2" {
        say "Opening options...";
    } else if "$selected_option$ == 3" {
        say "Exiting...";
    }
}

function "button_handler" {
    var num button_id = 0;
    
    if "$button_id$ == 1" {
        selected_option = 1;
        say "Option 1 selected";
    } else if "$button_id$ == 2" {
        selected_option = 2;
        say "Option 2 selected";
    }
}

on_load "ui:main";

combat.mdl - Combat System:

namespace "combat";

var num enemy_count = 5;
var num damage = 0;

function "main" {
    var num total_damage = 0;
    total_damage = $damage$ * 2;
    
    if "$total_damage$ > 20" {
        say "Critical hit! Damage: $total_damage$";
    } else {
        say "Normal hit. Damage: $total_damage$";
    }
    
    // Variable substitution in tellraw
    tellraw @a [{"text":"Enemy Count: "},{"score":{"name":"@a","objective":"enemy_count"}}];
}

on_tick "combat:main";

Build and Generated Structure

# Build all files together
mdl build --mdl . -o dist

# Or build specific files
mdl build --mdl "game.mdl ui.mdl combat.mdl" -o dist

Generated Structure:

dist/
โ”œโ”€โ”€ data/
โ”‚   โ”œโ”€โ”€ minecraft/tags/function/
โ”‚   โ”‚   โ”œโ”€โ”€ load.json    # Contains all load functions
โ”‚   โ”‚   โ””โ”€โ”€ tick.json    # Contains all tick functions
โ”‚   โ”œโ”€โ”€ game/            # game.mdl namespace
โ”‚   โ”‚   โ””โ”€โ”€ function/
โ”‚   โ”‚       โ”œโ”€โ”€ main.mcfunction
โ”‚   โ”‚       โ””โ”€โ”€ score_update.mcfunction
โ”‚   โ”œโ”€โ”€ ui/              # ui.mdl namespace
โ”‚   โ”‚   โ””โ”€โ”€ function/
โ”‚   โ”‚       โ”œโ”€โ”€ main.mcfunction
โ”‚   โ”‚       โ””โ”€โ”€ button_handler.mcfunction
โ”‚   โ””โ”€โ”€ combat/          # combat.mdl namespace
โ”‚       โ””โ”€โ”€ function/
โ”‚           โ””โ”€โ”€ main.mcfunction
โ””โ”€โ”€ pack.mcmeta

Key Benefits of Namespace System

  • โœ… No function name conflicts - Each namespace is completely separate
  • โœ… Modular development - Work on different features in separate files
  • โœ… Automatic merging - All variables and functions are combined intelligently
  • โœ… Proper initialization - Variables are automatically set up in load functions
  • โœ… Clean organization - Each module has its own directory structure
  • โœ… Easy maintenance - Update individual modules without affecting others

Complete Example Project

Check out the examples/multi_file_example/ directory for a complete working example with:

  • Multiple namespaces (test, other, ui)
  • Various control structures and expressions
  • Comprehensive documentation
  • Ready-to-build files

๐Ÿ“ The MODERN .mdl Language

Grammar you can rely on (based on the parser)

  • pack header (required once):
    pack "Name" [description "Desc"] [pack_format N];
    
  • namespace (selects a namespace for following blocks):
    namespace "example";
    
  • number variable declarations (only num type supported):
    var num counter = 0;
    var num health = 20;
    var num level = 1;
    
  • function (curly braces + semicolons):
    function "hello" {
        say hi;
        tellraw @a {"text":"ok","color":"green"};
    }
    
  • full conditional blocks (if/else if/else statements):
    function "conditional" {
        if "$health$ < 10" {
            say Health is low!;
            effect give @s minecraft:glowing 5 1;
        } else if "$level$ > 5" {
            say High level player!;
            effect give @s minecraft:speed 5 1;
        } else {
            say Normal player;
            effect give @s minecraft:jump_boost 5 0;
        }
    }
    
  • while loops (repetitive execution with method selection):
    function "countdown" {
        var num counter = 5;
        while "$counter$ > 0" {
            say Counter: $counter$;
            counter = counter - 1;
        }
        
        // Schedule method for performance
        counter = 10;
        while "$counter$ > 0" method="schedule" {
            say Schedule counter: $counter$;
            counter = $counter$ - 1;
        }
    }
    
  • expressions (arithmetic operations):
    function "expressions" {
        var num a = 10;
        var num b = 5;
        var num result = $a$ + $b$ * 2;
        say Result: $result$;
    }
    
  • function calls (one function invoking another with fully qualified ID):
    function "outer" {
        say I will call another function;
        function example:hello;
    }
    
  • hooks (namespaced ids required):
    on_load "example:hello";
    on_tick "example:hello";
    
  • tags (supported registries: function, item, block, entity_type, fluid, game_event):
    tag function "minecraft:tick" {
        add "example:hello";
    }
    
  • comments start with // or /* */. Hashes inside quoted strings are preserved.
  • whitespace: empty lines are ignored; explicit block boundaries using curly braces { and }; statement termination using semicolons ;.

Inside a function block, every non-empty line is emitted almost verbatim as a Minecraft command. Comments are stripped out and multi-line commands are automatically wrapped. See below for details.

Comments

MDL supports modern JavaScript-style comments:

  • Full-line comments (a line starting with //) are ignored by the parser.
  • Block comments (/* */) are supported for multi-line comments.
  • Inline # characters are preserved inside function bodies, so you can still use them the way mcfunction normally allows.

Example:

// Comment Demo - Testing comments
pack "Comment Demo" description "Testing comments";

namespace "demo";

function "comments" {
    // This whole line is ignored by MDL
    say Hello; // This inline comment is preserved
    tellraw @a {"text":"World","color":"blue"}; // Inline too!
    
    /* This is a block comment
       that spans multiple lines
       and is ignored by the parser */
}

When compiled, the resulting function looks like:

say Hello # This inline comment is preserved
tellraw @a {"text":"World","color":"blue"} # Inline too!

Notice how the full-line // and block comments never make it into the .mcfunction, but the inline ones do.


MODERN Variables and Data Types

MDL supports number variables with expressions and arithmetic operations:

Number Variables (num)

var num counter = 0;
var num health = 20;
var num experience = 100;

// Arithmetic operations
counter = counter + 1;
health = health - 5;
experience = experience * 2;

// Expressions with multiple variables
var num total = $health$ + $experience$;
var num average = $total$ / 2;

// Variable substitution in strings
say Health: $health$;
say Experience: $experience$;
say Total: $total$;

Variable Substitution: Use $variable_name$ to read values from scoreboards in strings and conditions.

Expressions: Support for arithmetic operations (+, -, *, /) with proper order of operations.

MODERN Control Flow

MDL supports full conditional blocks and loops for control flow.

Conditional Blocks

MDL supports complete if/else if/else statements for conditional execution:

function "conditional_example" {
    var num player_level = 15;
    var num player_health = 8;
    var num player_experience = 1000;
    
    if "$player_level$ >= 10" {
        if "$player_health$ < 10" {
            say Advanced player with low health!;
            effect give @s minecraft:regeneration 10 1;
            player_health = $player_health$ + 10;
        } else {
            say Advanced player with good health;
            effect give @s minecraft:strength 10 1;
        }
    } else if "$player_level$ >= 5" {
        say Intermediate player;
        effect give @s minecraft:speed 10 0;
    } else {
        say Beginner player;
        effect give @s minecraft:jump_boost 10 0;
    }
    
    // Expression in condition
    if "$player_experience$ > $player_level$ * 100" {
        say High experience for level!;
    }
}

Rules:

  • Conditions use $variable$ syntax for variable substitution
  • Explicit block boundaries: Conditional blocks use curly braces { and }
  • Statement termination: All commands must end with semicolons ;
  • You can have multiple else if blocks
  • The else block is optional
  • Conditional blocks are compiled to separate functions and called with execute commands
  • Proper logic: else if blocks only execute if previous conditions were false
  • Expressions in conditions: Support for arithmetic operations in conditions

While Loops

MDL supports while loops with method selection for repetitive execution:

function "while_example" {
    var num counter = 5;
    
    // Default recursion method (immediate execution)
    while "$counter$ > 0" {
        say "Counter: $counter$";
        counter = $counter$ - 1;
    }
    
    // Schedule method (spreads across ticks for performance)
    counter = 10;
    while "$counter$ > 0" method="schedule" {
        say "Schedule counter: $counter$";
        counter = $counter$ - 1;
    }
    
    // Expression in loop condition
    var num max_count = 5;
    counter = 0;
    while "$counter$ < $max_count$ * 2" {
        say "Expression counter: $counter$";
        counter = $counter$ + 1;
    }
}

Rules:

  • Conditions use $variable$ syntax for variable substitution
  • Explicit block boundaries: While loops use curly braces { and }
  • Statement termination: All commands must end with semicolons ;
  • While loops continue until the condition becomes false
  • Method Selection: Choose method="recursion" (default) or method="schedule"
  • Recursion method: Executes all iterations immediately (good for small loops)
  • Schedule method: Spreads iterations across ticks (better for long loops, prevents lag)
  • Important: Ensure your loop body modifies the condition to avoid infinite loops
  • Expressions in conditions: Support for arithmetic operations in loop conditions

Implementation: While loops generate separate function files with proper recursive calls to continue execution until the condition becomes false.


Multi-line Commands

Long JSON commands can be split across multiple lines with a trailing backslash \.
MDL will join them back together before writing the final .mcfunction.

Example:

// Multi-line Demo
pack "Multi-line Demo";

namespace "demo";

function "multiline" {
    tellraw @a \
        {"text":"This text is really, really long so we split it",\
         "color":"gold"};
}

When compiled, the function is a single line:

tellraw @a {"text":"This text is really, really long so we split it","color":"gold"}

๐ŸŽฏ MODERN example (control structures + variables + expressions)

// modern_pack.mdl - modern example for Minecraft Datapack Language
pack "Modern Pack" description "Modern example datapack" pack_format 82;

namespace "example";

// Number variables with expressions
var num counter = 0;
var num health = 20;
var num level = 1;
var num experience = 0;

function "inner" {
    say [example:inner] This is the inner function;
    tellraw @a {"text":"Running inner","color":"yellow"};
    counter = counter + 1;
}

function "hello" {
    say [example:hello] Outer says hi;
    function example:inner;
    tellraw @a {"text":"Back in hello","color":"aqua"};
    
    // Variable operations with expressions
    health = health + 5;
    level = level + 1;
    experience = $level$ * 100 + $counter$;
    
    // Variable substitution
    say Health: $health$;
    say Level: $level$;
    say Experience: $experience$;
    
    // Full control structures
    if "$health$ > 15" {
        say High health!;
        effect give @s minecraft:strength 10 1;
    } else if "$level$ > 5" {
        say High level!;
        effect give @s minecraft:speed 10 1;
    } else {
        say Normal stats;
        effect give @s minecraft:jump_boost 10 0;
    }
    
    // While loop with method selection
    while "$counter$ < 5" {
        say Counter: $counter$;
        counter = counter + 1;
    }
    
    // Expression in condition
    if "$experience$ > $level$ * 50" {
        say High experience for level!;
    }
}

// Hook the function into load and tick
on_load "example:hello";
on_tick "example:hello";

// Second namespace with a cross-namespace call
namespace "util";

var num helper_count = 0;
var num total_help = 0;

function "helper" {
    say [util:helper] Helping out...;
    helper_count = helper_count + 1;
    total_help = $helper_count$ * 10;
    say Helper count: $helper_count$;
    say Total help: $total_help$;
}

function "boss" {
    say [util:boss] Calling example:hello then util:helper;
    function example:hello;
    function util:helper;
}

// Run boss every tick as well
on_tick "util:boss";

// Function tag examples
tag function "minecraft:load" {
    add "example:hello";
}

tag function "minecraft:tick" {
    add "example:hello";
    add "util:boss";
}

// Data tag examples across registries
tag item "example:swords" {
    add "minecraft:diamond_sword";
    add "minecraft:netherite_sword";
}

tag block "example:glassy" {
    add "minecraft:glass";
    add "minecraft:tinted_glass";
}

What this demonstrates

  • Nested-like function composition (function example:inner inside function "hello").
  • Multiple namespaces (example, util) calling each other with fully-qualified IDs.
  • Lifecycle hooks (on_load, on_tick) on both example:hello and util:boss.
  • Function tags to participate in vanilla tags (minecraft:load, minecraft:tick).
  • Data tags (item, block) in addition to function tags.
  • Number variables with $variable$ substitution.
  • Expressions with arithmetic operations and variable substitution.
  • Full control structures - if/else if/else, while loops with method selection.
  • Modern syntax with curly braces and semicolons.
  • Variable optimization - automatic load function generation.

๐Ÿ Python API equivalent

from minecraft_datapack_language import Pack

def build_pack():
    p = Pack(name="Modern Pack",
             description="Modern example datapack",
             pack_format=82)

    ex = p.namespace("example")
    ex.function("inner",
        'say [example:inner] This is the inner function',
        'tellraw @a {"text":"Running inner","color":"yellow"}'
    )
    ex.function("hello",
        'say [example:hello] Outer says hi',
        'function example:inner',
        'tellraw @a {"text":"Back in hello","color":"aqua"}'
    )

    # Hooks for example namespace
    p.on_load("example:hello")
    p.on_tick("example:hello")

    util = p.namespace("util")
    util.function("helper",
        'say [util:helper] Helping out...'
    )
    util.function("boss",
        'say [util:boss] Calling example:hello then util:helper',
        'function example:hello',
        'function util:helper'
    )

    # Tick hook for util namespace
    p.on_tick("util:boss")

    # Function tags
    p.tag("function", "minecraft:load", values=["example:hello"])
    p.tag("function", "minecraft:tick", values=["example:hello", "util:boss"])

    # Data tags
    p.tag("item",  "example:swords", values=["minecraft:diamond_sword", "minecraft:netherite_sword"])
    p.tag("block", "example:glassy", values=["minecraft:glass", "minecraft:tinted_glass"])

    return p

Build it:

python - <<'PY'
from my_pack_module import build_pack
from minecraft_datapack_language.cli import main as M
# write to dist/ with a wrapper folder name 'mypack'
p = build_pack()
M(['build', '--py-object', 'my_pack_module:build_pack', '-o', 'dist', '--wrapper', 'mypack', '--pack-format', '82'])
PY

๐Ÿ”ง Development System

MDL includes a comprehensive development system that allows you to work with both stable and development versions simultaneously.

Quick Setup

Linux/macOS:

./scripts/dev_setup.sh

Windows (PowerShell):

.\scripts\dev_setup.ps1

Development Commands

  • mdl - Stable, globally installed version
  • mdlbeta - Local development version for testing changes

Development Workflow

  1. Make changes to the code
  2. Rebuild the development version:
    ./scripts/dev_build.sh
    
  3. Test your changes with mdlbeta:
    mdlbeta build --mdl your_file.mdl -o dist
    
  4. Compare with stable version:
    mdl build --mdl your_file.mdl -o dist_stable
    

Testing

Test the development environment:

# Linux/macOS
./scripts/test_dev.sh

# Windows (PowerShell)
.\scripts\test_dev.ps1

For more details, see DEVELOPMENT.md.

๐Ÿ”ง VS Code Extension

Get syntax highlighting, error checking, and build commands for .mdl files in VS Code, Cursor, and other VS Code-based editors.

Quick Install

  1. Download from GitHub Releases
  2. Install the .vsix file:
    • Open VS Code/Cursor
    • Go to Extensions (Ctrl+Shift+X)
    • Click "..." โ†’ "Install from VSIX..."
    • Choose the downloaded .vsix file

Features

  • Syntax highlighting for .mdl files
  • Real-time error checking with error detection
  • Build commands: MDL: Build current file and MDL: Check Workspace
  • Workspace validation for multi-file projects
  • Server function support: Proper @a selector usage for tag-called functions

Development Setup

cd vscode-extension/
npm i
# Press F5 to launch the Extension Dev Host

๐Ÿš€ CI & Releases

  • CI runs on push/PR across Linux/macOS/Windows and uploads artifacts.
  • Release is triggered by pushing a tag like v1.0.0 or via the Release workflow manually.
  • Versions are derived from git tags via setuptools-scm; tag vX.Y.Z โ†’ package version X.Y.Z.

Local release helper

# requires GitHub CLI: gh auth login
./scripts/release.sh patch  "Fixes"
./scripts/release.sh minor  "Features"
./scripts/release.sh major  "Breaking"
./scripts/release.sh v1.2.3 "Exact version"

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

minecraft_datapack_language-15.1.46.tar.gz (7.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

minecraft_datapack_language-15.1.46-py3-none-any.whl (75.1 kB view details)

Uploaded Python 3

File details

Details for the file minecraft_datapack_language-15.1.46.tar.gz.

File metadata

File hashes

Hashes for minecraft_datapack_language-15.1.46.tar.gz
Algorithm Hash digest
SHA256 fb91427cfdd4c31286a8ff17315a1bfdb59d11060dbcb912957b7e206c565cac
MD5 fc69829df6ce972b651b86ae0c21642a
BLAKE2b-256 e06b424f97a63dff3a328d78ec537892bd2cdb94294591e5a555e46cc52589f3

See more details on using hashes here.

File details

Details for the file minecraft_datapack_language-15.1.46-py3-none-any.whl.

File metadata

File hashes

Hashes for minecraft_datapack_language-15.1.46-py3-none-any.whl
Algorithm Hash digest
SHA256 0e3c013595a03cfaa22e5737c103d84bbb4a44560ae078773012734ac4b9dfbb
MD5 ce41d892a6b3fe84cbf9c33dbacfb027
BLAKE2b-256 8caa5290caa26ade24d804b9407a335706cba3c6ac45dd82d4e7f743d78f337f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page