.. kumiko documentation master file, created by
   sphinx-quickstart on Sun Nov 24 21:16:15 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Kumiko
======

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Overviews

   overviews/user/index
   overviews/dev/index

   
.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Miscellaneous

   misc/tos.rst
   misc/privacy-policy.rst

.. figure:: /_images/kumiko-resized-round.svg
   :align: right

.. image:: https://img.shields.io/github/v/release/No767/Kumiko?label=Release&logo=github&sort=semver
   :target: https://github.com/No767/Kumiko/releases/

.. image:: https://img.shields.io/github/license/No767/Kumiko?label=License&logo=github
   :target: https://github.com/No767/Kumiko/blob/main/LICENSE

.. image:: https://img.shields.io/badge/Kumiko-Oumae-white
   :target: https://hibike-euphonium.fandom.com/wiki/Kumiko_Oumae

A personal multipurpose Discord bot built with freedom and choice in mind. Kumiko takes a unique approach to what a multipurpose bot is defined as.

Features
--------

* Customizable prefix module
* Redirects module (If you have overlapping conversations in your channels, this is for you!)
* Anti-ping with customizable settings and embeds
* Quiet mode
* Support for AniList and other anime-related services


Guides
------

Are you interested in contributing to Kumiko as a developer? Or are you interested in learning the different features of Kumiko? This is the place to get started!

.. grid:: 2
   :gutter: 4

   .. grid-item-card:: :material-regular:`account_circle;2em;sd-mr-2` User Overview
      :link: overviews/user/index
      :link-type: doc
      :link-alt: Leads to user-facing documentation
      :shadow: md

      Covers user-facing features and documentation

   .. grid-item-card:: :material-regular:`code;2em;sd-mr-2` Development Overview
      :link: overviews/dev/index
      :link-type: doc
      :link-alt: Leads to development documentation
      :shadow: md

      Technical developer-focused overview and documentation


Resources and Links
-------------------

- `GitHub <https://github.com/No767/Kumiko>`_
- `Discord Server <https://discord.gg/ns3e74frqn>`_
- `Contributing <https://github.com/No767/Kumiko/blob/main/.github/CONTRIBUTING.md>`_
- `Project License <https://github.com/No767/Kumiko/blob/main/LICENSE>`_