siren/README.md

Siren

Siren is a D&D Bot built for Discord, written in Rust. Features include:

• Play tracks from Youtube or locally hosted files
• Assistant DM tools to be defined later

Running

Visit the Discord Developer Portal and create a new application. Click here 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

1. Copy .env.TEMPLATE to .env and fill out the fields
2. Start the application with docker compose up -d
   • Requires Docker

Contributing

Rust must be installed to run locally. See serenity-rs/serenity for more information about Rust Discord API Library.

Furthermore, the following packages must be installed for 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

Potentially requires yt-dlp and yt-dlp FFmpeg Static Auto-Builds.

Begin the application with cargo run

The application can also be tested from within a Docker container:

docker build -t siren .
docker run --env-file .env -it --rm --name siren siren:latest