bsherriff/siren
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

InactiveHandler on track end

Browse Source
This commit is contained in:
Benjamin Sherriff
2023-07-05 19:23:26 -04:00
parent 6f66564377
commit 7f89c7a4be
3 changed files with 62 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -1,7 +1,11 @@
<img src="siren.png" alt="drawing" width="200"/>
<div align="center">
<img src="siren.png" alt="drawing" width="200"/>
<h1 align="center">Siren</h1>
</div>
# Siren
A D&D Bot built for Discord. Includes music support and assistant DM tools.
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](https://discord.com/developers/applications) and create a new application. Click [here](https://discord.com/developers/docs/intro) for guides and more information.
@@ -16,11 +20,12 @@ https://discord.com/api/oauth2/authorize?client_id=<CLIENT_ID>&permissions=40671
```
- 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/)
1. Copy `.env.TEMPLATE` to `.env` and fill out the fields
2. 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.
[Rust](https://www.rust-lang.org/) must be installed to run locally. See [serenity-rs/serenity](https://github.com/serenity-rs/serenity) for more information about Rust Discord API Library.
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.
```
@@ -29,12 +34,11 @@ sudo apt install ffmpeg
sudo apt apt install youtube-dl
```
Requires [yt-dlp](https://github.com/yt-dlp/yt-dlp#installation) and potentially [yt-dlp FFmpeg Static Auto-Builds](https://github.com/yt-dlp/FFmpeg-Builds)
Potentially requires [yt-dlp](https://github.com/yt-dlp/yt-dlp#installation) and [yt-dlp FFmpeg Static Auto-Builds](https://github.com/yt-dlp/FFmpeg-Builds).
Copy `.env.TEMPLATE` to `.env` and fill out the fields
Run `cargo run` to begin the application
Begin the application with `cargo run`
The application can be tested from within a Docker container:
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