Skip to content

Getting started#

Getting Started with Ongaku.

In the following documents, you will learn how to work with ongaku, from its most basic features, to its more advanced features.

Installation#

To install Ongaku, simply run the following:

pip install hikari-ongaku

Where to next#

  • Client as State


    How to set client as state in all different libraries.

    Learn more

  • Player control


    All the functions of a player and its features.

    Learn more

  • Sessions


    How to add a session, change to a different session handler and what all session handlers do.

    Learn more

  • Filters


    All the filter options, and how to use them.

    Learn more

  • Injection


    Shows how to use the injection for arc, and tanjun.

    Learn more

Q's and A's#

Below, will be the most common questions, and some answers to said questions.


Question Answer
Why can't I use ongaku with a rest bot? Ongaku relies on events, like the Voice Server Update and the Voice State Update events. Without them, the bot has no idea if its joined a voice channel, or the websocket connection, that it can stream audio to.
What is Ongaku compatible with? Ongaku should be compatible with all hikari based command handlers and component handlers, however, further testing is required.

Got another question that should be added? contact me via [email protected]