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
145 Commits 4 Branches 3 Tags 120 MiB
Rust 99.2%
Dockerfile 0.5%
Shell 0.3%
365d1df4ce
Go to file
jude 365d1df4ce Bump version
2022-09-13 12:38:11 +01:00
.idea Remove unused files. Fix compiler warnings. Update help 2022-09-13 10:46:45 +01:00
migrations Join sounds per-server 2022-07-31 14:56:38 +01:00
src Add paging for list commands 2022-09-13 12:37:50 +01:00
.gitignore gitignore 2020-09-03 14:56:08 +01:00
Cargo.lock Bump version 2022-09-13 12:38:11 +01:00
Cargo.toml Bump version 2022-09-13 12:38:11 +01:00
LICENSE Create LICENSE 2020-09-21 09:26:55 +00:00
README.md Join sounds per-server 2022-07-31 14:56:38 +01:00
rustfmt.toml rustfmt. removed gating on creating user rows for join sounds 2021-09-16 22:04:48 +01:00

README.md

SoundFX

A bot for managing sound effects in Discord.

Building

sudo apt install gcc gcc-multilib cmake ffmpeg

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

Use the Cargo.toml file to build it. Needs Rust 1.52+

Running & Config

The bot connects to the MySQL server URL defined in a .env file in the working directory of the program.

Config options:

  • DISCORD_TOKEN- your token (required)
  • DATABASE_URL- your database URL (required)
  • 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/)
  • UPLOAD_MAX_SIZE- specifies the maximum upload size to permit in bytes. Defaults to 2MB