Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

A python framework for building Minecraft data packs

Project description

endermite

Build Status PyPI Version Python Version

Endermite is a python framework for building Minecraft data packs.

:construction: This is a huge work in progress :construction:

Installation

Make sure that you're using python 3.6 or above. You can install endermite with pip.

$ pip install endermite

You can check that endermite is correctly installed by trying to use the command-line interface shipped with the package.

$ ender --version

Using endermite

Setup

Endermite allows you to manage a data pack using python code. The first thing that you need to do is to set up an endermite project in a Minecraft world.

Using a terminal, go to your saves folder and choose a world to setup your project into. You can then setup your project by running the ender init command inside of a world folder.

$ ender init
endermite vX.X.X

Creating endermite project.

Project name [endermite_playground]:
Project description [My awesome endermite project]:
Project author [none]:
Project version [0.1.0]:

About to write to .../.minecraft/saves/endermite_playground/@endermite/config.json:

{
    "name": "endermite_playground",
    "description": "My awesome endermite project",
    "id": "IO0f3as_",
    "author": "none",
    "version": "0.1.0"
}


Is this ok? [Y/n]:
Done!

After running the command, you should see a folder called @endermite inside of the world folder with a python file and a config.json file inside of it.

Build

Once your project is set up, you can build it by using the ender build command inside of the world folder.

$ ender build

The command will create a data pack with the same name as your project inside of the world's datapacks folder. If you don't want to run the command manually each time you change something in the project you can use the --watch flag.

$ ender build --watch

The program will now rebuild the project when it detects changes in the @endermite directory.

Contributing

Contributions are welcome. To run the tests, make sure that tox is installed in your virtual environment.

$ pip install tox

You should now be able to run the tests with tox.

$ tox

License - MIT

Project details


Release history Release notifications

This version
History Node

0.1.4

History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
endermite-0.1.4-py3-none-any.whl (15.9 kB) Copy SHA256 hash SHA256 Wheel py3 Apr 21, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page