botmou is a pre-configured Hubot installation that can be connected to a Google Sheet and/or a Cleverbot instance.

Fork this repository if you want to make some changes or add new scripts. Or you could just clone and deploy it on your server or VPS instance.

Installation

Clone this repository (or your fork):

git clone REPO_URL
cd REPO

# Install packages:
yarn

# Start the bot:
yarn start

Then, in the hubot shell:

# Type:
botmou> botmou ping

# And… 🎉
botmou> Shell: pong

You're ready.

Configuration

Slack integration

You should add the Hubot app in your Slack configuration. It will generate a token.

Configure the HUBOT_SLACK_TOKEN environment variable to bind this bot to your Slack team with the newly generated token.

Don't forget to set a custom name here for your bot.

Using a Google Sheet

First, we need to create a public Google Sheet.

1. Create a copy of this Google Sheet model.
2. Turn on web publishing by going to "File/Publish to web".
3. Copy the Google Sheet link with the big "Share" button on the top right of your sheet.

(You can find more information about this here.)

You have a token inside this link:

# Example:
https://docs.google.com/spreadsheets/d/thisismytoken/

# The token is: thisismytoken

Add this token as an environment variable when launching the bot.

For example, if you want to try the model in your shell, type:

# On macOS or Linux.
env SHEET_TOKEN=10Psb_c2Jgt6lUz4W3QJpZpKdWlGIH9UUtW-SM-pyVYQ yarn start

# On Window (PowerShell)
## This may require admin privileges. Do it only once.
[Environment]::SetEnvironmentVariable("SHEET_TOKEN", "10Psb_c2Jgt6lUz4W3QJpZpKdWlGIH9UUtW-SM-pyVYQ", "Machine")

yarn start

Note: be careful, the sheet is potentially visible by anyone.

Cleverbot

You can also use Cleverbot with your bot. You need to get a token on cleverbot.com.

Try it with:

# On macOS or Linux.
env CLEVERBOT_TOKEN=token yarn start

# On Window (PowerShell)
## This may require admin privileges. Do it only once.
[Environment]::SetEnvironmentVariable("CLEVERBOT_TOKEN", token, "Machine")

yarn start

# In your Hubot shell, type:
botmou: hello my dear bot!

# If it's working, you should get a pseudo-intelligent answer.

Discord

You'll need to create a bot on the Discord dev portal.

Once created use the bot token for botmou.

To add your bot to a server, open the following URL:

https://discordapp.com/oauth2/authorize?client_id=<Bot_Client_ID>&scope=bot&permissions=334912

Replace <Bot_Client_ID> by the bot ID you can see in the URL on the dev portal.

Bot name

The actual name will be configured in the Slack App configuration.

However, if you want to customize the name in your shell, open your package.json file and change botmou by anything you want:

"scripts": {
  "start": "hubot --name \"botmou\"",
  "slack": "hubot --name \"botmou\" --adapter slack",
  "discord": "hubot --name \"botmou\" --adapter discord",
},

Deployment

It's up to you!

But in the end, you should have at least 2 of these 3 variables configured:

• HUBOT_SLACK_TOKEN
• HUBOT_DISCORD_TOKEN
• SHEET_TOKEN (optional)
• CLEVERBOT_TOKEN (optional)
• ANGRY_MODE (optional. Set 0 to disable angryness.)

Otherwise, this bot will be pretty useless.

Docker container

There's a Dockerfile provided with this repository.

Don't forget to set an env-file when starting the container:

docker build -t botmou .
docker run --name botmou --restart always --env-file /path/to/botmou.env -d botmou

Env-file boilerplate:

HUBOT_SLACK_TOKEN=
HUBOT_DISCORD_TOKEN=
CLEVERBOT_TOKEN=
SHEET_TOKEN=
ANGRY_MODE=1

Contributing

Feel free to send a pull request. 🙏

Your code must pass the ESLint check and be formatted through Prettier. Hopefully, this is automagically executed before any commit, so you shouldn't have to worry too much about this.

Also do note that this is a boilerplate repository. It means that a change must be useful to everyone to be accepted. A private joke for you Slack team is for your fork, not this base repository. 😉

(For example, we have multiple custom scripts for our own Pixelnest's botmou, called "Krokmou", like an angry mode, a reaction mode and other special ones — yet, those are purely private jokes and behaviors, so we don't publish them on this repository.)