Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/meridiangh/suitbot
A lightweight music and general purpose bot with dashboard that uses slash commands and integrations to be as user-friendly as possible!
https://github.com/meridiangh/suitbot
bot discord discord-bot discord-js discordjs erelajs music nodejs
Last synced: 3 months ago
JSON representation
A lightweight music and general purpose bot with dashboard that uses slash commands and integrations to be as user-friendly as possible!
- Host: GitHub
- URL: https://github.com/meridiangh/suitbot
- Owner: MeridianGH
- License: gpl-3.0
- Archived: true
- Created: 2021-09-15T12:06:50.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-07T19:31:01.000Z (about 1 year ago)
- Last Synced: 2024-09-28T08:42:43.810Z (3 months ago)
- Topics: bot, discord, discord-bot, discord-js, discordjs, erelajs, music, nodejs
- Language: JavaScript
- Homepage: https://suitbot.xyz
- Size: 53.9 MB
- Stars: 78
- Watchers: 1
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://discord.com/oauth2/authorize?client_id=887122733010411611&scope=bot%20applications.commands&permissions=2167425024)
[](https://discord.gg/qX2CBrrUpf)
[](https://github.com/MeridianGH/suitbot/blob/main/LICENSE.md)
> This repository has been archived in favor of the newer and improved, but slightly stripped down version **[Kalliope](https://github.com/MeridianGH/Kalliope)**.
# SuitBot
> A lightweight music and general purpose bot with dashboard, that uses slash commands and buttons to be as user-friendly as possible!
[](https://suitbot.xyz)
[](https://github.com/MeridianGH/suitbot/projects/1)
[](https://discord.gg/qX2CBrrUpf)
Table of Contents
- [Invite](#invite)
- [Features](#features)
- [Commands](#commands)
- [Installation](#installation)
- [Stats](#stats)
- [Licensing](#licensing)
---
## Invite
> Disclaimer: The bot is still in development, so expect some bugs or features that might not work 100% yet. Please report any bugs or suggestions via the respective commands.
[](https://discord.com/oauth2/authorize?client_id=887122733010411611&scope=bot%20applications.commands&permissions=2167425024)
## Features
- Slash commands
- Use commands directly integrated in Discord
- No more guessing with variables
- Quick overview of all commands
- Music
- Supports many sources (YouTube, Spotify, Bandcamp, SoundCloud, Twitch, Vimeo or any other HTTP source)
- Supports playlists and livestreams
- Interactive Web Dashboard
- Pause, Skip, Remove, Volume and more commands
- Language support
- Supports multiple languages
- Change the language for your server using `/language`
- Add your own language by contacting me on the Discord server
- Activities
- Create invites for Discord Activities
- YouTube Together and a lot of fun minigames
- Have fun with everyone in your voice channel
- Basic Moderation
- Info commands (User, Server, Avatar)
- Kick, Ban, Move, Slowmode and more commands
- Permission check on commands
## Commands
SuitBot uses slash commands to integrate itself into the server. You can easily access its commands directly by typing `/` in your chat window.
Show all commands
### General
| Command | Description |
|-------------|-------------------------------------------|
| /activity | Creates a Discord activity. |
| /dashboard | Sends a link to the dashboard. |
| /help | Replies with help on how to use this bot. |
| /info | Shows info about the bot. |
| /invite | Sends an invite link for the bot. |
| /language | Changes the bots language. |
| /ping | Replies with the current latency. |
| /serverinfo | Shows info about the server. |
| /userinfo | Shows info about a user. |
### Music
| Command | Description |
|-------------|-------------------------------------------------------------------|
| /clear | Clears the queue. |
| /filter | Sets filter modes for the player. |
| /lyrics | Shows the lyrics of the currently playing song. |
| /nowplaying | Shows the currently playing song. |
| /pause | Pauses playback. |
| /play | Searches and plays a song or playlist from YouTube or Spotify. |
| /previous | Plays the previous track. |
| /queue | Displays the queue. |
| /remove | Removes the specified track from the queue. |
| /repeat | Sets the current repeat mode. |
| /resume | Resumes playback. |
| /search | Searches five songs from YouTube and lets you select one to play. |
| /seek | Skips to the specified point in the current track. |
| /shuffle | Shuffles the queue. |
| /skip | Skips the current track or to a specified point in the queue. |
| /stop | Stops playback. |
| /volume | Sets the volume of the music player. |
### Moderation
| Command | Description |
|-----------|---------------------------------------------------------------|
| /ban | Bans a user. |
| /kick | Kicks a user. |
| /move | Moves the mentioned user to the specified channel. |
| /moveall | Moves all users from the first channel to the second channel. |
| /purge | Clears a specified amount of messages. |
| /slowmode | Sets the rate limit of the current channel. |
### Feedback
| Command | Description |
|-------------|---------------------------------------|
| /bugreport | Reports a bug to the developer. |
| /github | Sends a link to the repo of this bot. |
| /suggestion | Sends a suggestion to the developer. |
## Installation
It is not recommended to try and install SuitBot yourself. \
The bot is not designed to be easily installable and requires many complicated steps to set up.
If you want a self-hostable bot, keep looking around GitHub for better alternatives!
If you nevertheless decide to try and host a custom version of SuitBot yourself keep on reading.
Installation
## Local Installation
### Prerequisites
- Node.js v16.x
- FFmpeg v4.4
- Java v13.x
### Installing
```shell
git clone https://github.com/MeridianGH/suitbot.git
cd suitbot
npm install
```
### Configuration
Rename `config_example.json` to `config.json` and replace the placeholders inside with your info:
- A Discord Bot Token (**[Guide](https://discordjs.guide/preparations/setting-up-a-bot-application.html#creating-your-bot)**)
- Your Application ID which you can find the the `General Information` tab in your Discord application.
- Your Client Secret which is under `OAuth2` in your Discord application.
- The Guild ID of the server in which you want to test the bot. To get this ID, activate `Developer Mode` in Discord's options and right-click your server.
- Your User ID of your Discord account which will be your Admin-Account for the bot. Right-click yourself with `Developer Mode` activated.
- Get your YouTube keys like described in this **[Guide](https://github.com/Walkyst/lavaplayer-fork/issues/18)**. Once you have `PAPISID` and `PSID` set them in the config.
- Create a Genius API application **[here](https://docs.genius.com/)**, generate an access token and paste it here. Can be an empty string.
### Setting up
#### Discord
Go to your Discord Application, go to `OAuth2` and add `http://localhost/callback` to `Redirects`.
#### Domain
Replace the domain in `dashboard.js` with your domain. \
If you want to redirect from HTTP to HTTPS, make sure to replace the domains in the function `forceDomain()` as well.
#### Database
Install PostgreSQL and create a database `suitbot`.
If you choose to name it differently, set the database URL in `database.js`.
Create a table using the following command:
```
CREATE TABLE servers (
id varchar(30) UNIQUE NOT NULL,
locale varchar(5) NOT NULL
);
```
### Deploying
Use `node deploy-commands.js` to update and add commands in the guild you specified and `node deploy-commands.js global` to update the commands globally.\
Guild commands are refreshed instantly while global commands can take up to an hour.
Start the bot with
```shell
node .
```
\
To start the bot for production use one of these specific for your platform
```shell
npm run start:win
npm run start:unix
```
---
## Stats
### Size
### Code
\
[](https://www.codefactor.io/repository/github/meridiangh/suitbot)
[](https://libraries.io/github/MeridianGH/suitbot)
\
[](https://www.npmjs.com/package/discord.js)
[](https://www.npmjs.com/package/play-dl)
### GitHub
[](https://github.com/MeridianGH/suitbot/issues)
[](https://github.com/MeridianGH/suitbot/pulls)
\
[](https://github.com/MeridianGH/suitbot/commits)
[](https://github.com/MeridianGH/suitbot/graphs/commit-activity)
\
[](https://github.com/MeridianGH/suitbot/stargazers)
[](https://github.com/MeridianGH/suitbot/watchers)
### Dashboard
[](https://suitbot.xyz)
## Licensing
If you want to host your own version of SuitBot, with or without modifications to the source code or plan to use any part of this source code, you must disclose the source and reference this repository/license.
[](https://github.com/MeridianGH/suitbot/blob/main/LICENSE.md)