Fixed docker containers
This commit is contained in:
53
README.md
53
README.md
@@ -4,8 +4,10 @@
|
||||
</div>
|
||||
|
||||
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
|
||||
- Music commands from Youtube and locally hosted files
|
||||
- Database for D&D 5e content
|
||||
- Session scheduling
|
||||
- Backend API
|
||||
- ChatGPT integration
|
||||
|
||||
## Requirements
|
||||
@@ -80,6 +82,7 @@ Siren utilizes Discord slash commands. To view the commands, run `/help` in a se
|
||||
| `/resume` | Resume the current track |
|
||||
| `/skip` | Skip the current track |
|
||||
| `/stop` | Stop the current track |
|
||||
| `/mute` | Mute the current track |
|
||||
| `/queue` | ***TODO*** - Display the current queue |
|
||||
| `/clear` | ***TODO*** - Clear the current queue |
|
||||
| `/shuffle` | ***TODO*** - Shuffle the current queue |
|
||||
@@ -111,48 +114,16 @@ Siren utilizes Discord slash commands. To view the commands, run `/help` in a se
|
||||
| `/help` | ***TODO*** - Display a list of commands |
|
||||
|
||||
## Contributing
|
||||
[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.
|
||||
|
||||
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.
|
||||
<details>
|
||||
<summary>Unix Installation</summary>
|
||||
Notes:
|
||||
|
||||
- [yt-dlp](https://github.com/yt-dlp/yt-dlp/releases) is preferred over youtube-dl.
|
||||
|
||||
```
|
||||
sudo apt install libopus-dev
|
||||
sudo apt install ffmpeg
|
||||
sudo apt apt install youtube-dl # See notes above
|
||||
# PostgreSQL Headers
|
||||
sudo apt install libpq5
|
||||
sudo apt install libpq-dev
|
||||
```
|
||||
|
||||
- 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).
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary>Mac Installation</summary>
|
||||
Notes:
|
||||
|
||||
- [Homebrew](https://brew.sh/) must be installed to run the following commands.
|
||||
- [youtube-dl](https://formulae.brew.sh/formula/youtube-dl#default) is deprecated, [yt-dlp](https://formulae.brew.sh/formula/yt-dlp) is preferred
|
||||
|
||||
```
|
||||
brew install opus
|
||||
brew install ffmpeg
|
||||
brew install yt-dlp # See notes above
|
||||
brew install postgresql
|
||||
```
|
||||
</details>
|
||||
- [Rust](https://www.rust-lang.org/)
|
||||
- [yt-dlp](https://github.com/yt-dlp/yt-dlp)
|
||||
- [ffmpeg](https://github.com/yt-dlp/FFmpeg-Builds)
|
||||
|
||||
### Running Locally
|
||||
1. Start the backend containers with `make docker-refresh`
|
||||
2. Start the application with `make run`
|
||||
1. Start the backend containers with `make backend-up`
|
||||
2. Run the application locally with `make run`
|
||||
|
||||
The application can also be tested from within a Docker container:
|
||||
```
|
||||
docker build -t siren:latest .
|
||||
docker run --env-file .env -it --rm --name siren siren:latest
|
||||
make docker-build
|
||||
make docker-up
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user