https://github.com/mariusbegby/cadence-discord-bot

🎶 Cadence - The free Discord music bot. Open source and community-driven!
https://github.com/mariusbegby/cadence-discord-bot

discord discord-bot discord-js discord-player discordbot discordjs discordplayer music-bot soundcloud spotify youtube

Last synced: 3 months ago
JSON representation

🎶 Cadence - The free Discord music bot. Open source and community-driven!

• Host: GitHub
• URL: https://github.com/mariusbegby/cadence-discord-bot
• Owner: mariusbegby
• License: mit
• Archived: true
• Created: 2023-07-04T13:03:02.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-03T17:48:12.000Z (4 months ago)
• Last Synced: 2024-09-22T18:03:44.203Z (3 months ago)
• Topics: discord, discord-bot, discord-js, discord-player, discordbot, discordjs, discordplayer, music-bot, soundcloud, spotify, youtube
• Language: TypeScript
• Homepage:
• Size: 2.49 MB
• Stars: 69
• Watchers: 4
• Forks: 27
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


    


    Cadence - The free Discord music bot.

    



    

    







    Enhance your Discord experience with high-quality music.


    Free, open source, community-driven!





    

     



## 🚨 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](https://discord-player.js.org/guide/extractors/stream-sources) thanks to [discord-player](https://github.com/androz2091/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](https://nodejs.org/en/download/) v20.x LTS and latest version of [FFmpeg](https://ffmpeg.org/download.html).

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](https://discordjs.guide/preparations/adding-your-bot-to-servers.html#bot-invite-links) 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](https://www.npmjs.com/package/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](https://github.com/discordjs/discord.js/) and [discord-player](https://github.com/Androz2091/discord-player). A special thanks to [@twlite](https://github.com/twlite), [@pryzmian](https://github.com/pryzmian) and [@retrouser955](https://github.com/retrouser955) for providing feedback and help during development of this bot!

### Contributors

    

        

            

            


            Marius Begby

        

    

    

        

            

            


            tacheometry

        

    

    

        

            

            


            Aaron Sandoval

        

    

    

        

            

            


            MissFrizzy

        

    

    

        

            

            


            Twilight

        

    

    

        

            

            


            Edward205

        

    

    

        

            

            


            Niko G.

        

    

    

        

            

            


            Parker Owings