39 lines
1.4 KiB
Markdown
39 lines
1.4 KiB
Markdown
<img src="siren.png" alt="drawing" width="200"/>
|
|
|
|
# Siren
|
|
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. 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](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). 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
|
|
```
|
|
|
|
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:latest
|
|
``` |