tvl-depot/users/aspen/xanthous/README.org
Aspen Smith 82ecd61f5c chore(users): grfn -> aspen
Change-Id: I6c6847fac56f0a9a1a2209792e00a3aec5e672b9
Reviewed-on: https://cl.tvl.fyi/c/depot/+/10809
Autosubmit: aspen <root@gws.fyi>
Reviewed-by: sterni <sternenseemann@systemli.org>
Tested-by: BuildkiteCI
Reviewed-by: lukegb <lukegb@tvl.fyi>
2024-02-14 19:37:41 +00:00

36 lines
643 B
Org Mode

#+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