Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/myrchuk21/sunrise
Discord music bot
https://github.com/myrchuk21/sunrise
Last synced: 10 days ago
JSON representation
Discord music bot
- Host: GitHub
- URL: https://github.com/myrchuk21/sunrise
- Owner: Myrchuk21
- License: mit
- Created: 2022-01-16T17:38:58.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-17T12:51:45.000Z (over 2 years ago)
- Last Synced: 2024-11-07T01:35:08.685Z (about 2 months ago)
- Language: JavaScript
- Homepage:
- Size: 221 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.
## Table of content
* [Requirements](#requirements)
* [Getting started](#getting-started)
* [Common errors](#common-errors)
* [Contributing](#contributing)
* [Author](#author)
* [License](#license)
## Requirements
- [Node](https://nodejs.org/en/) - Version 16 or higher
- [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/Myrchuk21/Sunrise.git
# Enter into the directory
cd Sunrise/
# Install the dependencies
npm install
```
## Required permissions
**Important:** Make sure that your bot has the `applications.commands` application scope enabled, which can be found under the `OAuth2` tap on the [developer portal](https://discord.com/developers/applications/)
### 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 Sunrise
# Run the image
docker run -d Sunrise
```
## Starting commands
Before you can use the bots slash command you first need to add them to your Discord server. You can use the `!start` command to do so.
After starting the commands you should be able to see and access them by typing a slash:
## Features & Commands
> Note: The repository now uses the new Discord slash commands
* 🎶 Play music from YouTube via url
`/play YOUTUBE_URL`
* 🎶 Play music from using song name
`/play SONG_NAME`
* 📃 Pause music
`/pause`
* 🎓 Resume music
`/resume`
* 💿 Skip song
`/skip`
* 🔇 Stop music
`/stop`
* 🔀 Shuffle Queue
`/shuffle`
* ↕ Move song position
`/move TRACK_POSITION TARGET_POSITION`
* ↔️ Swap song positions
`/swap POSITION_1 POSITION_2`
* ⏏️ Remove song
`/remove POSITION`
* Now Playing (/nowplaying)
* Get information about a user (/userinfo USER)
* Ban a player (/ban USER)
* Delete the latest chat messages (/purge NUM_OF_MESSAGES)
## 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.
## Contributing
You are welcome to contribute by submitting a Pull Request to the repository.
## Support
[Discord server](https://discord.gg/9tvSEMbYx2)
## Author
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details