A slack bot that moderates Werewolf games
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 15 commits behind JosephRedfern:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
.dockerignore
.env.default
.gitignore
CHANGELOG
Dockerfile
README.md
bot.php
composer.json
composer.lock

README.md

Slackwolf

Slackwolf is a bot for Slack. After inviting the bot to a channel, you can play the timeless game of Werewolf (also called Mafia).

ProjectImage

Roles

Slackwolf currently supports Seer, Bodyguard, Witch, Lycan, Tanner, Beholder, Villager, Wolfman, and Werewolf. You'll need at least a 6 player game in order to see roles other than Seer/Villager/Werewolf given out.

How to play

/invite the bot (and some friends) to a channel and type !help

Installation via Docker

Run the below command to start a container.

docker run -d --name slackwolf --restart always \
   -e "BOT_TOKEN=xoxb-16776859568-RxBtmpeS7isMAQonAEqS1hYLb" \
   -e "TIMEZONE=America/Los_Angeles" \
   -e "BOT_NAME=werewolf-moderator" \
   -e "DEBUG=1" \
   gillisct/slackwolf

Source Installation

If you don't want to use docker, you can install from source.

Slackwolf requires PHP 5.5+ and Composer.

git clone http://github.com/chrisgillis/slackwolf
cd slackwolf
composer install

Rename .env.default to .env and edit it with a valid real-time messaging bot token from Slack. Get a valid token from the "Custom Integrations" tab of your Slack "Configure Apps" page. Also be sure to put the correct bot name in the .env file as well.

To start the bot type php bot.php

Contributing

We're very accepting of pull requests. This is a fun project to get your feet wet with PHP or open source. If you're making a large change, create an Issue first and lets talk about it.

License

MIT License.