https://github.com/danrpts/discord-soundboard
A friendly and customizable soundboard bot for Discord! Bot Status: OFFLINE
https://github.com/danrpts/discord-soundboard
bot discord discord-bot discord-soundboard nodejs soundboard
Last synced: 3 months ago
JSON representation
A friendly and customizable soundboard bot for Discord! Bot Status: OFFLINE
- Host: GitHub
- URL: https://github.com/danrpts/discord-soundboard
- Owner: danrpts
- License: mit
- Created: 2020-12-27T11:13:00.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-01-22T08:54:49.000Z (over 4 years ago)
- Last Synced: 2024-12-31T00:33:41.259Z (5 months ago)
- Topics: bot, discord, discord-bot, discord-soundboard, nodejs, soundboard
- Language: JavaScript
- Homepage: https://discord.com/oauth2/authorize?client_id=792651273387638815&permissions=8192&scope=bot
- Size: 621 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# discord-soundboard
A friendly and customizable soundboard bot for Discord! 🤖
## Features
- Play sounds from around the net
- Set greetings for users when they enter voice channel
- Save sounds, greetings, and volumes across all your server's voice channels
- Clone soundboards from your other servers
## One-Click Bot
SoundByte is ready to join your server at the click of a link. Please provide the bot with "Manage Messages" permission for the best experience while using the !list command.
## Usage
By default the bot uses `!` for the command prefix, which you can may change using `!prefix`.
Below is a minimum set of commands to get started. Use `!help` to see more!
| Command | Description |
| ------- | ------------------------------------------------------ |
| `!add` | Add a sound to your server's soundboard. |
| `!list` | List or search for sounds in your server's soundboard. |
| `!play` | Plays a sound over your current voice channel. |
## Development
First of all, you need to clone the repo:
`git clone [email protected]:danrpts/discord-soundboard.git`
### Requirements
We'll be using Docker to simplify development, testing, and deployment. Please [install Docker](https://docs.docker.com/get-docker/) before moving to the next step.
### Configuration
All configuration for the bot is provided through environment variables. The table below is a minimum set you may want to provide for development. Make sure you [follow this awesome tutorial](https://youtu.be/ibtXXoMxaho) to create your `DISCORD_TOKEN` through the [Discord Developer Portal](https://discord.com/developers/applications).
| Variable | Description | Required? |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------- | --------- |
| DATABASE_URL | A PG [connection string](https://github.com/brianc/node-postgres/tree/master/packages/pg-connection-string#connection-strings). | NO |
| DISCORD_TOKEN | Your secret Discord bot token. | YES |
| DISCORD_OWNER_ID | A Discord user id associated with the bot. | NO |
### Fire 'er Up! 🚀
Now, you're ready. Set the `DISCORD_TOKEN` environment variable and use `docker-compose` from the root of your project directory:
```
DISCORD_TOKEN="place_your_bot_token_here"\
docker-compose -f docker-compose.yml -f docker-compose.dev.yml up
```
## Deployment
❗WIP
## Support
❗WIP
## Contributing
❗WIP
[Contribution guidelines for this project](CONTRIBUTING.md)
## License
[License agreement for this project](LICENSE)