Add docs and example for standalone model rendering

Author: object-Object

examples/model_rendering/.gitignore

@@ -0,0 +1,162 @@
+# hexdoc
+out/
+.hexdoc*/
+out.png
+
+# Python
+
+.ruff_cache/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/

examples/model_rendering/README.md

@@ -0,0 +1,3 @@
+# Model Rendering
+
+https://hexdoc.hexxy.media/docs/guides/standalone/model-rendering

examples/model_rendering/hexdoc.toml

@@ -0,0 +1,18 @@
+#:schema https://hexdoc.hexxy.media/schema/hexdoc/core/Properties.json
+
+modid = "hexdoc"
+
+resource_dirs = [
+    "resources",
+    { glob="mods/*.jar" },
+    { modid="minecraft" },
+    { modid="hexdoc" },
+]
+
+export_dir = "out/export"
+
+[textures]
+strict = false
+missing = [
+    "emi:*",
+]

examples/model_rendering/mods/hexcasting-fabric-1.19.2-0.10.3.jar

@@ -0,0 +1,2 @@
+hexdoc~=1!0.1.0a15
+hexdoc-minecraft~=1.19.2.0

examples/model_rendering/requirements.txt

@@ -0,0 +1,3 @@
+{
+    "parent": "minecraft:block/stone"
+}

examples/model_rendering/resources/assets/example/models/item/example_item.json

@@ -0,0 +1,40 @@
+# Model Rendering
+
+hexdoc includes a fairly advanced module for rendering block models. It runs by default when building a web book, but you can also use it as a standalone tool with a bit of configuration.
+
+For a complete example, see [examples/model_rendering](https://github.com/hexdoc-dev/hexdoc/tree/main/examples/model_rendering) in hexdoc's GitHub repo.
+
+## Steps
+
+1. In a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments), install the following Python packages:
+   * `hexdoc>=1!0.1.0a15`
+   * `hexdoc-minecraft~={GAME_VERSION}.0` (eg. `hexdoc-minecraft~=1.19.2.0`)
+2. Create a [`hexdoc.toml` config file](../configuration):
+
+    ```toml title="hexdoc.toml"
+    #:schema https://hexdoc.hexxy.media/schema/hexdoc/core/Properties.json
+
+    # for standalone model rendering, just leave this as "hexdoc"
+    modid = "hexdoc"
+
+    resource_dirs = [
+        # path(s) to "resources" folders, resource packs, and/or mod jars where your models and textures are located
+        "resources",
+        { glob="mods/*.jar" },
+        # required if your models depend on vanilla resources
+        { modid="minecraft" },
+        { modid="hexdoc" },
+    ]
+
+    # folder where loaded resources (not rendered models) should be copied to
+    export_dir = "out/export"
+
+    [textures]
+    strict = false
+    missing = [
+        # add item/block/model IDs to ignore missing or broken models
+        "emi:*",
+    ]
+    ```
+
+3. To render all available models, run this command: `hexdoc render-models --all`

web/docusaurus/docs/03-guides/05-standalone/01-model-rendering.md

@@ -0,0 +1,4 @@
+label: Standalone Usage
+link:
+  type: generated-index
+  description: How to use hexdoc as a standalone tool without setting up a Patchouli web book.