Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zekrotja/yuri69

The best soundboard that exists for Discord.
https://github.com/zekrotja/yuri69

discord discord-bot discord-soundboard discord-soundbot hacktoebrfest soundboard

Last synced: 24 days ago
JSON representation

The best soundboard that exists for Discord.

Awesome Lists containing this project

README 

        


     

     
~ YURI 69 ~


     Even faster, harder, louder!
The best Discord Soundboard you can get.



      

      

      

     




---



Yuri69 is the next level of Discord Sound Boards. Featuring a fancy web interface where you can manage all your sounds, hotkey control, an open REST API to connect to devices like a Stream Deck, for example, and much more!



## Why?



- You can upload, play, search, manage, favorite and delete sounds via the interactive web interface (which is easy to use on mobile as well).

- Play and import sounds directly from YouTube.

- Twitch integrations where viewers can play sounds via the chat or web interface.

- An open REST API so you can use Yuri with the StreamDeck, for example.

- Playback statistics.



## Why not just use the integrated Discord Soundboard?



- Discord only allows up to 25 sounds per guild - you can upload as many sounds as you want in yuri!

- Discord only allows using sounds across guilds with a nitro subscription - you can share as many sounds between guilds as you want (as long as yuri is part of the guilds)!



## Features



You can log in to the web interface using your Discord Account (via [OAuth2](https://oauth.net/2/)). There you can list, search, filter, upload, edit, favorize and remove sounds as well as managing the player state (join/leave chanel, stop playback, manage volume). Also, you can set personal settings like the hotkey trigger or guild filters for random sound playback.






You can directly upload sounds via the web interface. There you can specify a unique ID, displayname and tags. These tags can be used for filtering and searching sounds. All uploaded files are converted using [FFMPEG](https://ffmpeg.org/) to be stored in an optimized file state for playback. 






When going to the setting page, you can scan the displayed QR code using your mobile device to control the sound board from another device! You can also obtain an API key there to, for exmaple, play sounds from a stream deck or batch-upload sounds you have laying around (see [scripts/upload.sh](scripts/upload.sh)).






There are also some general playback stats like a playback log or a list of most played sounds.






Things like deletings or editing sounds uploaded by other users require admin permissions. These can be set in the admin panel. You need to specify yourself as `owner` in the config to get initial access to this panel and to add other admins.






## Deployment



Yuri requires Lavalink to run. Please refer to the [Lavalink Repository](https://github.com/freyacodes/Lavalink) to download and run Lavalink. Therefore, you can use the [provided lavalink config](config/lavalink/application.yml).



Yuri can be deployed either on bare metal or using the [provided docker images](https://github.com/zekroTJA/yuri69/pkgs/container/yuri69). Binaries can be downloaded from the [releases page](https://github.com/zekroTJA/yuri69/releases) or from the build artifacts from the [CI workflow](https://github.com/zekroTJA/yuri69/actions/workflows/artifacts.yml).



You can also use the provided [Docker Compose Config](docker-compose.yml) to host the required services all together in a Docker Compose stack.



Configuration to Yuri can be provided either via a config file (YAML, JSON or TOML) or via environment variables. See [config/config.toml](config/config.toml) for configuration documentation or [docker-compose.yml](docker-compose.yml) for environment configuration examples.



## API Documentation



*Coming soon™️*