Adding play command

This commit is contained in:
2023-07-05 09:32:33 -04:00
parent 1d9cd4adcf
commit d54b8d3823
7 changed files with 218 additions and 42 deletions

View File

@@ -4,21 +4,36 @@
A D&D Bot built for Discord. Includes music support and assistant DM tools.
## Running
Visit the [Discord Developer Portal](https://discord.com/developers/applications) and create a new application.
Guides and more information are available [here](https://discord.com/developers/docs/intro).
Visit the [Discord Developer Portal](https://discord.com/developers/applications) and create a new application. Click [here](https://discord.com/developers/docs/intro) for guides and more information.
Required Scopes:
- bot
- application.commands
Example Invite:
```
https://discord.com/api/oauth2/authorize?client_id=<CLIENT_ID>&permissions=40671259392832&scope=bot%20applications.commands
```
- The CLIENT_ID can be found in the General Information tab on the Discord Developer Portal for your application, under `Application ID`
Start the application with `docker compose up -d`
- Requires [Docker](https://www.docker.com/)
## Contributing
Rust must be installed to run locally.
[Rust](https://www.rust-lang.org/) must be installed to run locally.
Furthermore, the following packages must be installed for [serenity-rs/songbird](https://github.com/serenity-rs/songbird)
Furthermore, the following packages must be installed for [serenity-rs/songbird](https://github.com/serenity-rs/songbird). View the repository for additional installation and setup information on other operating systems.
```
sudo apt install libopus-dev
sudo apt install ffmpeg
sudo apt apt install youtube-dl
```
The application can instead be tested from within a docker container.
Copy `.env.TEMPLATE` to `.env` and fill out the fields
Run `cargo run` to begin the application
The application can be tested from within a Docker container:
```
docker build -t siren .
docker run --env-file .env -it --rm --name siren siren
docker run --env-file .env -it --rm --name siren siren:latest
```