Client as State
The ongaku Client is the main part of running the bot. It handles anything between rest actions, to updating players, and holding cache.
Below is some examples of how to use the client within a bot setup.
Ongaku's client will automatically be set as a dependency when using Client.from_arc()
bot = hikari.GatewayBot(...)
arc_client = arc.GatewayClient(bot)
client = ongaku.Client.from_arc(arc_client)
client.create_session(...)
Example usage:
@arc.slash_command("name", "description")
async def some_command(ctx: arc.GatewayContext, client: ongaku.Client = arc.inject()) -> None:
player = await client.fetch_player(...)
await player.play(...)
The best method for adding ongaku to crescent, is by using crescents models.
@dataclasses.dataclass
class MyModel:
ongaku: ongaku.Client
bot = hikari.GatewayBot(...)
client = ongaku.Client(bot)
crescent_client = crescent.Client(bot, MyModel(client))
client.model.ongaku.create_session(...)
Example usage:
@crescent.command("name", "description")
class SomeCommand:
async def callback(self, ctx: crescent.Context) -> None:
player = await ctx.client.model.ongaku.fetch_player(...)
await player.play(...)
The best method for adding ongaku to lightbulb, is to use the datastore.
bot = lightbulb.BotApp(...)
bot.d.ongaku = ongaku.Client(bot)
bot.d.ongaku.create_session(...)
Example usage:
@lightbulb.command("name", "description", auto_defer=False)
@lightbulb.implements(lightbulb.SlashCommand)
async def some_command(ctx: lightbulb.SlashContext) -> None:
player = await ctx.bot.d.ongaku.fetch_player(...)
await player.play(...)
Ongaku's client will automatically be set as a dependency when using Client.from_tanjun()
bot = hikari.GatewayBot(...)
tanjun_client = tanjun.Client.from_gateway_bot(bot)
client = ongaku.Client.from_tanjun(tanjun_client)
client.create_session(...)
Example usage:
@tanjun.as_slash_command("name", "description")
async def some_command(ctx: tanjun.abc.SlashContext, client: ongaku.Client = alluka.inject()) -> None:
player = await client.fetch_player(...)
await player.play(...)