Help.hs

{-|
Module      : Werewolf.Commands.Help
Description : Options and handler for the help subcommand.

Copyright   : (c) Henry J. Wylde, 2015
License     : BSD3
Maintainer  : public@hjwylde.com

Options and handler for the help subcommand.
-}

{-# LANGUAGE OverloadedStrings #-}

module Werewolf.Commands.Help (
    -- * Options
    Options(..), Command(..),

    -- * Handle
    handle,
) where

import Control.Lens
import Control.Monad.IO.Class

import           Data.Text (Text)
import qualified Data.Text as T

import Game.Werewolf.Response
import Game.Werewolf.Role     as Role

-- | Options.
data Options = Options
    { argCommand :: Maybe Command
    } deriving (Eq, Show)

-- | Command.
data Command = Commands | Description | Rules | Roles
    deriving (Eq, Show)

-- | Handle.
handle :: MonadIO m => Text -> Options -> m ()
handle callerName (Options (Just Commands)) = exitWith success {
    messages = map (privateMessage [callerName]) commandsMessages
    }
handle callerName (Options (Just Description)) = exitWith success {
    messages = map (privateMessage [callerName]) descriptionMessages
    }
handle callerName (Options (Just Roles)) = exitWith success {
    messages = map (\role -> privateMessage [callerName] $ T.unlines [
        T.snoc (role ^. Role.name) ':',
        role ^. description,
        role ^. advice
        ]) allRoles
    }
handle callerName (Options (Just Rules)) = exitWith success {
    messages = map (privateMessage [callerName]) rulesMessages
    }
handle callerName (Options Nothing) = exitWith success {
    messages = map (privateMessage [callerName]) helpMessages
    }

commandsMessages :: [Text]
commandsMessages = map T.unlines [[
    "Usage: COMMAND ARG ..."
    ], [
    "Available commands:",
    "  end - end the current game",
    "  help - help documents",
    "  quit - quit the current game",
    "  see - see a player's allegiance",
    "  start - start a new game",
    "  vote - vote against a player"
    ], [
    "End:",
    "Usage: end",
    "  Ends the current game."
    ], [
    "Quit:",
    "Usage: quit",
    "  Quit the current game."
    ], [
    "See:",
    "Usage: see PLAYER",
    "  See a player's allegiance. A Seer may determine a player's allegiance once per day."
    ], [
    "Start:",
    "Usage: start PLAYER ...",
    "  Starts a new game with the given players. A game requires at least 7 players."
    ], [
    "Vote:",
    "Usage: vote PLAYER",
    T.unwords [
        "  Vote against a player.",
        "A townsperson may vote at daytime to lynch someone",
        "and a Werewolf may vote at nighttime to kill a Villager."
        ]
    ]]

descriptionMessages :: [Text]
descriptionMessages = map T.unlines [[
    T.unwords [
        "Deep in the American countryside,",
        "the little town of Millers Hollow has recently been infiltrated by Werewolves."
        ],
    T.unwords [
        "Each night, murders are committed by the Villagers,",
        "who due to some mysterious phenomenon (possibly the greenhouse effect)",
        "have become Werewolves."
        ],
    T.unwords [
        "It is now time to take control and eliminate this ancient evil,",
        "before the town loses its last few inhabitants."
        ]
    ], [
    "Objective of the Game:",
    "For the Villagers: kill all of the Werewolves.",
    "For the Werewolves: kill all of the Villagers."
    ]]

rulesMessages :: [Text]
rulesMessages = map T.unlines [[
    T.unwords [
        "Each night, the Werewolves bite, kill and devour one Villager.",
        "During the day they try to conceal their identity and vile deeds from the Villagers.",
        "Depending upon the number of players and variants used in the game,",
        "there are 1, 2, 3 or 4 Werewolves in play."
        ],
    T.unwords [
        "Each day,",
        "the survivors gather in the town square and try to discover who the Werewolves are.",
        "This is done by studying the other player's social behaviours",
        "for hidden signs of lycanthropy.",
        "After discussing and debating, the Villagers vote to lynch a suspect,",
        "who is then hanged, burned and eliminated from the game."
        ]
    ], [
    T.unwords [
        "Each player is informed of their role (see `help roles' for a list)",
        "at the start of the game. A game begins at night and follows a standard cycle."
        ],
    "1. The townsfolk fall asleep.",
    "2. The Seers wake up and each see someone.",
    "3. The Werewolves wake up and select a victim.",
    "4. The townsfolk wake up and find the victim.",
    "5. The townsfolk vote to lynch a suspect.",
    "The game is over when a single townsperson is left alive."
    ]]

helpMessages :: [Text]
helpMessages = map T.unlines [[
    "Usage: help COMMAND"
    ], [
    "Available commands:",
    "  commands - print the in-game commands",
    "  description - print the game description",
    "  rules - print the game rules",
    "  roles - print the roles and their description"
    ]]