Skip to main content

A prototype command-line tool for creating datapacks.

Project description

PyMDFL Package

A command-line application to generate data packs based on CRISPYrice's MDFL specification.

Installation

Install with pip: python -m pip install mdfl

If pip doesn't add the package to PATH correctly, you can start the program with python -m mdfl.

Usage

mdfl --help will output usage information:

PyMDFL: A command-line tool for parsing MDFL and generating Data Packs.

Usage:
    mdfl <script> [--output=<path>]
    mdfl <script> [--tree]
    mdfl -h | --help
    mdfl -V | --version

Options:
    -h --help        Show this screen.
    -V --version     Show version.
    --output=<path>  Output path for the datapack.
    --tree           Print a syntax tree without compiling.

The <script> argument specifies a file that conforms to the MDFL spec. For example, given a file gems.mdfl:

namespace diamonds {
  // Namespace for obtaining diamonds.

  fun get {
    // Give the caller a diamond.
    give @s minecraft:diamond;
  }
}

namespace emeralds {
  // Namespace for obtaining emeralds.

  fun get {
    // Give the caller an emerald.
    give @s minecraft:emerald;
  }
}

Run mdfl gems.mdfl and enter a description for your data pack.

$ mdfl gems.mdfl
Description of gems: All your gems are belong to @s

This will generate a zip file gems.zip with the following structure:

├── data
│  ├── emeralds
│  │  └── functions
│  │     └── get.mcfunction
│  └── diamonds
│     └── functions
│        └── get.mcfunction
└── pack.mcmeta

Project details


Download files

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

Source Distribution

mdfl-0.3.tar.gz (5.5 kB view hashes)

Uploaded Source

Built Distribution

mdfl-0.3-py3-none-any.whl (7.3 kB view hashes)

Uploaded Python 3

Supported by

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