OpenBagTwo / AngerLocalBeehive

Prototyping work and data exploration for various Minecraft-related projects
GNU General Public License v3.0
0 stars 0 forks source link
jupyter minecraft nbt notebooks python

AngerLocalBeehive

A repository of Minecraft-related Jupyter notebooks:

Installation and Usage

The notebooks in this repo are intended to be viewed in Github, which has a built-in notebook renderer. As such, you'll be best served treating this notebook as a reference of code examples and not as a repository of actual scripts or running code.

This repo contains no packages or modules, and any custom methods are defined as macros in the notebooks themselves.

That being said...

The development environment for running these notebooks is provided as a conda environment YAML, so the easiest way to run the code in this repo will be to:

  1. Install some conda distribution (I highly recommend mambaforge) and make sure it's configured to pull packages from the conda-forge repository.

  2. Clone or download this repository.

  3. Navigate to the project root and create the execution environment using:

    $ mamba env create

    (substituting conda for mamba if needed)

  4. Activate the environment via

    $ mamba activate beehive

    (again, use conda activate if you're not using mamba)

  5. Set the path to the world you're looking to explore via an environment variable named SAVE_PATH, e.g.

    $ export SAVE_PATH="/home/openbagtwo/.minecraft/saves/New World"
  6. Start Jupyter

    $ jupyter lab

Contributing

This is my own personal notebook repository. If you have code feedback or suggestions, I welcome them (feel free to open an issue), but otherwise I advise creating your own fork.

License

All notebooks in this repository are licensed under GPLv3. If you have a use case for adapting this code that requires a more permissive license, please post an issue, and I'd be more than willing to consider a dual license.