Skip to content

Latest commit

 

History

History
115 lines (93 loc) · 3.08 KB

README.md

File metadata and controls

115 lines (93 loc) · 3.08 KB

juke-banner

JukeBot

Powered by Disnake Powered by Poetry
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.

OR

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

  • join
  • play
  • playtop
  • playskip
  • search
  • nowplaying
  • grab
  • seek
  • loop
  • pause
  • resume
  • lyrics
  • disconnect
  • share

Queue

  • queue
  • loopqueue
  • move
  • skipto
  • shuffle
  • remove
  • clear
  • removedupes

Utility

  • prefix
  • reset

Effect

  • speed
  • bass
  • nightcore
  • slowed

Others

  • info
  • invite
  • donate
  • watch
  • help

🤝 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.

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

❤️ Credits

Released with ❤️ by Dysta.