Skip to content

alephtwo/omgbot

Repository files navigation

omgbot

omgbot is a Discord bot inspired by the Discord team's original example bot, airhorn.solutions.

It provides a set of commands, each mapped to "short" sound clips. When a command is issued, the following occurs:

  1. A sound is chosen for the given command.
  2. If the user issuing the command is in a voice channel, the bot joins that voice channel.
  3. The bot plays the sound in the voice channel or uploads it to the text channel the user issued the command in.
  4. If the bot joined a voice channel to play the sound, it leaves the channel.

Usage

omgbot --discord-token "${your_token}" "${your_sound_dir}"
# or
DISCORD_TOKEN="${your_token}" omgbot "${your_sound_dir}"

Configuration

Configuration is provided via command line arguments.

Flag Description
--discord-token The Discord token to authenticate with
--volume The volume to play sounds at. (0-100, Default 25)

Development

  1. Install nextest and cargo-mutants.
  2. Run tests with cargo nextest run.
    1. Try to address any mutants by iterating with cargo mutants.
  3. Ensure linting and formatting passes:
    1. cargo clippy
    2. cargo fmt

About

A Discord bot inspired by airhorn.solutions, but with custom sounds

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages