imhaleyfyi/grumpycat

Slack bot with some simple utilities

#grumpycat

Slack bot with some simple utilities

Set up

1. Set up a new Slack Bot in your Slack Custom Integrations
   • username "grumpycat" is suggested
   • you can use the profile image/icon from above
2. Copy the API token from the bot settings page to your clipboard
3. Click this button:
   
4. Paste the API Token in the SLACK_API_TOKEN environment variable on Heroku
   • Optional: set ADMIN_USERS and/or BANNED_USERS environment variables to set permanent Admin users/permanently Banned users
5. Click "Deploy for Free"

Features

Karma

• Keeps track of a user's karma
• Usage: @username++ or @username--
• Code: /src/events/karma.js

Decide

• Decides between two (or more) things
• Usage: !decide this or that
• Code: /src/events/decide.js

Info

• Records/retrieves information
• Usage:
  • Record info: !learn [key] as [value]
  • Retrieve info: !info [key]
  • Forget info: !forget [key]
  • Search info: !find [key]
    • Does a search on the keys in the database for the queried key.
• Code: /src/events/info.js

Permissions/Admin tools

• The permissions modifiers are isBanned and isAdmin
• Banned users cannot perform any Karma operations (@username++ or @username--).
• Admin users have access to the following commands:
  • !admin ban @username - bans a user
  • !admin unban @username - unbans a user
  • !admin promote @username - promotes a user to Admin
  • !admin demote @username - demotes a user from Admin
  • !admin setKarma @username [karmaAmount] - sets karma value on user
• The initial (and permanent) Admin users should be set in a comma-delimited list in the ADMIN_USERS environment variable.
• You can also optionally set permanently banned users in a comma-delimited list in the BANNED_USERS environment variable.
• Code: /src/events/admin.js

Task tracker

• Add new completed tasks with !done [task]
• Retrieve all completed tasks from today with !done
• Code: /src/events/done.js

Eightball

• Ask grumpycat questions with @grumpycat [your question here]?, and he will respond
• Code: /src/events/eightball.js

Contributing

Submit an issue or open a pull request if you want to help contribute to the project.

(MIT License) - Copyright (c) 2016 Joah Gerstenberg