Skip to main content

Voice module for `hikari`-based Discord bots

Project description

A lightweight, native voice implementation for hikari-based Discord bots

Latest: 0.1.0a1  |  Python: 3.10+

Overview

hikari-wave is a standalone voice module for hikari that provides direct voice gateway communication without requiring external backends like Lavalink.

It is designed to be:

  • Simple to use
  • Fully asynchronous
  • Native to hikari's architecture

No separate software. No complex setup. Just voice.

Features

  • Native Discord voice gateway implementation
  • Clean, async-first API
  • Strong typing and documentation throughout
  • Supplemental voice events for better control and UX

Installation

pip install hikari-wave

Ensure FFmpeg is installed and available in your system PATH.

Quick Start

Create a basic voice client bot:

import hikari

bot = hikari.GatewayBot("TOKEN")
client = hikariwave.VoiceClient(bot)

bot.run()

Connect to voice when a member joins:

@bot.listen(hikariwave.MemberJoinVoiceEvent)
async def on_join(event):
    await voice.connect(event.guild_id, event.channel_id)

Play audio:

@bot.listen(hikariwave.MemberJoinVoiceEvent)
async def on_join(event):
    connection = await voice.connect(event.guild_id, event.channel_id)
    source = FileAudioSource("test.mp3")

    await connection.player.play(source)

That's it.

Status

  • Voice connect / disconnect
  • Audio playback
  • Move, reconnect, resume
  • Player utilities (queue, shuffle, next/previous)
  • Audio Sources:
    • Files
    • URLs
    • In-memory buffers
    • Media sites (YouTube, SoundCloud, etc.) (planned)
  • Discord DAVE (planned)

Documentation

Full documentation is available at: https://hikari-wave.wildevstudios.net/

Contributing

Bug reports and feature requests are welcome via GitHub Issues. Clear reproduction steps and context are appreciated.

License

MIT License © 2025 WilDev Studios

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hikari_wave-0.1.0a1.tar.gz (24.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hikari_wave-0.1.0a1-py3-none-any.whl (30.5 kB view details)

Uploaded Python 3

File details

Details for the file hikari_wave-0.1.0a1.tar.gz.

File metadata

  • Download URL: hikari_wave-0.1.0a1.tar.gz
  • Upload date:
  • Size: 24.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for hikari_wave-0.1.0a1.tar.gz
Algorithm Hash digest
SHA256 e41962a84256e7ea67cb4898f5fb084f9db51059407e8cbc99a035fe756e77cf
MD5 c7aee736f88bd29f46d152b4859d62e5
BLAKE2b-256 efde808e3109c6291c4d2870cd76ecc4dba3db549ed6b87b4e7b85dcbb61b8a1

See more details on using hashes here.

File details

Details for the file hikari_wave-0.1.0a1-py3-none-any.whl.

File metadata

  • Download URL: hikari_wave-0.1.0a1-py3-none-any.whl
  • Upload date:
  • Size: 30.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for hikari_wave-0.1.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 b524b43a8a110c89a2f33918329782cd95ddca47e493c08f0361e7969466e69d
MD5 5007fb677f4bc17515b65a04e2d8cf04
BLAKE2b-256 d4cc0f8ffa2bcc57927e1420010986ac19a926b27a870983ceb57350e40c457d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page