🤝 Contributing¶

Contributions are always welcome!

All the project is using uv for dependency management.

Installation¶

Install the project using uv.

It use uv to manage the dependencies.

$ git clone https://github.com/edayot/ItemIO.git
$ cd ItemIO
$ uv sync --group dev

The datapack is compiled using the beet.

# Build the datapack
$ uv run beet

# Build the datapack in live mode
$ uv run beet watch

The documentation is built using Sphinx.

This script will host a live server on http://localhost:8000/.

$ cd docs/
$ make livehtml

The documentaion use the bolt format for mcfunction. That allow for multiline commands & nested commands.

The parser also support the SNBT format for syntax highlighting.