Add README

2026-10-25 03:15:54 +00:00
parent d4a1fc4ad4
commit 6a505bb3f0
4 changed files with 39 additions and 0 deletions
@@ -0,0 +1,39 @@
+* Minotaur
+
+[[file:minotaur.jpg]]
+
+~minotaur~ is a terminal maze game, written in June-August of 2020. Guide Theseus (magenta) to the exit (green) before the Minotaur (yellow) catches you.
+
+The maze is generated with the [[https://weblog.jamisbuck.org/2011/1/27/maze-generation-growing-tree-algorithm][growing tree algorithm]].
+
+[[file:maze.webp]]
+
+At each tick, the Minotaur advances one cell along the shortest path toward Theseus. When the game ends, it prints your survival time in seconds.
+
+[[file:minotaur.webp]]
+
+NB: these videos are from development. There is a small maze generation bug in them that was fixed. The current program has some small differences in behavior.
+
+** Usage
+
+#+begin_src shell
+minotaur [-h ROWS] [-w COLUMNS] [-t MS]
+#+end_src
+
+Flags:
+
+- =-h= — height in terminal rows (default: terminal rows)
+- =-w= — width in terminal columns (default: terminal columns)
+- =-t= — milliseconds between Minotaur movements (default: 250)
+
+** Controls
+
+- Arrow keys — move Theseus
+- =s= — toggle the shortest path to the exit (blue)
+- =q= — quit
+
+** Installation
+
+#+begin_src shell
+go install code.chimeric.al/dwrz/minotaur/cmd/minotaur@latest
+#+end_src