STF: Documentation

A modular file-format for 3D assets
Intended for (not only) games-development use-cases.

This documentation is hosted at https://docs.stfform.at

🌰 Report Issues

Made with Sphinx and the following plugins:

• myst_parser
• sphinx_copybutton
• sphinx_togglebutton
• sphinx_design
• sphinxext.opengraph
• sphinx-notfound-page

Development Setup

• Either:
  • Use the "Dev Containers" extension to open the project in a container.
  • Create a Python 3.14 venv in the repo directory.
    • Inside the venv run:

      pip install -r requirements.txt
      

• Start a local dev-server:

  sphinx-autobuild --watch . src/ _out/ -c . -a
  

Contributing

Human made contributions via pull-requests are very welcome.

See CONTRIBUTING.md for guidelines.

License

This repository is licensed under CC-BY-4.0 (https://creativecommons.org/licenses/by/4.0/)