jude/soundfx-bot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity
Discord bot for custom sound effects and soundboards
124 Commits 4 Branches 3 Tags 120 MiB
Rust 99.2%
Dockerfile 0.5%
Shell 0.3%
821f283969
Go to file
jellywx 821f283969 updated readme
2022-01-31 12:36:46 +00:00
.cargo cargo config. extracted play functionality. volume can be modified hopefully 2020-05-19 16:29:57 +01:00
.idea roles are now stored individually on the guild. 2021-09-03 11:33:55 +01:00
audio added a couple of ambience sounds 2021-03-27 17:56:15 +00:00
migrations roles are now stored individually on the guild. 2021-09-03 11:33:55 +01:00
src generics for Database pool 2022-01-30 15:55:53 +00:00
.gitignore gitignore 2020-09-03 14:56:08 +01:00
Cargo.lock lots of things and stuff 2022-01-25 22:59:05 +00:00
Cargo.toml lots of things and stuff 2022-01-25 22:59:05 +00:00
LICENSE Create LICENSE 2020-09-21 09:26:55 +00:00
README.md updated readme 2022-01-31 12:36:46 +00:00
rustfmt.toml rustfmt. removed gating on creating user rows for join sounds 2021-09-16 22:04:48 +01:00

README.md

SoundFX 2

The complete (second) Rust rewrite of SoundFX

SoundFX 2 is the Rust rewrite of SoundFX. SoundFX 2 attempts to retain all functionality of the original bot, in a more efficient and robust package. SoundFX 2 is as asynchronous as it can get, and runs on the Tokio runtime.

Building

Run the migrations in the migrations directory to set up the database.

Use Cargo to build the executable.

Running & Config

The bot connects to the MySQL server URL defined in the environment.

Environment variables read:

  • DISCORD_TOKEN- your token (required)
  • DATABASE_URL- your database URL (required)
  • UPLOAD_MAX_SIZE- specifies the maximum file size to allow in bytes (defaults to 2097152 (2MB))
  • MAX_SOUNDS- specifies how many sounds a user should be allowed without Patreon
  • PATREON_GUILD- specifies the ID of the guild being used for Patreon benefits
  • PATREON_ROLE- specifies the role being checked for Patreon benefits
  • CACHING_LOCATION- specifies the location in which to cache the audio files (defaults to /tmp/)

The bot will also consider variables in a .env file in the working directory.