YOMI Hustle Modding Docs
========================

.. warning:: These docs are currently - vary much - at a *beta stage*, meaning **some pages may not be finished yet!**
             Please bare with us as we update these pages. 

             If you want to help speed up this process, visit our :ref:`Contributing Guide <ydoc-contributing-guide>` and help by **contributing**!

Welcome to the Unofficial Documentation for *Modding* the game, `Your Only Move is Hustle <https://store.steampowered.com/app/2212330/Your_Only_Move_Is_HUSTLE/>`_!

Check the **Table of Contents** on the *sidebar* to get a glimpse on what you can read.

.. TODO: Make this a table like the Godot Docs
..

 * Haven't made a Mod before? :ref:`Get Started here <ydoc-tutorial-start>`!
 * Need a refresher on :ref:`YOMIH <yverb-yomih>` Specific Classes? Visit our :ref:`Class Reference <ydoc-class-reference>`!
 * Wanna help contribute to these Docs? Check out our :ref:`Contributing Guide <ydoc-contributing-guide>`!
 * Have a question or wanna chat? Join our :ref:`Community <ydoc-community-channels>`!

Our Goal
--------

Our goal for these docs are to be a the #1 community resource for the :ref:`YOMIH <yverb-yomih>` Modding community go to find quick information about modding, without having to search the depths of `Discord <https://discord.gg/yomimodding>`_ and `Reddit <https://www.reddit.com/r/yomimodding>`_ for *answers* .
*(Almost like a homepage of sorts)*

Now we don't want to steal the thunder from the actual :ref:`Community Channels <ydoc-community-channels>`, so please go visit them!

Credits
-------

Check out our :ref:`ydoc-credits` page to view our **Special Thanks** and **Contributors** who made this project possible!


.. toctree::
   :hidden:
   :maxdepth: 1

   credits

.. toctree::
   :hidden:
   :maxdepth: 1
   :caption: Tutorials
   :includehidden:

   tutorials/start
   tutorials/character/index
   tutorials/mod/index
   tutorials/state-editor
   tutorials/git

.. toctree::
   :hidden:
   :maxdepth: 1
   :caption: Community
   :includehidden:

   community/contributing/index
   community/channels
   community/verbiage

.. toctree::
   :hidden:
   :maxdepth: 1
   :caption: Class Reference
   :includehidden:

   class_ref/index