Welcome to ValveFGD's documentation!
=====================================

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

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

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

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

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

.. Coverage
.. image:: coverage.svg

ValveFGD is a Python library for parsing .fgd files for the Source Engine level editor Hammer. It provides entity schemas and other level editor configuration information.

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

Get yourself up and running quickly.

.. toctree::
   :maxdepth: 2

   quickstart

Api Reference
-------------

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

.. toctree::
   :maxdepth: 2

   api_ref


Contributing
============

Few things to know before diving in the code.

.. toctree::
   :maxdepth: 2

   contributing