Skip to main content

Voice module for `hikari`-based Discord bots

Project description

hikari-wave

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

  • Latest: 0.0.1a5
  • Python: 3.10+

Python Downloads Documentation Status

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 servers. 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.0.1a5.tar.gz (22.8 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.0.1a5-py3-none-any.whl (28.7 kB view details)

Uploaded Python 3

File details

Details for the file hikari_wave-0.0.1a5.tar.gz.

File metadata

  • Download URL: hikari_wave-0.0.1a5.tar.gz
  • Upload date:
  • Size: 22.8 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.0.1a5.tar.gz
Algorithm Hash digest
SHA256 dea31784751c90377cbdef744120a911abf39c487f15368c85ef6f828f7f4437
MD5 2a44cf6695515ee5ff977e19648b0847
BLAKE2b-256 c3a5530071a9511c95b48748a946fbfde4ab3e0f2102d340384212e406cbe6a3

See more details on using hashes here.

File details

Details for the file hikari_wave-0.0.1a5-py3-none-any.whl.

File metadata

  • Download URL: hikari_wave-0.0.1a5-py3-none-any.whl
  • Upload date:
  • Size: 28.7 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.0.1a5-py3-none-any.whl
Algorithm Hash digest
SHA256 baef22b9333798632239e6b86bef5fae3aa080c97ef13412326366236fc2a329
MD5 ee0fb551173f71074e0cc47cf286fb96
BLAKE2b-256 ce003464e1035a6e4f342d4af74e3793a0d211f1a5ee12365b246c2da3dff5ec

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