a battling system for slack
Python
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
data
saltbeef
setup
.gitignore
README.md
config-sample.py
requirements.txt
scrot.png
server.py

README.md

Battle in Slack

Resolve beefs or make tough decisions by duking it out!

(sadly, image generation has been removed because the API that it relied on is now gone)

Setup

Config

Copy the config-sample.py to config.py and add the following values:

  • Slack Webhook URL (see below for more info)

Database

To setup the database, run the following from a Python interpreter:

from saltbeef import db
db.create_all()

For simplicity, this just runs off of sqlite.

Hosting

Example nginx and supervisor config scripts are in the setup folder.

Slack

You can then go to your Slack team's integration page and:

  1. Add an Incoming Webhook. Get the URL Slack provides and add it in the config.py file (see config-sample.py for the format).
  2. Add a Slash Command. For instance, /saltbeef, and point it to the root of the app. For instance, if you're hosting it at saltbeef.myserver.com, point the slash command to http://saltbeef.myserver.com/.

Then from within the Slack channel you setup, you can run /saltbeef help to see a list of available commands.

Usage

The following commands are available:

  • battle <username> - fight a user
  • items - list your items
  • equip <item #> equip an item for the next battle (one-time use)
  • creatures - list your creatures
  • ichoose <creature #> - choose a creature for your next battle
  • capture - catch a new creature
  • leaderboard - view the best trainers

To Do

  • add in experience/leveling up/EVOLUTION??
  • add in types and strengths/weaknesses??