====
Yami
====

A command handler that complements `Hikari <https://hikari-py.dev/hikari>`_.

Build your commands with ease using Yami, the yin to Hikari's yang.

To learn more about using Yami, check out the
`getting started <getting-started-guide.html>`_ guide.

#########
Resources
#########

****
Yami
****

- `Stable documentation <https://jonxslays.github.io/Yami>`_
- `Development documentation <https://jonxslays.github.io/Yami/master>`_
- `Repository <https://github.com/Jonxslays/Yami>`_

******
Hikari
******

- `Hikari documentation <https://hikari-py.dev/hikari>`_
- `Hikari repository <https://github.com/hikari-py/hikari>`_
- `Discord <https://discord.gg/Jx4cNGG>`_

************
Alternatives
************

If you're looking for something different, consider giving one of these
other Hikari command handlers a try!

- **Lightbulb** - The official unofficial command handler for the Python
  discord API wrapper library, Hikari.

  * `Documentation <https://hikari-lightbulb.readthedocs.io/en/latest/>`_
  * `Repository <https://github.com/tandemdude/hikari-lightbulb>`_

- **Tanjun** - A flexible command framework designed to extend Hikari.

  * `Documentation <https://tanjun.cursed.solutions/release/tanjun.html>`_
  * `Repository <https://github.com/FasterSpeeding/Tanjun>`_

##############
Coming up next
##############

.. toctree::
   :maxdepth: 1

   getting-started-guide
   message-commands-guide
   checks-guide
   modules-guide
   reference

########################
Message from the creator
########################

Getting into bot development can be intimidating, and tough at times. I
hope that this library can, in any way, make your life a little bit
easier. Try to have fun with it!

Best of luck with creating your Discord bot :).

For more in depth information check out the `api reference <reference.html>`_,
or visit us in the Hikari `Discord server <https://discord.gg/Jx4cNGG>`_!