https://github.com/terrafirmacraft/field-guide

A transliteration of the TerraFirmaCraft Field Guide to an online format.
https://github.com/terrafirmacraft/field-guide

Last synced: about 2 months ago
JSON representation

A transliteration of the TerraFirmaCraft Field Guide to an online format.

• Host: GitHub
• URL: https://github.com/terrafirmacraft/field-guide
• Owner: TerraFirmaCraft
• License: eupl-1.2
• Created: 2022-08-04T13:20:39.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-03T22:12:28.000Z (2 months ago)
• Last Synced: 2024-11-03T23:16:51.881Z (2 months ago)
• Language: Python
• Homepage:
• Size: 17.1 MB
• Stars: 7
• Watchers: 1
• Forks: 15
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [TerraFirmaCraft Field Guide](https://terrafirmacraft.github.io/Field-Guide/en_us/)

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

### Development

```bash

# 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"

```