Simp-O-Matic

Dumb Discord bot in TS.
git clone git://git.knutsen.co/Simp-O-Matic
Log | Files | Refs | README | LICENSE

README.md (3458B)

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

Screenshot 2020-03-21 at 4 15 0 Screenshot 2020-03-21 at 4 14 34

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

yarn clean

yarn install

yarn build

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. GNU Affero GPLv3 (AGPL-3.0)

Dependencies / Project Structure?

This graph should sort that right out for you.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# The Simp'O'Matic

<p align="center">
  <img width="300" src="https://raw.githubusercontent.com/Demonstrandum/Simp-O-Matic/master/lib/resources/banners/logo-text-outlines.svg">
</p>

## 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](https://github.com/Demonstrandum), [Danny](https://github.com/danyisill), [Accelarion](https://github.com/Accelarion), [Bruno](https://github.com/0-l) and [jack-javana (Pinocchio Tortoise)](https://github.com/jack-javana).

## Why it is objectively superior

Let's compare it to a similar discord bot, [moiph/ub3r-b0t](https://github.com/moiph/ub3r-b0t)

![Screenshot 2020-03-21 at 4 15 0](https://user-images.githubusercontent.com/23189912/77216413-3084d980-6b2b-11ea-8efe-e952dd7a1cb5.png)
![Screenshot 2020-03-21 at 4 14 34](https://user-images.githubusercontent.com/23189912/77216414-31b60680-6b2b-11ea-8360-17113b5919bf.png)

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](./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:
```sh
git submodule update --init --recursive
```

- Clean up from previous build/install:
```sh
yarn clean
```
- Install dependencies:
```sh
yarn install
```
- Build/Compile files:
```sh
yarn build
```
- Run the bot locally:
```sh
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:
```sh
# 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?
```sh
yarn --global-folder ./node_modules/ --cache-folder ./node_modules/
```

## License
See `LICENSE` file in repository root.
![GNU Affero GPLv3 (AGPL-3.0)](https://upload.wikimedia.org/wikipedia/commons/0/06/AGPLv3_Logo.svg)

## Dependencies / Project Structure?

[This graph](http://npm.broofa.com/?q=simp-o-matic) should sort that right out for you.