.. cs-board-tools documentation master file, created by
   sphinx-quickstart on Thu Dec  7 16:07:29 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

cs-board-tools documentation
============================


**cs-board-tools** is a Python library that allows loading and validating user content that is compatible with Fortune Avenue and Custom Street Map Manager (CSMM). Check out the :doc:`usage` section for further information.

.. note::

   This project is under active development. As such, you might encounter bugs. If you see any strange behavior, please `report <https://github.com/fortunestreetmodding/cs-board-tools/issues/>`_ it! Doing so will help us find and fix as many issues as possible.

What would you like to do?
--------------------------

.. _cards-clickable-rst:

.. card:: Load a Board
   :link: ./usage.html#loading-boards

   Loading a board for value comparison, or just to gather data about the boards available.

.. card:: Validate a Board
   :link: ./usage.html#validating-boards

   Validate a board to ensure it meets Custom Street standards. It's no fun when someone's game crashes due to a misconfiguration.

.. toctree::
   :maxdepth: 4
   :caption: Contents:

Indices and tables
------------------

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

Site Map
--------

.. toctree::
   :maxdepth: 4

   home
   getting-started
   usage
   api