auric 0.0.1-alpha

Lavalink v4 client for Dart with multi-source music support (YouTube, Spotify, Apple Music, SoundCloud). Built from scratch with audio filters and queue management.

example/README.md

Auric Examples

This directory contains comprehensive examples for using Auric.

Running Examples

Make sure Lavalink is running first:

cd ../lavalink
java -jar Lavalink.jar

Then run any example:

dart run example/basic_usage.dart
dart run example/multi_source_search.dart
dart run example/audio_filters.dart
dart run example/queue_management.dart
dart run example/discord_bot_example.dart

Examples

basic_usage.dart

Basic usage of Auric including:

• Connecting to Lavalink
• Searching and playing tracks
• Playback control (pause, resume, seek)
• Volume control
• Basic filters

multi_source_search.dart

Multi-source search examples:

• Apple Music search (am despacito)
• Spotify search (sp imagine dragons)
• YouTube search (yt never gonna give you up)
• SoundCloud search (sc chill beats)
• Default search (no prefix)
• List all available sources

audio_filters.dart

Audio filter examples:

• Nightcore effect
• Vaporwave effect
• Bass boost
• Treble boost
• 8D Audio (rotation)
• Karaoke (vocal removal)
• Combined filters
• Clearing filters

queue_management.dart

Queue management examples:

• Adding tracks to queue
• Showing queue
• Playing tracks
• Skipping tracks
• Shuffling queue
• Removing from queue
• Clearing queue
• Queue streams

discord_bot_example.dart ⭐ NEW

Complete Discord bot integration example:

• Full MusicBot class showing Auric API usage
• All command handlers (play, pause, skip, queue, etc.)
• Multi-source music playback
• Audio filters integration
• Queue management
• Event handling
• Error handling
• Perfect template for building your own bot!

This example shows you exactly how to use Auric in a real Discord bot without the complexity of the full bot implementation.

Source Prefixes

Prefix	Source	Example
am	Apple Music	am despacito
sp	Spotify	sp imagine dragons
yt	YouTube	yt rickroll
ytm	YouTube Music	ytm pop music
sc	SoundCloud	sc chill beats
dz	Deezer	dz top hits
ym	Yandex Music	ym russian music
bc	Bandcamp	bc indie rock
tw	Twitch	tw stream
vm	Vimeo	vm video

Notes

• Replace 'youshallnotpass' with your actual Lavalink password
• Replace 'bot-id' with your actual bot/user ID
• Some sources require API keys (Spotify, Deezer, Yandex Music)
• Configure these in your Lavalink application.yml

More Examples

Check the main documentation: ../README.md