Welcome to ValveSMD's documentation!
====================================

.. license
.. image:: https://img.shields.io/badge/License-GPLv3-blue.svg
   :target: https://github.com/pySourceSDK/ValveSMD/blob/master/LICENSE.txt

.. Python versions
.. image:: https://img.shields.io/pypi/pyversions/valvesmd.svg
   :target: https://pypi.python.org/pypi/valvesmd/

.. Platforms
.. image:: https://img.shields.io/badge/platform-Linux,_MacOS,_Windows-blue
   :target: https://pypi.python.org/pypi/valvesmd/

.. Pypi version
.. image:: https://badge.fury.io/py/valvesmd.svg
   :target: https://pypi.python.org/pypi/valvesmd/

.. CI status
.. image:: https://github.com/pySourceSDK/ValveSMD/actions/workflows/CI.yml/badge.svg
   :target: https://github.com/pySourceSDK/ValveSMD/actions

.. Coverage
.. image:: coverage.svg

ValveSMD is a Python library for parsing .smd files for the Source Engine. It provides ways to read, modify and write smd files as well as some utilities for basic transformations (translation, scaling, mirroring and more).

User Guides
-----------

Get yourself up and running quickly.

.. toctree::
   :maxdepth: 2

   quickstart

API
---

.. toctree::
   :maxdepth: 2

   api_ref

Contributing
------------

Few things to know before diving in the code.

.. toctree::
   :maxdepth: 2

   contributing