🤝 Contributing¶
Contributions are always welcome!
All the project is using Poetry for dependency management.
Installation¶
Install the project using poetry.
It use poetry to manage the dependencies.
$ git clone https://github.com/edayot/ItemIO.git
$ cd ItemIO
$ poetry install
Datapack¶
The datapack is compiled using the beet.
# Build the datapack
$ make b BUILD_TYPE=release
# Build the datapack in live mode
$ make watch
Env variables
Can be pass or set in the .env file.
BUILD_TYPE:releaseordebug(optional)MINECRAFT_FOLDER: The path to the minecraft folder (required for watch)SAVE_FOLDER: The path to the save folder (required for watch)DATAPACKS_FOLDER: The path to the datapacks folder (required for watch)RESOURCES_PACK_FOLDER: The path to the resourcepacks folder (required for watch)
Example :
MINECRAFT_FOLDER = /mnt/c/Users/erwan/AppData/Roaming/PrismLauncher/instances/Simply\ Optimized\(1\)/.minecraft/
SAVE_FOLDER = $(MINECRAFT_FOLDER)saves/Datapack\ island/
DATAPACKS_FOLDER = $(SAVE_FOLDER)datapacks/
RESOURCES_PACK_FOLDER = $(MINECRAFT_FOLDER)resourcepacks/
Documentation¶
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.