pituicat/README.md

63 lines
1.6 KiB
Markdown
Raw Normal View History

2020-12-07 00:47:20 +00:00
# pituicat
2020-12-07 00:45:49 +00:00
This repository contains the source and game design files for the game
`pituicat`.
This game is still an experimental work in progress, so things are subject to
change and no version or revision numbers are being assigned (yet).
2020-12-07 00:47:20 +00:00
## Build and run instructions
2020-12-07 00:45:49 +00:00
For any system you want to buil on, you will need a current version of `ghc`
as well as the build tool `cabal`. Additional libraries may be needed,
depending on your operating system.
2020-12-07 00:47:20 +00:00
### Linux
2020-12-07 00:45:49 +00:00
I develop this game in [NixOS](https://nixos.org), so the build instructions
for this system are the ones I use on a daily basis.
2020-12-07 00:47:20 +00:00
#### NixOS
2020-12-07 00:45:49 +00:00
To set up the build environment, simply run this in the command line of your
2020-12-07 00:50:32 +00:00
choice in the project's root directory:
2020-12-07 00:45:49 +00:00
```bash
nix-shell shell.nix
```
After the setup and build process is finished and you are given the prompt of
the environmet you just built, you can run
```bash
cabal new-run
```
to compile and run the game.
2020-12-07 00:47:20 +00:00
#### Other Linux flavours
2020-12-07 00:45:49 +00:00
You will need at least the development libraries for `sdl2` and a development
setup for `OpenGL`.
TODO: provide list of development libraries this game directly depends on.
After setting up the system with all development dependencies, simply run
```bash
cabal new-run
```
for compiling and running the game.
2020-12-07 00:47:20 +00:00
### Other operating systems
2020-12-07 00:45:49 +00:00
I wish you good luck with that. If you manage to run the game on other systms,
ping me with build and run instructions on <nek0@nek0.eu> and I will gladly
include them here.
2020-12-07 00:47:20 +00:00
## Gameplay
2020-12-07 00:45:49 +00:00
Since there is no interactive content yet, there is nothing much to write here
other than: enjoy the visuals!