A music bot build in Serenity/Rust.

Last update: Nov 5, 2022

Overview

Sunny Flowers

Sunny Flowers is a Discord bot to play media in voice channels. It uses Serenity and Songbird to accomplish this.

Running

You can run Sunny using cargo run --release
When running Sunny locally, she can take in the DISCORD_TOKEN via a .env file.

Deployment

For deploying Sunny a Dockerfile and kubernetes config are provided.
This works like normal and requires the DISCORD_TOKEN present in the environment.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

Contact

Sophie - Ailbe#7190

Comments

Big Refactor

Refactored commands to extract the core logic to be handled in the effects, this allows us to be able to re-use this logic in other places where it was already being manually re-used anyway.

Added custom Sunny error/result handling

Added prefix to the .env for local testing

wip #41

Co-authored-by: Victor Roest [email protected]
cleanup hacktoberfest-accepted

opened by NULLx76 4
Bake version number into the binary

So that it would be able to be queried using a hypothetical info command or shown in the help section.

This should probably use the git tag if present else revision + last tag
enhancement

opened by NULLx76 1
Sunny now does not attempt

to join a call initiated by a user who is already in the same voice channel as her.

Closes #59

Co-authored-by: Victor [email protected]

opened by Druue 0
Sunny shouldn't re-join a channel she's already in.

As it's currently implemented, sunny just joins the channel even though she's already in it. Sunny should instead respond that she's already in that call and not make a join request
enhancement

opened by Druue 0
Commands Clean Up & Local Dev Testing
commands.rs is getting unwieldly with the changes to the commands, might be better to seperate out some of the commands into their own specific files as an example:

commands.rs commands/ - queue.rs

Also, to improve local testing, a new env variable for the prefix
cleanup
opened by Druue 0
Inform user of age restriction error

If a youtube video is age restricted Sunny fails ominously with "Failed to play", it would be nice to inform the user of why it has failed.

logs on the server side
bug

opened by NULLx76 0
Metrics & Profiling

Add metrics and profiling, probably something like prometheus. This is to better understand the performance characteristics of the bot and gain insights in usage.
enhancement

opened by NULLx76 0

Releases(1.0.0)

1.0.0(Oct 8, 2021)
v1.0.0 - 2021-10-08 - Initial Release

The initial release of the Sunny Flowers Discord music bot.

Added

Sunny now supports the following commands:

join: joins your voice channel

leave: leaves the voice channel

play: adds a song to the queue

play_next: adds a song to the front of the queue

pause: pauses the playback of the current song

resume: resumes the playback of the current song

skip: skips to the next song in the queue

stop: stops the current song and clears queue

shuffle: shuffles the queue

swap: swaps two numbers in the queue from position

remove_at: removes a song from the queue at a specific index

now_playing: shows an embed containg info of the currently playing song

queue: displays the songs coming up in the queue

help: shows available commands, their aliases, and usage.

Known Bugs

#16: Playlists behave buggy

#39: Song metadata may not show correctly for raw music files

#54: YouTube's age restricted videos don't play and fail silently

Source code(tar.gz)
Source code(zip)

Owner

Sophie

Software Developer

GitHub

Polaris is a music streaming application, designed to let you enjoy your music collection from any computer or mobile device.

Polaris is a music streaming application, designed to let you enjoy your music collection from any computer or mobile device. Polaris works by streami