gaia-beet

Beet plugin to generate Minecraft worldgen files

Introduction

Writing density functions in JSON by hand can be tiring and confusing. This package allows you to write them as natural looking expressions.

gaia.df("basic:foo", abs(const(4) ** 3) + ref("basic:bar"))

Installation

The package can be installed with pip.

$ pip install gaia-beet

Getting started

When using with beet, a simple beet.yml is enough:

output: out
pipeline:
  - main

This references a main.py plugin file where the density functions will be defined:

from beet import Context
from gaia_beet import Gaia
from gaia_beet.density_functions import *

def beet_default(ctx: Context):
    gaia = ctx.inject(Gaia)

    blah = slide(const(2))

    foo = gaia.df("basic:foo", abs(const(4) ** 3) + blah)

    gaia.df("basic:bar", blah * foo)

Then install beet and run the watch command:

$ pip install beet
$ beet watch

Contributing

Contributions are welcome. Make sure to first open an issue discussing the problem or the new feature before creating a pull request. The project uses poetry.

$ poetry install

You can run the tests with poetry run pytest.

$ poetry run pytest

The project must type-check with pyright. If you're using VSCode the pylance extension should report diagnostics automatically. You can also install the type-checker locally with npm install and run it from the command-line.

$ npm run watch
$ npm run check

The code follows the black code style. Import statements are sorted with isort.

$ poetry run isort gaia_beet examples tests
$ poetry run black gaia_beet examples tests
$ poetry run black --check gaia_beet examples tests

License - MIT