tvl-depot/users/grfn/xanthous/README.org

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

37 lines
643 B
Org Mode
Raw Normal View History

#+TITLE: Xanthous
* Building
#+BEGIN_SRC shell
$ nix build
#+END_SRC
* Running
#+BEGIN_SRC shell
$ ./result/bin/xanthous [--help]
#+END_SRC
** Keyboard commands
Keyboard commands are currently undocumented, but can be found in [[[https://github.com/glittershark/xanthous/blob/master/src/Xanthous/Command.hs#L26][this file]].
Movement uses the nethack-esque hjklybnu.
* Development
Use [[https://github.com/target/lorri][lorri]], or run everything in a ~nix-shell~
#+BEGIN_SRC shell
# Build (for dev)
$ cabal new-build
# Run the game
$ cabal new-run xanthous
# Run tests
$ cabal new-run test
# Run a repl
$ cabal new-repl
#+END_SRC