https://github.com/sectly/sectly-s-musicbot
https://github.com/sectly/sectly-s-musicbot
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/sectly/sectly-s-musicbot
- Owner: Sectly
- License: mit
- Created: 2021-01-15T20:05:11.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-01-15T20:07:40.000Z (over 5 years ago)
- Last Synced: 2025-04-04T19:27:59.181Z (about 1 year ago)
- Language: JavaScript
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Discord Music bot
A simple discord bot that helps you manage your server by providing useful commands like playing music or deleting text messages.
You can find the tutorial about building a discord music bot [here](https://gabrieltanner.org/blog/dicord-music-bot).
## Table of content
* [Features](#features)
* [Requirements](#requirements)
* [Getting started](#getting-started)
* [Common errors](#common-errors)
* [Author](#author)
* [License](#license)
## Features
- Ban
- Userinfo
- Play music
- Skip songs
- Stop music
- Purge text messages
## Requirements
- [Node](https://nodejs.org/en/)
- [NPM](https://www.npmjs.com/)
- [FFMPEG](https://www.ffmpeg.org/)
- [Docker](https://www.docker.com/) (optional)
## Getting started
First, make sure you have all the required tools installed on your local machine then continue with these steps.
### Installation
```bash
# Clone the repository
git clone https://github.com/TannerGabriel/discord-bot.git
# Enter into the directory
cd discord-bot/
# Install the dependencies
npm install
```
### Configuration
After cloning the project and installing all dependencies, you need to add your Discord API token in the config.json file.
### Starting the application
```bash
node index.js
```
### Starting the application using Docker
```bash
# Build the image
docker build --tag discordbot .
# Run the image
docker run -d discordbot
```
## Common errors
Here is a list of common errors and how you can fix them.
### Dependencies aren't up to date
The packages used in this repository get updated often, especially the ytdl-core package. That is why it is always worth a try updating those if you get an error like `invalid URL: undefined` or when the bot crashes when running the play command.
```bash
npm install ytdl-core@latest
```
### FFMPEG is not installed on the machine running the bot
The `play` command requires FFMPEG to be installed on the machine that is running the bot. You can download it on the official [FFMPEG website](https://www.ffmpeg.org/). Note: This isn't relevant if you use the Dockerfile because it will install FFMPEG inside of the container.
## Author
Gabriel Tanner
## Support me
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details