Showoff is a slack bot based on the hubot framework, designed to make it easy for users to show off their Destiny weapons (and now armor!) in slack. The goal is to enable users to share weapon information with as few inputs as possible.
This project was originally based off of slack-destiny-bot.
Showoff only requires at most 3 inputs, directed at the bot (order does matter):
- XBL/PSN gamertag
- console network ("xbox" or "playstation")
- weapon slot ("primary", "special", "heavy")
If armor is enabled, it can be shown with: "head", "chest", "arms", "legs", "class", "ghost".
The standard usage looks like this:
@bot-name MyGamertag xbox primary
with a response looking like (active nodes in bold):
Showoff automatically looks at your most recently played character when grabbing the weapon data.
If your slack profile's first name (not username) matches your gamertag, you can omit this entirely.
@bot-name xbox special
If you don't include a console network, showoff will automatically search both.
@bot-name MyGamertag heavy
Note that if the gamertag exists on both networks, this will not work.
Combining these options, the bot will pull your slack first name, and search both networks for the specified weapon with a single input.
@bot-name primary
If you want to test out the bot before using it in a public channel, try sending it a direct message. You do not need "@bot-name" when you are messaging the bot directly, just the inputs.
- Xbox users must use an underscore ( _ ) for any spaces in their gamertag when inputting it directly. This is not necessary in the first name field of your slack profile; spaces will work fine.
- As stated above, Showoff automatically looks at your most recently played character. This was ultimately an intentional decision to limit the number of inputs needed and simplify using the bot.
First clone the repo locally:
git clone [email protected]:phillipspc/showoff.git
To deploy to heroku, cd into the newly created folder then follow these steps:
- Install heroku toolbelt if you haven't already.
- Activate the Hubot service on your "Team Services" page inside Slack.
heroku create my-new-slackbotheroku addons:create rediscloud:30git push heroku master
You'll need to add the following config variables (easiest way is through the Heroku Dashboard). Get a Bungie API key
HEROKU_URL=https://my-new-slackbot.herokuapp.com
HUBOT_SLACK_TOKEN=your-slack-token-here
BUNGIE_API_KEY=your-bungie-key-here
By default, the bot can show weapons AND armor. To restrict to just weapons, use the variable:
SHOW_ARMOR=false