Welcome to ValveMDL's documentation!
====================================

.. image:: https://img.shields.io/github/license/pySourceSDK/ValveMDL.svg
   :target: https://github.com/pySourceSDK/ValveMDL/blob/main/LICENSE
.. image:: https://img.shields.io/pypi/pyversions/valvemdl.svg
   :target: https://pypi.org/project/valvemdl/
.. image:: https://img.shields.io/badge/platform-windows%20%7C%20linux%20%7C%20macos-lightgrey.svg
   :target: https://pypi.org/project/valvemdl/
.. image:: https://img.shields.io/pypi/v/valvemdl.svg
   :target: https://pypi.org/project/valvemdl/
.. image:: https://github.com/pySourceSDK/ValveMDL/actions/workflows/CI.yml/badge.svg
   :target: https://github.com/pySourceSDK/ValveMDL/actions/workflows/CI.yml
.. image:: coverage.svg
   :target: https://github.com/pySourceSDK/ValveMDL

|proj_name| is a python library to read and write ``.mdl`` files, the model
format of the Source engine, along with their ``.vvd`` and ``.vtx`` companions.

.. note::
   |proj_name| is about serialization and nothing else. It will read a model
   apart and put it back together; it will not transform meshes, render
   anything, or convert to other formats.

.. warning::
   |proj_name| is early. The header and the file-set plumbing are in place; the
   rest of the format is being worked through structure by structure. See the
   :ref:`support table<support>` for what is actually readable today.

These pages document the mdl format itself as much as they document the
library. If you never intend to write a line of python, the
:doc:`datastructures` section is still the reference you came for.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   quickstart

.. toctree::
   :maxdepth: 2

   api_ref

.. toctree::
   :maxdepth: 2

   datastructures

.. toctree::
   :maxdepth: 2

   contributing


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`