Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 1.06 KB

README.md

File metadata and controls

32 lines (23 loc) · 1.06 KB

A transpilation of the TerraFirmaCraft Field Guide - the in-game documentation book - to an online format.

Development

# Setup python dependencies
$ pip install -r requirements.txt

# Clone TerraFirmaCraft/TerraFirmaCraft into a folder /path/to/tfc
$ python src/main.py --tfc-dir /path/to/tfc [--debug]

# Launch a webserver with python for testing
# View the file at `localhost:8000`
# Viewing as a file will mostly work too
$ cd out
$ python -m http.server 8000

# Include Minecraft data (stored locally in /.cache) and Addons (stored locally in /addons)
$ python src/main.py ... --use-mcmeta --use-addons

# Include the old versions (stored in /assets/versions)
$ python src/main.py ... --copy-existing-versions

# For 'old' local versions
# When generating an old version to commit
$ python src/main.py ... --out-dir assets/versions/ --root-dir "Field-Guide" --old-version-key "20"

# When generating an old version to test / view
$ python src/main.py ... --old-version-key "20"