werewolf

Project Status: Active - The project has reached a stable, usable state and is being actively developed. Build Status Release werewolf on Stackage LTS werewolf on Stackage Nightly

A game engine for playing werewolf within an arbitrary chat client. Werewolf is a well known social party game, commonly also called Mafia. See the Wikipedia article for a rundown on its gameplay and history.

If you’re here just to play werewolf, you may wish to skip straight to chat interfaces.

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.

Roles

The implemented roles are split into four categories.

The Ambiguous:

No-one knows the true nature of the Ambiguous, sometimes not even the Ambiguous themselves!

The Ambiguous are able to change allegiance throughout the game.

  • Orphan
  • Village Drunk

The Loners:

The Loners look out for themselves and themselves alone.

The Loners must complete their own objective.

  • Dullahan
  • Fallen Angel
  • Necromancer (and Zombie)

The Villagers:

Fraught with fear of the unseen enemy, the Villagers must work together to determine the truth and eliminate the threat to Fougères. The task before them will not be easy, but a certain few have learnt some tricks over the years that may turn out rather useful.

The Villagers must lynch all of the Werewolves.

  • Beholder
  • Crooked Senator
  • Druid
  • Hunter
  • Jester
  • Lycan
  • Medusa
  • Oracle
  • Protector
  • Saint
  • Scapegoat
  • Seer
  • Simple Villager
  • Spiteful Villager
  • True Villager
  • Witch

The Werewolves:

Hiding in plain sight, the Werewolves are not a small trifle.

The Werewolves must devour all of the Villagers.

  • Alpha Wolf
  • Simple Werewolf

Variants

Variants alter how the game plays out.

  • Standard
  • No role knowledge (players are not informed of the roles in play at the start of a game)
  • No role knowledge or reveal (players are not informed of the roles in play at the start of a game, nor each others roles upon death)
  • No role reveal (players are not informed of each others roles upon death)
  • Spiteful village (the default Villager role becomes the Spiteful Villager)

Installing

Installing werewolf is easiest done using either stack (recommended) or Cabal.

Using stack:

stack install werewolf
export PATH=$PATH:~/.local/bin

Using Cabal:

cabal-install werewolf
export PATH=$PATH:~/.cabal/bin

Usage

This section covers how a chat interface interacts with the werewolf game engine.

All werewolf commands are designed to be run by a user from the chat client. E.g., to start a game:

> werewolf --caller @foo --tag werewolf start --extra-roles seer @bar @baz @qux @quux @corge @grault
{"ok":true,"messages":[
    {"to":null,"message":"A new game of werewolf is starting with @foo, @bar, @baz, @qux, @quux, @corge and @grault!"},
    {"to":null,"message":"The roles in play are Seer (1), Simple Villager (4) and Simple Werewolf (2) for a total balance of -2."},
    {"to":"@foo","message":"You're a Simple Villager.\nA simple, ordinary townsperson in every way. Some may be cobblers, others bakers or even nobles. No matter their differences though, the plight of Werewolves in Fougères unites all the Villagers in this unfortunate time.\nThe Simple Villager has no special abilities, they must use their guile to determine whom among them is not who they say they are."},
    ...,
    {"to":null,"message":"Night falls, the village is asleep."},
    {"to":null,"message":"The Seer wakes up."},
    {"to":"@corge","message":"Whose allegiance would you like to `see`?"}
    ]}

In this example, user @foo ran the start command with the player names as arguments. Note that the calling user, @foo, was passed in to the --caller option and a game tag, werewolf, was passed in to the --tag option. All commands require these options (n.b., the tag option is arbitrary, it just enables multiple games of werewolf to be running at once).

Any command ran returns a JSON result. The result contains a boolean for whether the command was successful and a list of messages. The to header on a message may either be null—for a public message—or have an intended recipient.

It’s the Seer’s turn now.

> werewolf --caller @corge --tag werewolf see @grault
{"ok":true,"messages":[
    {"to":"@corge","message":"@grault is aligned with the Werewolves."},
    {"to":"@quux","message":"You feel restless, like an old curse is keeping you from sleep. It seems you're not the only one... @grault is also emerging from their home."},
    {"to":"@grault","message":"You feel restless, like an old curse is keeping you from sleep. It seems you're not the only one... @quux is also emerging from their home."},
    {"to":null,"message":"The Werewolves wake up, transform and choose a new victim."},
    {"to":"@quux","message":"Whom would you like to `vote` to devour?"},
    {"to":"@grault","message":"Whom would you like to `vote` to devour?"}
    ]}

Let’s have the Werewolves, @quux and @grault, vote to devour a Villager.

> werewolf --caller @quux --tag werewolf vote @foo
{"ok":true,"messages":[
    {"to":"@grault","message":"@quux voted to devour @foo."}
    ]}
> werewolf --caller @grault --tag werewolf vote @foo
{"ok":true,"messages":[
    {"to":"@quux","message":"@grault voted to devour @foo."},
    {"to":null,"message":"The sun rises. Everybody wakes up and opens their eyes..."},
    {"to":null,"message":"As you open them you notice a door broken down and @foo's guts half devoured and spilling out over the cobblestones. From the look of their personal effects, you deduce they were a Simple Villager."},
    {"to":null,"message":"As the village gathers in the square the Town Clerk calls for a vote."},
    {"to":null,"message":"Whom would you like to `vote` to lynch?"}
    ]}

Too bad for @foo. Maybe the village can get some vengeance…

> werewolf --caller @corge --tag werewolf vote @grault
{"ok":true,"messages":[]}

This time, even though the command was successful, there are no messages.

> werewolf --caller @corge --tag werewolf vote @grault
{"ok":false,"messages":[{"to":"@corge","message":"You've already voted!"}]}

Here the command was unsuccessful and an error message is sent to @corge. Even though the command was unsuccessful, the chat interface probably won’t need to do anything special. Relaying the error message back to the user should suffice.

Thus a chat interface must implement the following:

  • The ability to call werewolf commands. This includes passing the --caller and --tag options and arguments correctly. It is possible to only implement the interpret command, which interprets the caller’s input.
  • The ability to send resultant messages. Resultant messages may be to everyone or to a specific user.

Commands

See werewolf --help.

Chat interfaces

Click through for instructions on how to run a chat interface and play werewolf.

Changes

Changelog

N.B., prior to v1 a change was considered breaking if it altered how an interface interacts with the werewolf binary. Post v1 a change is further considered breaking if the state file format is incompatible with the previous version.

Upcoming

v1.5.2.0

Revisions

  • Relaxed dependency constraints.

v1.5.1.1

Revisions

  • Added missing modules to cabal file.

v1.5.1.0

Minor

  • Added the No Role Knowledge Or Reveal variant. (#226)

Revisions

  • Bump optparse-applicative max version constraint. (#256)

v1.5.0.0

Major

  • Changed name of Spiteful Villagers variant to Spiteful village. (#242)

Minor

  • Added in a variants help subcommand. (#227)

Revisions

  • Fixed Jester lynched message to be gender neutral. (#248)
  • Fixed Medusa description to be gender neutral. (#247)
  • Pulled variant information out into external text files. (#242)

v1.4.0.1

Revisions

  • Ignore the Jester when considering Necromancers win condition. (#244)

v1.4.0.0

Major

  • Added the Necromancer role. (#211)
  • Renamed Scapegoat’s allowedVoters to chosenVoters. (#211)

Minor

  • Added the Zombie role. (#211)

v1.3.1.0

Minor

  • Added a game variant message at the start of a game. (#235)
  • Added the Saint role. (#178)
  • Added marks to the Dullahan’s status command. (#236)
  • Changed Spiteful Ghost to be aligned with the Villagers and to start off alive. (#238)
  • Renamed Spiteful Ghost to Spiteful Villager. (#241)
  • Added the spiteful-villagers variant. (#240)

Revisions

  • Fix a bug where due to Scapegoat picking 1 player the day never comes again. (#239)

v1.3.0.1

Revisions

  • Fixed Fallen Angel won message to not refer to a warning. (#237)

v1.3.0.0

Major

  • Added activity field to Role. (#231)
  • Added the Dullahan role. (#202)

Minor

  • Added player roles message when the game is force ended. (#225)
  • Added the no-role-reveal variant. (#181)
  • Added a public start-of-game message for the Spiteful Ghost. (#220)
  • Removed the public start-of-game message for the Fallen Angel. (#229)
  • Updated role balances based on Simple Werewolf being -5. (#233)

Revisions

  • Fixed current stage command to declare diurnal turns. (#231)
  • Fixed ping command to declare diurnal roles. (#231)

v1.2.0.3

Revisions

  • Fixed help subcommands from causing an error when a game doesn’t exist. (#230)
  • Fixed help subcommands for no-role-knowledge variant. (#232)

v1.2.0.2

Revisions

  • Added further missing files to extra-source-files.

v1.2.0.1

Revisions

  • Added missing files to extra-source-files.

v1.2.0.0

Major

  • Renamed FerinasGrunt to DruidsTurn. (#155)
  • Added tag field to Role. (#155)
  • Added variant field to Game. (#222)

Minor

  • Moved messages to external files using QuasiQuotes. (#155)
  • Moved role names, descriptions and rules to external files using QuasiQuotes. (#155)
  • Removed --include-seer option from start. (#223)
  • Removed --force option from end. (#224)
  • Added the no-role-knowledge variant. (#182)

Revisions

  • Updated Crooked Senator’s balance to 2.

v1.1.1.0

Revisions

  • Updated minimum and maximum number of roles with --random-extra-roles.
  • Updated Medusa’s balance to 3.

v1.1.0.0

Major

  • Moved majority of library classes to app/. (#208)
  • Changed the Fallen Angel to be a true Loner. (#173)
  • Added the Oracle role. (#141)
  • Removed the event concept. (#147)

Minor

  • Added private message to players when they die. (#188)
  • Added the Medusa role. (#99)
  • Added unvote command. (#213)
  • Removed public knowledge of Villagers and Werewolves that have voted. (#214)
  • Added the Spiteful Ghost role. (#206)

Revisions

  • Updated the Scapegoat’s turn messages to be clear that they may choose more than 1 player. (#185)
  • Updated Beholder’s balance to 1.

v1.0.2.2

Revisions

  • Bumped max version constraint of lens.

v1.0.2.1

Revisions

  • Removed the binary header and updated the program description.

v1.0.2.0

Minor

  • Added the Alpha Wolf role. (#149)
  • Added the Beholder role. (#168)
  • Added the Lycan role. (#169)

Revisions

  • Moved Seer’s player seen message to Sunrise. (#184)

v1.0.1.0

Minor

  • Added the Crooked Senator role. (#142)

v1.0.0.0

Major

  • Initial stable release!

v0.5.4.0

Minor

  • Added --include-seer option to start. (#179)
  • Added the Village Drunk role. (#160)

Revisions

  • Minor updates to the help rules text.
  • Removed most logical tests and kept error ones. (#164)

v0.5.3.0

Minor

  • Removed the Devoted Servant. (#127)
  • Renamed the Angel to the Fallen Angel. (#130)
  • Renamed the Villager-Villager to the True Villager. (#137)
  • Removed the Wolf-hound. (#129)

Revisions

  • Changed the Druid’s balance to 3. (#165)
  • Updated the Fallen Angel’s description and rules. (#130)
  • Updated the Simple Werewolf’s description. (#174)
  • Updated the True Villager’s description and rules. (#137)
  • Made the roles gender neutral. (#101)
  • Made the role descriptions use consistent tenses. (#158)

v0.5.2.0

Minor

  • Renamed the Wild-child to Orphan. (#128)
  • Added the Hunter role. (#3)

Revisions

  • Updated the Orphan’s description. (#128)
  • Added role taken message for the Devoted Servant. (#157)

v0.5.1.0

Minor

  • Renamed the Defender to Protector. (#132)
  • Automatically delete the game file if the game is over. (#100)
  • Added errors for using overloaded commands out of turn. (#100)

Revisions

  • Updated the Protector’s description and rules. (#132)
  • Improved the English used. (#72)
  • Added which player is the Villager-Villager to status. (#144)

v0.5.0.0

Major

  • Added required --tag option for enabling multiple games at once. (#29)

v0.4.12.0

Minor

  • Renamed the Bear Tamer to Druid. (#131)
  • Renamed the Village Idiot to Jester. (#136)

Revisions

  • Updated the Witch’s description and rules. (#138)
  • Updated the Scapegoat’s description. (#133)
  • Updated the Druid’s description and rules. (#131)
  • Updated the Jester’s description and rules. (#136)

v0.4.11.0

Minor

  • Removed the advice field from Role. (#134)

Revisions

  • Replaced references to Millers Hollow with an original game description. (#126)
  • Fixed a bug where extra roles with spaces in them weren’t recognised.
  • Fixed Devoted Servant messages to exclude her when joining the Werewolf pack.
  • Fixed Devoted Servant help messages to include how to pass.
  • Removed player cap of 24. (#143)
  • Fixed a bug where the Wild Child would receive role model died messages when dead. (#145)
  • Updated the Simple Villager’s description and rules. (#135)
  • Updated the Seer’s description. (#134)
  • Updated the Simple Werewolf’s description. (#139)

v0.4.10.0

Minor

  • Added boot command. (#14)

v0.4.9.0

Minor

  • Added player contributed messages upon game over. (#86)
  • Changed choose command for Scapegoat to take a space separated list rather than comma separated. (#98)
  • Filtered help commands based on the current game. (#94)
  • Added --all option to help commands. (#94)
  • Added the Devoted Servant role. (#47)
  • Added --force flag to end. (#77)

v0.4.8.0

Minor

  • Added role allocations to the game over messages. (#27)

Revisions

  • Improved prompt to Wolf-hound on how to choose an allegiance. (#90)
  • Changed Scapegoat’s balance to 0. (#91)
  • Grouped help commands to improve readability. (#97)
  • Changed the status and ping commands to tell the caller when the game is over. (#89)
  • Added roles in game to the status command. (#93)

v0.4.7.1

Revisions

  • Fixed bug where the Wolf-hound’s turn messages would be displayed on every round. (#87)
  • Fixed a bug causing the Angel’s joining Villagers message to be shown every round. (#95)
  • Fixed Village Idiot text to have spaces around the name. (#87)
  • Fixed a bug where the Werewolves couldn’t win if it was down to 1 Werewolf and the Village Idiot. (#88)

v0.4.7.0

Revisions

  • Fixed balance calculation to ensure total balance is between -2 and 2.
  • Changed --random-extra-roles to have between n / 3 and n / 3 + 2 extra roles.
  • Added prisms and traversals to Role, Player & Game modules. (#20)
  • Removed fudging of roles and replaced with fudging of allegiances.
  • Wolf-hound now has their allegiance hidden when they are lynched.
  • Fixed the grammar on the first Werewolves’ turn messages.
  • Moved Wolf-hound’s turn to before the Seer’s so that the Seer may see his allegiance properly.
  • Restricted specifying Simple Villager or Simple Werewolf as extra roles.

v0.4.6.1

Revisions

  • Fixed Village Idiot text to have spaces around the name. (#87)
  • Fixed a bug where the Werewolves couldn’t win if it was down to 1 Werewolf and the Village Idiot. (#88)

v0.4.6.0

Minor

  • Added the Village Idiot role. (#41)
  • Added the Scapegoat’s ability to choose whom may vote on the next day when he is blamed. (#62)
  • Added in balance concept for roles to help balance role selection. (#81)
  • Added --random-extra-roles option to start. (#30)
  • Added the Bear Tamer role. (#45)
  • Added a circle command. (#45)

Revisions

  • Fixed the Defender being unable to protect himself.
  • Restructured library modules to only export relevant functions. (#11)

v0.4.5.0

Minor

  • Added the Wolf-hound role. (#50)
  • Added a version command. (#84)
  • Added the Wild-child role. (#49)
  • Added the Angel role. (#52)

Revisions

  • Renamed the Villager role to Simple Villager.
  • Renamed the Werewolf role to Simple Werewolf.
  • Renamed the devourVoteCommand and lynchVoteCommand to voteDevourCommand and voteLynchCommand. (#49)
  • Fixed quit to advance the stage when the only role for that stage has quit.

v0.4.4.1

Revisions

  • Fixed grammar for the currentStageMessages. (#83)
  • Fixed the heal command help message to not require a PLAYER argument. (#82)

v0.4.4.0

Minor

  • Removed playerHealedMessage and replaced with the generic noPlayerDevouredMessage. (#80)
  • Removed playerProtectedMessage and replaced with the generic noPlayerDevouredMessage. (#80)

Revisions

  • Privatised underscore methods and changed old uses to using lens. (#20)
  • Tidied up arbitrary instances by using newtype’s. (#78)
  • Fixed the noPlayerDevouredMessage to be displayed after sunrise. (#80)
  • Removed Show instance for Command and used Blind. (#78)

v0.4.3.2

Revisions

  • Fixed grammar for the currentStageMessages. (#83)
  • Fixed the heal command help message to not require a PLAYER argument. (#82)

v0.4.3.1

Revisions

  • Added missing module to Cabal file.

v0.4.3.0

Minor

  • Added the Defender role. (#38)

v0.4.2.3

Revisions

  • Fixed grammar for the currentStageMessages. (#83)
  • Fixed the heal command help message to not require a PLAYER argument. (#82)

v0.4.2.2

Revisions

  • Added missing module to Cabal file.

v0.4.2.1

Revisions

  • Fixed a bug causing the Witch being unable to heal themselves. (#76)

v0.4.2.0

Minor

  • Added the Villager-Villager role. (#37)

v0.4.1.3

Revisions

  • Fixed grammar for the currentStageMessages. (#83)
  • Fixed the heal command help message to not require a PLAYER argument. (#82)

v0.4.1.2

Revisions

  • Added missing module to Cabal file.

v0.4.1.1

Revisions

  • Fixed a bug causing the Witch being unable to heal themselves. (#76)

v0.4.1.0

Minor

  • Added the Witch role. (#5)

v0.4.0.1

Revisions

  • Fixed grammar for the currentStageMessages. (#83)

v0.4.0.0

Major

  • Restricted count of special roles to 1. (#32)
  • Changed private message structure to only ever be for a single player. (#21)

Minor

  • Renamed turn to stage. (#70)
  • Renamed VillagersTurn to VillagesTurn. (#70)
  • Added events to the game state. (#71)
  • Added private pinging to the ping command. (#69)
  • Restricted end to players in the current game. (#74)

v0.3.4.0

Minor

  • Added a ping command. (#64)

Revisions

  • Added missing apostrophe to the new turn message. (#63)
  • Changed the “Whom would you like to lynch?” text to be a public message displayed after the devoured message. (#56)
  • Better prompt to action when villagers vote.
  • Changed devour vote messages to be sent immediately. (#57)
  • Removed useless only function. (#55)
  • Turned start of day and night into distinct turns.
  • Added private message to players when the game is over. (#65)

v0.3.3.2

Revisions

  • Fixed missing file in Cabal file. (#18)

v0.3.3.1

Revisions

  • Added noIntersperse to interpret. (#60)

v0.3.3.0

Minor

  • Added the Scapegoat role. (#40)
  • Added a status command. (#18)

Revisions

  • Added -- to help description of interpret. (#60)

v0.3.2.0

Minor

  • Added a “Whom would you like to lynch?” message during the Villagers’ turn. (#25)
  • Allowed lowercase roles for --extra-roles in the start command. (#33)

Revisions

  • Shrunk some of the help text to make it more readable. (#25)

v0.3.1.3

Revisions

  • Fixed a bug where Werewolves could devour other Werewolves. (#34)
  • Changed Werewolf text from “kill” to “devour”. (#34)

v0.3.1.2

Revisions

  • Fixed dead werewolves being informed of votes. (#24)

v0.3.1.1

Revisions

  • Tidied up the help text to be smaller. (#26)
  • Fixed a bug where the turn was advanced to Werewolves when no Werewolves were alive. (#26)

v0.3.1.0

Minor

  • Added a message to say the names of all the players at the start of a game. (#23)
  • Added a message to say the roles in play at the start of a game. (#16)

v0.3.0.5

Revisions

  • Fixed a bug where Werewolves could devour other Werewolves. (#34)
  • Changed Werewolf text from “kill” to “devour”. (#34)

v0.3.0.4

Revisions

  • Fixed dead werewolves being informed of votes. (#24)

v0.3.0.3

Revisions

  • Tidied up the help text to be smaller. (#26)
  • Fixed a bug where the turn was advanced to Werewolves when no Werewolves were alive. (#26)

v0.3.0.2

Revisions

  • Tidied up the help text to be smaller. (#26)
  • Fixed a bug where the turn was advanced to Werewolves when no Werewolves were alive. (#26)

v0.3.0.1

Revisions

  • Fixed interpret to display the commands help messages when given invalid arguments. (#22)

v0.3.0.0

Major

  • Added --extra-roles option to start. (#12)
  • Removed Seer from being included by default. (#12)

Minor

  • Allowed start to work when the game has ended but end hasn’t been called. (#15)
  • Added quit command. (#13)

v0.2.0.2

Revisions

  • Fixed dead werewolves being informed of votes. (#24)

v0.2.0.1

Revisions

  • Tidied up the help text to be smaller. (#26)
  • Fixed a bug where the turn was advanced to Werewolves when no Werewolves were alive. (#26)

v0.2.0.0

Major

  • Added the Seer role. (#4)
  • Removed the need to encode / decode to JSON for the state file. (#9)

v0.1.0.0

Major

  • Initial implementation with Villagers and Werewolves. (#1)
comments powered byDisqus