Head Hunter

A package for customizing Vanilla Tweaks' Wandering Trades data pack to stock everyone's favorite ex-nitwit with your own personalized list of custom player heads.

Installation and Setup

This package is compatible with Python 3.10 or newer. The only dependency required outside the standard library is Requests, which is included by default in many distributions and which is readily available from most system package managers as python-requests (or python3-requests for Debian/Ubuntu). As a fallback, you can always install it via pip: 

$ python3 -m pip install requests

To get started, it's recommended that you clone this repo to your computer:

git clone https://github.com/OpenBagTwo/head-hunter -–depth 1

You'll also need to grab yourself a copies of the Vanilla Tweaks data packs.

  1. Go to the Vanilla Tweaks data packs page
  2. Under "Hermitcraft," select "More Mob Heads" and "Wandering Trades (Hermit Edition)"
  3. Download the zip archive and extract the "UNZIP_ME" parent zip file into the "packs" folder.

Usage

The head_hunter package consists of four modules:

  1. extract, which extracts files from existing data packs
  2. parse, which parses head configurations from data pack functions and /give commands
  3. write, which write the various data pack files
  4. release, which bundles everything up into a handy zip file

You can grab information about the methods in each module using the help() function, or you can browse the API documentation online.

There's also a handy end-to-end tutorial that you can even run interactively in Jupyter.

Or if you'd prefer, you can follow along with this video tutorial: Video Tutorial

Contributing

A development environment is provided in the form of a conda environment.yml file. I highly recommend the mambaforge distribution of conda.

For ease of style-guide enforcement, a pre-commit configuration has been provided.

Documentation is automatically built on every push to the main branch. To preview them locally, run mkdocs serve from the repo root.

License

The head_hunter package and its contents are licensed under the GNU Public License v3. Any data packs produced by this package must be licensed under Vanilla Tweaks' terms of use.