werewolf-slack: A chat interface for playing werewolf in Slack
Downloads
- werewolf-slack-1.0.0.0.tar.gz [browse] (Cabal source package)
- Package description (revised from the package)
Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.
Maintainer's Corner
For package maintainers and hackage trustees
Candidates
- No Candidates
| Versions [RSS] | 0.1.0.0, 0.2.0.0, 0.2.0.1, 0.2.0.2, 0.3.0.0, 0.3.0.1, 0.3.0.2, 0.4.0.0, 1.0.0.0, 1.0.1.0, 1.0.1.1, 1.0.1.2, 1.0.1.3, 1.0.1.4, 1.0.1.5, 1.0.2.0 |
|---|---|
| Change log | CHANGELOG.md |
| Dependencies | aeson (>=0.8 && <0.12), base (>=4.8 && <5), bytestring (>=0.10 && <0.11), extra (>=1.4 && <1.5), http-client (>=0.4 && <0.5), http-client-tls (>=0.2 && <0.3), http-types (>=0.9 && <0.10), mtl (>=2.2 && <2.3), optparse-applicative (>=0.12 && <0.13), process (>=1.2 && <1.3), text (>=1.2 && <1.3), wai (>=3.2 && <3.3), warp (>=3.2 && <3.3), werewolf (>=0.5 && <1.1) [details] |
| License | BSD-3-Clause |
| Author | Henry J. Wylde |
| Maintainer | public@hjwylde.com |
| Revised | Revision 2 made by hjwylde at 2016-04-13T22:03:54Z |
| Category | Game |
| Home page | https://github.com/hjwylde/werewolf-slack |
| Source repo | head: git clone git@github.com:hjwylde/werewolf-slack |
| Uploaded | by hjwylde at 2016-04-13T21:19:47Z |
| Distributions | |
| Reverse Dependencies | 1 direct, 0 indirect [details] |
| Executables | werewolf-slack |
| Downloads | 10442 total (6 in the last 30 days) |
| Rating | (no votes yet) [estimated by Bayesian average] |
| Your Rating | |
| Status | Docs not available [build log] All reported builds failed as of 2016-11-27 [all 3 reports] |
Readme for werewolf-slack-1.0.0.0
[back to package description]werewolf-slack
A chat interface for playing werewolf in Slack. Werewolf is a well known social party game, commonly also called Mafia. See the Wikipedia article for a rundown on it's gameplay and history.
Game description
Long has the woods been home to wild creatures, both kind and cruel. Most have faces and are known to the inhabitants of Fougères in Brittany, France; but no-one from the village has yet to lay eyes on the merciless Werewolf.
Each night Werewolves attack the village and devour the innocent. For centuries no-one knew how to fight this scourge, however recently a theory has taken ahold that mayhaps the Werewolves walk among the Villagers themselves...
Objective of the Game:
For the Loners: complete their own objective.
For the Villagers: lynch all of the Werewolves.
For the Werewolves: devour all of the Villagers.
Setup
Preparing Slack
Set up an Incoming Webhook here. Make note of the webhook url, we'll be using that soon.
Set up a Slash Command (/werewolf or similar)
here.
The Slash Command should perform a GET request to the server werewolf-slack is going to be hosted
on.
Make note of the token here too.
Installing
Installing werewolf-slack is easiest done using either Docker (recommended), stack or Cabal.
Using Docker:
docker pull hjwylde/werewolf-slack-docker
Using stack:
stack install werewolf-slack werewolf
export PATH=$PATH:~/.local/bin
Using Cabal:
cabal-install werewolf-slack werewolf
export PATH=$PATH:~/.cabal/bin
Running
werewolf-slack is a simple web server that listens for events from the Slack Slash Command. After receiving an event werewolf-slack forwards it on to the werewolf game engine and uses the Incoming Webhook to send back the response.
Running werewolf-slack is easiest done using either Docker (recommended) or the binary itself. Make sure to add rules to your firewall for werewolf-slack's port.
With Docker:
docker run -d -p 80:8080 hjwylde/werewolf-slack-docker -v TOKEN -u WEBHOOK_URL
With werewolf-slack:
werewolf-slack -p 80 -v TOKEN -u WEBHOOK_URL &
Configuration
It is possible to also configure the port that werewolf-slack listens on. This is done via the
--port (-p) option.
The default port is 8080.
Usage
Type /werewolf help in your Slack channel to get going!