Swarm.Game.ResourceLoading

Various utilities related to loading game data files.

Generic data access

getDataDirSafe :: (Has (Throw SystemFailure) sig m, Has (Lift IO) sig m) => AssetData -> FilePath -> m FilePath

Get subdirectory from swarm data directory.

This will first look in Cabal generated path and then try a data directory in XdgData path.

The idea is that when installing with Cabal/Stack the first is preferred, but when the players install a binary they need to extract the `data` archive to the XDG directory.

getDataFileNameSafe :: (Has (Throw SystemFailure) sig m, Has (Lift IO) sig m) => AssetData -> FilePath -> m FilePath

Get file from swarm data directory.

See the note in getDataDirSafe.

Concrete data access

getSwarmConfigIniFile :: Bool -> IO (Bool, FilePath)

getSwarmSavePath :: Bool -> IO FilePath

Get path to swarm saves, optionally creating necessary directories.

getSwarmHistoryPath :: Bool -> IO FilePath

Get path to swarm history, optionally creating necessary directories.

getSwarmAchievementsPath :: Bool -> IO FilePath

Get a path to the directory where achievement records are stored. If the argument is set to True, create the directory if it does not exist.

Loading text files

readAppData :: (Has (Throw SystemFailure) sig m, Has (Lift IO) sig m) => m (Map Text Text)

Read all the .txt files in the data/ directory.

data NameGenerator

Read-only lists of adjectives and words for use in building random robot names

Constructors

NameGenerator

Fields

• adjList :: Array Int Text
• nameList :: Array Int Text

initNameGenerator :: Has (Throw SystemFailure) sig m => Map Text Text -> m NameGenerator