/Myopia

A simple rogue like game built using SDL and Haskell

Primary LanguageHaskellGNU General Public License v3.0GPL-3.0

Myopia

license

A simple Roguelike game built using SDL and Haskell.

image

Documentation

TODO

Develop

Prerequisites

If you want to use the development environment includeded in this repository you will need to install nix. The install will also enable all necessary "experimental" nix features you need.

If you don't want to use nix for the development you will have to provide the system dependencies yourself. These can be found listed in the flake.nix file under libraries.

Start contributing!

Run nix develop to enter the development environment.

This adds everything listed in the flake.nix files devShell attribute to your path. It is also possible to automatically hook into this environment using direnv see instructions on how to set this up here.

Build

To build the project using cabal you can run

cabal build myopia

Run

Run the project with

cabal run myopia

Tests

To execute all unit tests run

cabal run test:unit-tests