Maverick - A Poker Library in Python
====================================

**Version**: |version|

**Useful links**:
:ref:`Installation <installation>` |
:doc:`Getting Started <getting_started>` |
:doc:`Poker Fundamentals <poker_fundamentals>` |
:ref:`Hand Rankings <target_hand_rankings>` |
`Issue Tracker <https://github.com/BALOGHBence/maverick/issues>`_ | 
`Source Repository <https://github.com/BALOGHBence/maverick>`_

.. margin:: Supporting Maverick

    .. raw:: html

      <div class="supporting-maverick-sidebar">

        <p>
          Maverick is developed and maintained in the open.
          If you want to see it thrive and grow,
          you can help sustain its development.
        </p>

        <div style="margin-top: 2rem; text-align: center;">
          <a href="https://www.buymeacoffee.com/benceeokf" target="_blank">
            <img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png"
                  alt="Buy Me A Coffee"
                  style="height: 50px;" />
          </a>
        </div>

      </div>

Maverick is a comprehensive Python library for simulating poker games. It provides
a complete game engine with a state machine architecture, making it easy to
create poker games, develop AI players, and analyze poker scenarios.

Features
--------

- **Configurable Poker Games**: Full rules and mechanics supporting a variety of flavours
- **State Machine Architecture**: Clean separation of game states and transitions
- **Flexible Player System**: Protocol-based player interface for custom implementations
- **Hand Evaluation**: Built-in poker hand scoring and comparison
- **Event System**: Track all game events for analysis and replay
- **Well Documented**: Comprehensive documentation of rules and APIs
- **Thoroughly Tested**: Features are heavily tested with high code coverage

Contents
--------

.. toctree::
   :maxdepth: 2
   
   overview
   getting_started
   poker_fundamentals
   LLMs

.. toctree::
   :maxdepth: 2
   
   user_guide/index

.. toctree::
   :maxdepth: 2
   
   examples/index

.. toctree::
   :maxdepth: 2
   
   dev_guide/index

.. toctree::
   :maxdepth: 2
   
   api_reference

Indices and tables
==================

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