Welcome to flogin's documentation!
=================================================

.. image:: https://img.shields.io/github/actions/workflow/status/cibere/flogin/tests.yml?label=tests
   :target: https://github.com/cibere/flogin/actions/workflows/tests.yml
   :alt: Tests Workflow Status
.. image:: https://flogin-coverage.cibere.dev/badges/3.13.svg
   :target: https://flogin-coverage.cibere.dev
   :alt: Coverage Report
.. image:: https://img.shields.io/github/actions/workflow/status/cibere/flogin/build.yml?label=build
   :target: https://github.com/cibere/flogin/actions/workflows/build.yml
   :alt: Build Workflow Status
.. image:: https://img.shields.io/github/actions/workflow/status/cibere/flogin/lint.yml?label=lint
   :target: https://github.com/cibere/flogin/actions/workflows/lint.yml
   :alt: Lint Workflow Status

.. raw:: html
   
   <br>

.. image:: https://img.shields.io/pypi/v/flogin.svg
   :target: https://pypi.python.org/pypi/flogin
   :alt: PyPI version info
.. image:: https://img.shields.io/pypi/pyversions/flogin.svg
   :target: https://pypi.python.org/pypi/flogin
   :alt: PyPI supported Python versions
.. image:: https://img.shields.io/badge/Documentation-Stable-blue
   :target: https://flogin.cibere.dev/en/stable
   :alt: Stable Documentation
.. image:: https://img.shields.io/badge/Documentation-Dev/Latest-blue
   :target: https://flogin.cibere.dev/en/latest
   :alt: Dev/Latest Documentation

A wrapper for Flow Lancher's V2 jsonrpc api using python, to easily and quickly make **Flo**\ w launcher plu\ **gin**\ s.

**Features:**

- Modern Pythonic API using ``async`` and ``await``.
- Fully Typed
- Easy to use with an object oriented design

Getting started
-----------------

Is this your first time using the library? This is the place to get started!

- **First steps:** :doc:`intro` | :doc:`quickstart`
- **Examples:** Many examples are available in the `repository <https://github.com/cibere/flogin/tree/master/examples>`_.

Getting help
--------------

If you're having trouble with something, these resources might help.

- Try the :doc:`faq`
- Ask us in `Flow's Official Discord Server <https://discord.gg/QDbDfUJaGH>`_.
- If you're looking for something specific, try the :ref:`index <genindex>` or :ref:`searching <search>`.
- Report bugs in the `issue tracker <https://github.com/cibere/flogin/issues>`_.

.. toctree::
   :caption: First Steps

   intro
   quickstart

.. toctree::
   :caption: References
   
   api
   events

.. toctree::
   :caption: Manuals/Guides
   
   search_handlers
   testing
   install_plugin
   settings
   complex_plugins
   log-override-files
   faq

.. toctree::
   :caption: Library Meta
   
   whats_new
   version_guarantees