Skip to content
This repository has been archived by the owner on Sep 3, 2024. It is now read-only.

Latest commit

 

History

History
126 lines (106 loc) · 6.95 KB

README.md

File metadata and controls

126 lines (106 loc) · 6.95 KB


Cadence - The free Discord music bot.

Cadence icon

Enhance your Discord experience with high-quality music.
Free, open source, community-driven!

Cadence bot license Cadence bot release 

🚨 Deprecation notice 🚨

This project is deprecated, meaning it will not receive any new updates. You can still download the code and setup hosting yourself if desired, but no support will be provided.


Core Features 🌟

Cadence offers an enriching audio experience on Discord with features such as:

  • High-quality music playback from many supported sources thanks to discord-player.
  • Slash commands, autocompleting search queries, select menus, buttons and more interactive features!
  • Full queue management system to add, remove, skip or move tracks, view queue and history.
  • Audio filters, shuffle mode, repeat track, queue or autoplay similar tracks!
  • Open-source codebase and and fully configurable. Download, setup and host yourself.
  • No locked functionality, no premium tier, no ads; everything is free, always.

Hosting Cadence Yourself 🔓

Self-Hosting Steps:

  1. Install Node.js v20.x LTS and latest version of FFmpeg.
  2. Install pnpm using npm install -g pnpm.
  3. Clone this repository and run pnpm install.
  4. Build the project with pnpm build.
  5. Create a .env file in with your bot token and client id (see details in .env.example).
  6. For use with YouTube, it is highly recommended to set YT_EXTRACTOR_AUTH in .env file.
  7. Deploy slash commands using pnpm run deploy.
  8. Start the bot with pnpm start, the bot should now appear online and be operational.

Note: Refer to Adding your bot to servers for help on inviting the bot to your server.

Configuration and Logging:

  • Override default configuration by creating /config/local.ts, copy over settings from /config/default.ts.
  • Have pino-pretty installed for formatted, colorized console output.
  • Logs are stored in /logs folder. Configure the logging level in the config file.

Credits and acknowledgments 🎉

This project is made possible by the contributions from the community and the use of libraries like discord.js and discord-player. A special thanks to @twlite, @pryzmian and @retrouser955 for providing feedback and help during development of this bot!

Contributors

Marius
Marius Begby
tacheometry/
tacheometry
Aaron
Aaron Sandoval
MissFrizzy/
MissFrizzy
Twilight/
Twilight
Edward205/
Edward205
Niko
Niko G.
Parker
Parker Owings