https://github.com/imagineeeinc/amethyst

A beautiful discord music bot
https://github.com/imagineeeinc/amethyst

bot discord discord-bot discord-music-bot music

Last synced: about 9 hours ago
JSON representation

A beautiful discord music bot

• Host: GitHub
• URL: https://github.com/imagineeeinc/amethyst
• Owner: imagineeeinc
• License: other
• Created: 2022-05-11T19:01:10.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-22T11:42:38.000Z (4 months ago)
• Last Synced: 2024-10-18T02:48:47.864Z (about 1 month ago)
• Topics: bot, discord, discord-bot, discord-music-bot, music
• Language: JavaScript
• Homepage: https://imagineee.web.app/projects/Amethyst
• Size: 340 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


	



Amethyst

A beautiful discord music bot


Amethyst is a clean beautiful music bot for discord, built around the ideas of simplicity and ease of use.

Amethyst is also open source so you can host your own versions of it.

Adding the community version to your server


Adding the already deployed version to your server. Is simple as 1,2,3,4,5

1. click the bot adding link: [here](https://discord.com/api/oauth2/authorize?client_id=974030969256411157&permissions=397317107024&scope=bot%20applications.commands)

2. Choose the server to add to

3. Click Continue

4. Authorize it

5. Go to the server and run `/help`

### Downside to using community version

- Sometime shutdowns for maintenance, testing and upgrading

- not always up to date

- Slower on average (depends on the distance between host servers and discord servers)

It is recommended to deploy your own unless you are not a developer.

Deploying your own instance


Deploying your own bot instance is simple as hosting it on any cloud provider.

### Prerequisites

- Node LTS (This was tested on Node 16)

- FFMPEG is installed (you can also run `npm install ffmpeg-static` in the root of the project)

- Setup discord bot from the [discord developer dashboard](https://discord.com/developers/), there are many tutorials on how to setup a bot online

- Environment Variables

	- `TOKEN: `

	- `CLIENT_ID: `

	- `GUILD: ` Optional

### Env alternative

An alternative to using environment variables is using a config file. Create a `config.json` in the root folder, and use this template bellow and fill out the correct values.

```json

{

	"token": "bot-token",

	"clientId": "app-id",

	"guild": "server-id"

}

```

### Running it

Simply install all the dependencies with `npm install`.

To deploy the slash commands, run: `npm run deploy-commands`

To run the standalone bot, run: `npm run bot`

To deploy commands and run the bot in one command, run: `npm start` 

### Deploying Using Docker

There is a Docker file provided, so just build the image and run the container in the root of the project, provide ENV Variables(or use the [env alternative](#env-alternative)) and it should work.

License


This bot/ project is under [TCI](https://github.com/imagineeeinc/Amethyst/blob/main/LICENSE) License.