.. _index:

=========================================
The Violence Tool - User Documentation
=========================================

Welcome to documentation for **The Violence Tool**, a Grease Pencil layer management system designed for 2D animation workflows in Blender.

.. note::
   **Version:** This documentation covers **v1.0** of the tool.

   Docs for 1.0 of the tool will **always** be available alongside any new builds with versioning provided by the Read the Docs infrastructure. This will allow you to view the correct docs for the version of the tool that you prefer using. For example, Blender's own docs run on the same system.

   See :doc:`user/versioning` for the roadmap.

Quick Start
-----------

1. **New to Blender?** Start with :doc:`user/blender-basics` to learn navigation and essential shortcuts.

2. **Ready to Install?** Follow the :doc:`user/setup` guide to get the tool running.

3. **Ready Start Animating?** Learn the esablished workflow in :doc:`user/usage`.

.. toctree::
   :maxdepth: 2
   :caption: User Guide

   user/setup
   user/blender-basics
   user/usage
   user/keybindings
   user/use-cases
   user/troubleshooting
   user/operators
   user/versioning

---

**Need Help?**

If you encounter issues, check the :doc:`user/troubleshooting` page or join the discussion on Fred's Discord.

**Contributing:**

This documentation is open source, see our README.md and LICENCE files.

If you find errors or have suggestions, please open an issue on `GitHub <https://github.com/Danweel/ProjectViolenceDocs/issues>`_.