dysta / jukebot Goto Github PK

View Code? Open in Web Editor NEW

33.0 1.0 4.0 53.05 MB

Discord music bot written in Python 3

Home Page: https://dysta.github.io/JukeBotLab/

License: GNU General Public License v3.0

Python 99.51% Dockerfile 0.49%

bot discord python rythm music youtube-dl yt-dlp discordpy discord-bot disnake

jukebot's Introduction

JukeBot

Discord music bot written in Python 3

🧩 Installation

git clone https://github.com/Dysta/JukeBot 
cd JukeBot
poetry install

⚙ Configuration

Rename .env.example to .env and fill in the values.

🚀 Launch

Run poetry run task start.

⁉ Other

The bot needs ffmpeg to work.

Install on Windows

Use the package manager Chocolatey and run in an admin shell choco install ffmpeg.

Install on Linux

Use apt, run sudo apt install ffmpeg.

Install on MacOS

Use brew, run brew install ffmpeg.

🌐 Deployment

Clone the repos.
Rename .env.example to .env and fill in the values.
Run docker-compose up -d.

C/C the file .env.example in local, fill in the values.
Run docker run --env-file <YOUR_LOCAL_ENV_FILE> dysta/jukebot.

🔮 Devcontainer

Clone the project then open it in vscode. If you have the devcontainer extension, it will ask you to reopen the project in a devcontainer. If not, open the commands prompt then search for reopen in container.
All the needs will be automatically installed.

🗨 Features & Commands

Music

Queue

Utility

prefix
reset

Effect

speed
bass
nightcore
slowed

Others

🤝 Contributing

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

Fork the repository
Clone your fork git clone https://github.com/Dysta/JukeBot.git
Create your feature branch git checkout -b AmazingFeature
Stage changes git add .
Commit your changes git commit -m 'Added some AmazingFeature'
Push to the branch git push origin AmazingFeature
Submit a pull request

❤️ Credits

Released with ❤️ by Dysta.

jukebot's People

Contributors

Stargazers

Watchers

Forkers

theonlywayup saltedgoose orhankalyon

jukebot's Issues

🟫 Refactor architecture

Description

Use the same architecture as this bot with the __main__.py file and other.

Other

🟨 — Yt-dlp post processing

Description

Check if its possible to add Post processing (https://github.com/yt-dlp/yt-dlp#embedding-yt-dlp) on the Query class.

Expected result

A dedicated post process class

Actual result

Actually a shitty function

Reproduction Steps

Other (screen)

🟩 — Command play_top

Description

Play top add a command to the top of the queue

DoD

Add command
Aliases ptop

Other

🟩 — Add Community button in promote view

Description

Community server was created, need to add the button in the promote view

DoD

Create button
Add button to view

Other

🟥 — Ratelimite when spamming leave/join voice channel as a user

Description

It's possible to rate limit the bot by spamming the leave and join action as a user because of the message sent to inform that the player is paused or resumed.

Expected result

Not being rate limited

Actual result

Rate limited

Reproduction Steps

Play something in the player, leave and join the same voice channel as the bot. The amounts of message sent by the bot trigger the gateway rate limit

Other (screen)

🟩 LoguruE

Description

Add logging to JukeBot using loguru to easily catch errors during execution.

Other

Custom Radio

Description

Offering to the user the ability to create custom playlist for their server.

DoD

Allow user to create radios
Save user's radios to database
Allow user to delete radios
List of radio show custom radios

Other

i18n

Description

Add possibility to translate message send by the bot using the i18n standard.

DoD

Create i18n folder
Add English translation
Add French translation
Convert all message to use the i18n system
Save language preference for each guild

Other

Ask Washi to review the translate quality

🟩 Taskipy

Description

Add package Taskipy to JukeBot to create task easily

DoD

Add Taskipy as dev dependencie in Poetry
Create task to format code using Black
Create task to clean dead import using Autoflake
Create task to run the bot

Other

🟥 — Bad parsing of shorten private SoundCloud url

Description

When sending a shorten private soundcloud url, the parsing isn't correct. The channel is the title and the title is the secret key

Expected result

Actual result

Reproduction Steps

Other (screen)

🟥 IDLE

Description

JukeBot disconnect because of the idle task is not properly cancel, even if music is currently playing.

Reproducer

Summon the bot to a voice channel then use leave command. The task created during leave command is never canceled.

Other

🟥 — Stop command behavior

Description

When user stop the player but the queue isn't empty, he don't have any way to resume the queue.

Expected result

User resume the queue.

Actual result

Nothing

Reproduction Steps

Use play command to play something with the bot, use play command again to add something in the queue then use stop command.
To resume the player, the user must use play command that dequeue the 1st song and add the its request to the queue.

Other (screen)

❇️ Radio

Description

Offering to the user the ability to play pre configured playlists with many different style.

DoD

Other

Normalisation effect

Description

Add an effect to normalize the output

DoD

not defined yet

Other

🟩 — play skip

Description

Play a song and automatically skip the current

DoD

Add command
Add aliases

Other

🟥 — Game import manquant

Description

il faut rajouter from discord import Game (du moins je l'ai résolu comme ça)

Expected result

musique

Actual result

pas de musique

Reproduction Steps

pegi 18

Other (screen)

🟩 — Docker

Description

Add Docker to the bot

DoD

Docker file
docker-compose
Edit the code to fit the need of docker

Other

🟥 — High CPU usage

Description

From time to time, the bot consumes huge amounts of CPU by looping FFMPEG processes that only last for a few seconds.

Expected result

The bot does not create a looping process.

Actual result

High CPU consumption and loop creation of ffmpeg processes

Reproduction Steps

Put a link to play then enable loop. At a moment, the stream_url will be invalided by website that cause a insane ffmpeg creation loop and cause a high CPU usage.

Other (screen)

🟨 — Refactor Query and ShazamQuery component

Description

The two *Query components are starting to be difficult to maintain and improve. The lack of testing makes it hard to check if an update doesn't break all the old features. Moreover, it is complicated to add pre/post processing because of the bad design of the component.

Expected result

A Query base class allowing you to do pre or post processing simply. Tests.

Actual result

Nothing good for the long term

Reproduction Steps

Other (screen)

TTS

Description

TTS command allow user to play a tts message in the bot

DoD

Other

Test

je te vole ton code

ahah cheh

Test epic

Test

🟩 — Queue loop

Description

Add the possibility to loop the queue

DoD

Add QUEUE type to Loop enum
Create queue loop command

Other

🟥 Double disconnect

Description

The bot double disconnect when leave command is called. Probably a task that is not properly canceled.

Reproducer

Play something on the bot, call leave command and wait the timeout time. A second message telling the bot is disconnected should appear

Other

🟥 — Strange behavior with queue loop

Description

When we put a playlist and we activate the queue repeat, if we make a clear, the bot stops playing at the end of the music.
When we add new music, it replays the old music even if we skip to get the new one

Expected result

Playing the new music or can't clear queue if loop queue is enable

Actual result

Unconfirmed strange beahavior

Reproduction Steps

Play a song
Add a second song to the queue
Enable queue loop
Clear the queue
Skip the current song