CerealBot

Only for the most Cereal people

A Discord Bot for memes, airhorn noises and even more cereal things!

NPM commands

npm start # Start server
npm run build # Build server to lib
npm test # Run tests
npm run pretty # Consistent formatting
npm run clean # Remove node modules
npm run clean-install # Clean and reinstall node modules

Docker

Useful Docker commands are added to the package.json:

npm run docker-pull
npm run docker-build
npm run docker-push
npm run docker-run

The repository used to store the Docker image is here on Github.

Configuration

Passwords and tokens are passed with environment variables. To connect the bot to Discord a BOT_TOKEN is required.

General configuration is done through the config.json.

ConfigFile

Current required items in config.json:

{
    "DISCORD": {
        "PREFIX": "!",
        "MAX_PREFIX_LENGTH": 3,
        "EMBED": {
            "DESC_CHAR_LIMIT": 2048,
            "FIELD_CHAR_LIMIT": 1024,
            "TITLE_CHAR_LIMIT": 256
        }
    },
    "DATABASE": {
        "PATH_TO_MIGRATION_FILES": "./lib/data/migrations"
    },
    "AUDIO_FILE_FORMAT": ".ogg",
    "IMGUR": {
        "AUTHORIZATION": "Client-ID <API_KEY>",
        "URL": "https://api.imgur.com/3/gallery/t/meme/top/week/1"
    },
    "HACKERNEWS": {
        "BASE_URL": "https://hacker-news.firebaseio.com/v0",
        "BESTSTORIES": "/beststories",
        "STORY": "/item/",
        "URL_SUFFIX": ".json",
        "COMMENT_URL": "https://news.ycombinator.com/item?id="
    },
    "URBAN": {
        "URL": "https://api.urbandictionary.com/v0/define?"
    },
    "COCKTAIL": {
        "BASE_URL": "https://www.thecocktaildb.com/api/json/",
        "API_VERSION": "v1/",
        "API_KEY": "1/",
        "RANDOM_URL": "random.php",
        "SEARCH_INGREDIENT": "filter.php?i=",
        "SEARCH_LETTER_URL": "search.php?f=",
        "SEARCH_URL": "search.php?s="
    },
    "MEME": {
        "SYNC_AT_MIDNIGHT": "0 0 * * *",
        "TABLE_NAME": "meme"
    }
}

Converting audio types

Using opusenc it is very simple to convert a .wav to opus/.ogg:

opusenc --bitrate 256 <input_file.wav> <output_file.ogg>

Testing

To run the tests, use npm run tests. Some of the tests are property based tests using fast-check. It requires a rerun with a specific seed, in case a test fails. Please consult the official docs on how to replay a seed: https://github.com/dubzzz/fast-check/blob/main/documentation/Tips.md#replay-after-failure.

Used resources

Pictures

• Bru-No

  • Empty bottle

Sounds

The sound effects are provided by:

• Mike Koening

  • Airhorn
  • Fog Horn
  • Cow Moo

• Daniel Simion

  • Fire Truck
  • Dixie Horn

• snootyboy

  • Warning Siren

• StickInTheMud

  • Bike Horn

• Daveincammas

  • Police Siren