History

Griffin Smith 2833104708 chore(gs/xanthous): Don't include docs in source closure Change-Id: Ib6f2604096fa519f37ec4a2ce762229abca16b26 Reviewed-on: https://cl.tvl.fyi/c/depot/+/3866 Reviewed-by: grfn <grfn@gws.fyi> Tested-by: BuildkiteCI		2021-11-13 15:57:18 +00:00
..
.github	refactor(users/glittershark): Rename to grfn	2021-04-12 14:45:51 +00:00
app	feat(gs/xanthous): Allow disabling saving	2021-11-07 21:05:39 +00:00
bench	refactor(users/glittershark): Rename to grfn	2021-04-12 14:45:51 +00:00
build	refactor(users/glittershark): Rename to grfn	2021-04-12 14:45:51 +00:00
docs	docs(gs/xanthous): Start documenting raw types	2021-11-13 15:57:18 +00:00
server	fix(xanthous/server): Mount the key into the docker image	2021-11-13 14:47:02 +00:00
src	fix(gs/xanthous): Don't take up half-width for prompts	2021-11-08 03:31:51 +00:00
test	feat(gs/xanthous): Enable tasty-rerun	2021-11-08 15:29:05 +00:00
.envrc	refactor(users/glittershark): Rename to grfn	2021-04-12 14:45:51 +00:00
.gitignore	chore(gs/xanthous): Gitignore more state files	2021-11-08 15:29:13 +00:00
default.nix	chore(gs/xanthous): Don't include docs in source closure	2021-11-13 15:57:18 +00:00
hie.yaml	fix(gs/xanthous): Update hie.yaml for new app/ directory	2021-11-06 15:52:02 +00:00
LICENSE	refactor(users/glittershark): Rename to grfn	2021-04-12 14:45:51 +00:00
nixpkgs.nix	refactor(users/glittershark): Rename to grfn	2021-04-12 14:45:51 +00:00
package.yaml	feat(gs/xanthous): Enable tasty-rerun	2021-11-08 15:29:05 +00:00
pkg.nix	feat(gs/xanthous): Enable tasty-rerun	2021-11-08 15:29:05 +00:00
README.org	refactor(users/glittershark): Rename to grfn	2021-04-12 14:45:51 +00:00
Setup.hs	refactor(users/glittershark): Rename to grfn	2021-04-12 14:45:51 +00:00
shell.nix	feat(xanthous): Install qpdf in the shell	2021-06-18 17:51:43 +00:00
xanthous.cabal	feat(gs/xanthous): Enable tasty-rerun	2021-11-08 15:29:05 +00:00

README.org

Xanthous

Building
Running
- Keyboard commands
Development

Building

$ nix build

Running

$ ./result/bin/xanthous [--help]

Keyboard commands

Keyboard commands are currently undocumented, but can be found in [this file. Movement uses the nethack-esque hjklybnu.

Development

Use lorri, or run everything in a nix-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