The Simp'O'Matic

Help Out

Currently some of the features in the HELP.md page, have not yet been implemented. Please my friend, if you have the time, send some pull requests our way.

Yours, Sammy, Danny, Accelarion, Bruno and jack-javana (Pinocchio Tortoise).

Why it is objectively superior

Let's compare it to a similar discord bot, moiph/ub3r-b0t

Ub3r bot was added to the server 3 years ago, and Simp'o'Matic was only added 3 days ago, yet it had already overtaken it by the number of messages! On average it was used almost every minute, while ub3r bot was only used every few hours, so it's great for increasing user activity

— Danny

Help / Bot-Commands

See HELP.md file (keep in mind, that the file has been formatted for better viewing through Discord, might look funky with GitHub rendering).

Getting Up & Running

Make sure you have node (v14.x) and yarn installed (npm also possible). Clone the repo, and init submodules:

git submodule update --init --recursive

• Clean up from previous build/install:

yarn clean

• Install dependencies:

yarn install

• Build/Compile files:

yarn build

• Run the bot locally:

yarn start

When starting the bot, you'll need your secrets set up (API keys etc.).

Local Secrets

Make sure locally, you have the following secrets exported as environment variables:

# Discord
export BOT_API_TOKEN="..."
export CLIENT_KEY="..."
export CLIENT_ID="..."

# RapidAPI for Urban Dictionary and ContextualWeb
export RAPID_API_KEY="..."

# Oxford English Dictionary
export OXFORD_ID="..."
export OXFORD_KEY="..."

# Google APIs
export GOOGLE_API_KEY="..."
export GOOGLE_SEARCH_ID="..."
export GOOGLE_OAUTH_ID="..."
export GOOGLE_OAUTH_SECRET="..."
export GOOGLE_PERSONAL_CODE="..."
export GOOGLE_TYPE="..."
export GOOGLE_PROJECT_ID="..."
export GOOGLE_PRIVATE_KEY_ID="..."
export GOOGLE_PRIVATE_KEY="..."
export GOOGLE_CLIENT_EMAIL="..."
export GOOGLE_CLIENT_ID="..."
export GOOGLE_AUTH_URI="..."
export GOOGLE_TOKEN_URI="..."
export GOOGLE_AUTH_PROVIDER_X509_CERT_URL="..."
export GOOGLE_CLIENT_X509_CERT_URL="..."

# Yandex
export YANDEX_GEOCODER_KEY="..."
export YANDEX_TRANSLATE_KEY="..."

# MapBox
export MAPBOX_KEY="..."

# DarkSky Weather
export DARKSKY_KEY="..."

# JsonBlob
export JSONBLOB_ID="..."

# Web-hooks
export WEB_SECRET="..."

I can send you the secrets file, if I really trust you.

Low on Space?

yarn --global-folder ./node_modules/ --cache-folder ./node_modules/

License

See LICENSE file in repository root.

Dependencies / Project Structure?

This graph should sort that right out for you.