{-# LANGUAGE OverloadedStrings #-}

-- |
-- SPDX-License-Identifier: BSD-3-Clause
-- Description: Constants used throughout the UI and game
--
-- Constants used throughout the UI and game.
module Swarm.Constant where

import Data.Text (Text)

-- * Website constants

-- $convention
-- By convention, all URL constants include trailing slashes
-- when applicable.

swarmDiscord :: Text
swarmDiscord :: Text
swarmDiscord = Text
"https://discord.gg/kp8MuSgkPw"

-- | The URL for the Swarm repository.
swarmRepoUrl :: Text
swarmRepoUrl :: Text
swarmRepoUrl = Text
"https://github.com/swarm-game/swarm/"

-- | The URL for the Swarm wiki.
wikiUrl :: Text
wikiUrl :: Text
wikiUrl = Text
swarmRepoUrl Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"wiki/"

-- | The URL for the Swarm commands cheat sheet.
wikiCheatSheet :: Text
wikiCheatSheet :: Text
wikiCheatSheet = Text
wikiUrl Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"Commands-Cheat-Sheet"