https://github.com/jontze/cadency

A discord music bot written with discord.js and TypeScript
https://github.com/jontze/cadency

discord-bot discord-js discord-music-bot discord-youtube docker music songs

Last synced: 7 days ago
JSON representation

A discord music bot written with discord.js and TypeScript

• Host: GitHub
• URL: https://github.com/jontze/cadency
• Owner: jontze
• License: mit
• Archived: true
• Created: 2020-06-09T08:53:20.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-04-17T10:46:01.000Z (about 2 years ago)
• Last Synced: 2025-05-07T06:16:32.164Z (14 days ago)
• Topics: discord-bot, discord-js, discord-music-bot, discord-youtube, docker, music, songs
• Language: TypeScript
• Homepage:
• Size: 4.18 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
> Deprecated: This repo is archived and the project discontinued. If you're looking for a working discord music bot, take a look at [Cadency-rs](https://github.com/jontze/cadency-rs) - the rust rewrite of this project.

# Cadency - Discord Bot

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

![Linting](https://github.com/jontze/Cadency/workflows/Linting/badge.svg?branch=develop&event=push)

![GitHub last commit (branch)](https://img.shields.io/github/last-commit/jontze/Cadency/master)

[![GitHub license](https://img.shields.io/github/license/jontze/Cadency)](https://github.com/jontze/Cadency/blob/master/LICENSE)

[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=UsingPython_DiscordBot&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=UsingPython_DiscordBot)

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=UsingPython_DiscordBot&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=UsingPython_DiscordBot)

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=UsingPython_DiscordBot&metric=security_rating)](https://sonarcloud.io/dashboard?id=UsingPython_DiscordBot)

- [Cadency - Discord Bot](#cadency---discord-bot)

  - [Requirements](#requirements)

  - [Installation](#installation)

  - [Features](#features)

  - [Contributing](#contributing)

## Requirements

- Docker

- Docker-compose

- A valid discord bot token ([How to get a token](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token))

## Installation

- Clone the repo

- Create a `.env` file based on the [.env.example](https://github.com/UsingPython/DiscordBot/blob/master/.env.example)

- Start the postgres database and after that the app

  - ` docker-compose up -d postgres`

  - ` docker-compose up -d app`

## Features

- Play music from YouTube by URL and search query

  - start adding music to the queue with `play `

  - search for a song with `search `

  - `skip` / `pause` / `resume` the songs in the queue

  - `show` or `purge` the songs on the queue

- Some more stuff, just ask the bot with `help`

## Contributing

**You will need...**

- Min. NodeJS v14.15

- Yarn

- Docker and docker-compose or a local postgres server

- A valid discord bot token

- [ffmpeg](https://www.ffmpeg.org) local installed