diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,12 @@ ### Upcoming +### v1.0.0.0 + +*Major* + +* Initial stable release! + ### v0.5.4.0 *Minor* diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # werewolf -[![Project Status: Wip - Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](http://www.repostatus.org/badges/1.0.0/wip.svg)](http://www.repostatus.org/#wip) +[![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active) [![Build Status](https://travis-ci.org/hjwylde/werewolf.svg?branch=master)](https://travis-ci.org/hjwylde/werewolf) [![Release](https://img.shields.io/github/release/hjwylde/werewolf.svg)](https://github.com/hjwylde/werewolf/releases/latest) [![werewolf on Stackage LTS](https://www.stackage.org/package/werewolf/badge/lts)](https://www.stackage.org/lts/package/werewolf) [![werewolf on Stackage Nightly](https://www.stackage.org/package/werewolf/badge/nightly)](https://www.stackage.org/nightly/package/werewolf) -A game engine for playing werewolf within a chat client. -This engine is based off of the party game Mafia, also known as Werewolf. +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](https://en.wikipedia.org/wiki/Mafia_(party_game)) for a rundown on it's gameplay and history. diff --git a/app/Werewolf/Command/Help.hs b/app/Werewolf/Command/Help.hs --- a/app/Werewolf/Command/Help.hs +++ b/app/Werewolf/Command/Help.hs @@ -73,7 +73,7 @@ commandsMessages :: Text -> Maybe Game -> [Text] commandsMessages callerName mGame = map (T.intercalate "\n") $ filter (/= []) [ [ "Global commands:" - , "- `start ([-e | --extra-roles ROLE,...] | [-r | --random-extra-roles]) [--include-seer] PLAYER...`" + , "- `start ([-e|--extra-roles ROLE,...] | [-r|--random-extra-roles]) [--include-seer] PLAYER...`" , "- `end`" , "- `boot PLAYER`" , "- `quit`" @@ -82,7 +82,7 @@ , [ "Status commands:" , "- `ping` ping the status of the current game publicly" , "- `status` get the status of the current game privately" - , "- `circle [-a | --include-dead]` get the game circle" + , "- `circle [-a|--include-dead]` get the game circle" ] , [ "Standard commands:" , "- `vote PLAYER`" diff --git a/src/Game/Werewolf/Role.hs b/src/Game/Werewolf/Role.hs --- a/src/Game/Werewolf/Role.hs +++ b/src/Game/Werewolf/Role.hs @@ -164,13 +164,13 @@ -- | /Hah, maybe not as liked as the Jester, but the Drunk sure does their fair share of stupid/ -- /things in the night! No-one knows if they even actually make it home; sometimes people see/ -- /them sleeping outside the Blacksmith's home, others say they see them wandering towards the/ --- /woods. It's pointless quizzing the Village Drunk in the, morning about their doings; they can/ +-- /woods. It's pointless quizzing the Village Drunk in the morning about their doings; they can/ -- /never remember what they did!/ -- --- The Village Drunk is randomly assigned an alignment at the start, either Villagers or --- Werewolves. However, they are not told to which allegiance they belong. +-- The Village Drunk is initially aligned with the Villagers. -- --- On the third night the Village Drunk sobers up and is informed of their role. +-- On the third night the Village Drunk sobers up and is randomly assigned a new alignment, either +-- Villagers or Werewolves. villageDrunkRole :: Role villageDrunkRole = Role { _name = "Village Drunk" @@ -180,15 +180,15 @@ [ "Hah, maybe not as liked as the Jester, but the Drunk sure does their fair share of" , "stupid things in the night! No-one knows if they even actually make it home; sometimes" , "people see them sleeping outside the Blacksmith's home, others say they see them" - , "wandering towards the woods. It's pointless quizzing the Village Drunk in the, morning" + , "wandering towards the woods. It's pointless quizzing the Village Drunk in the morning" , "about their doings; they can never remember what they did!" ] , _rules = T.intercalate "\n" - [ T.unwords - [ "The Village Drunk is randomly assigned an alignment at the start, either Villagers" - , "or Werewolves. However, they are not told to which allegiance they belong." + [ "The Village Drunk is initially aligned with the Villagers." + , T.unwords + [ "On the third night the Village Drunk sobers up and is randomly assigned a new" + , "alignment, either Villagers or Werewolves." ] - , "On the third night the Village Drunk sobers up and is informed of their role." ] } diff --git a/werewolf.cabal b/werewolf.cabal --- a/werewolf.cabal +++ b/werewolf.cabal @@ -1,13 +1,15 @@ name: werewolf -version: 0.5.4.0 +version: 1.0.0.0 author: Henry J. Wylde maintainer: public@hjwylde.com homepage: https://github.com/hjwylde/werewolf -synopsis: A game engine for playing werewolf within a chat client -description: A game engine for playing werewolf within a chat client. - This engine is based off of the party game Mafia, also known as Werewolf. +synopsis: A game engine for playing werewolf within an arbitrary chat client +description: 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 for a + rundown on it's gameplay and history. license: BSD3 license-file: LICENSE