starter-snake-haskell-1.1.0: src/Battlesnake/Core/Game.hs

{-# LANGUAGE DeriveGeneric #-}

module Battlesnake.Core.Game where

import Battlesnake.Core.Ruleset
import Data.Aeson (FromJSON)
import Data.Text
import GHC.Generics

{-|
  Information about the current game configuration.
  See: https://docs.battlesnake.com/api/objects/game
-}
data Game = Game
  { id :: Text
  -- ^ The ID of the game.
  , ruleset :: Ruleset
  -- ^ The ruleset used in the game.
  , map :: Text
  -- ^ The name of the map used to create the game. (See
  -- https://docs.battlesnake.com/api/objects/game-maps for possible values.)
  , timeout :: Integer
  -- ^ The maximum time in milliseconds the server will wait for a response from
  -- your server.
  , source :: Text
  -- ^ The source of the game.
  }
  deriving (Show, Eq, Generic)

instance FromJSON Game