Convert README.nfo to README.org !1
2 files changed, +58 −56
Layout: unified · split
README.nfo deleted −56
| @@ -1,56 +0,0 @@ | ||
| 1 | ┌──────────────────────────────────────────────────────────────┐ | |
| 2 | │ M I C R O - R O G U E L I K E [ KRZ ] krz.sh │ | |
| 3 | └──────────────────────────────────────────────────────────────┘ | |
| 4 | ||
| 5 | WHAT | |
| 6 | two small roguelikes at two size limits. explore, grab loot, don't | |
| 7 | die, get out. open either in a browser. nothing to install. | |
| 8 | ||
| 9 | 1MB VERSION | |
| 10 | play: https://rogue.krz.sh/1mb/ | |
| 11 | ||
| 12 | a 12x12 grid, torches and shadows, a beast that hunts you, six | |
| 13 | floors to daylight, and a secret seventh. reach the gate on floor 6 | |
| 14 | with the crown and the key. | |
| 15 | ||
| 16 | controls: | |
| 17 | - arrow keys / wasd move | |
| 18 | - space or . wait a turn | |
| 19 | - t drop torch | |
| 20 | - m mute / unmute | |
| 21 | - r restart | |
| 22 | - c continue a saved run (title screen) | |
| 23 | ||
| 24 | on mobile an on-screen d-pad appears. | |
| 25 | ||
| 26 | modes (press a number on the title screen): | |
| 27 | 1 standard 2 iron 3 greed 4 dark | |
| 28 | 5 daily 6 heavy 7 swift 8 warded | |
| 29 | ||
| 30 | win once and a hidden seventh floor opens. | |
| 31 | ||
| 32 | budget: the game is the two raw files in 1mb/, no build step, and | |
| 33 | together they stay under 1,048,576 bytes (1 MiB). tools/check.sh is | |
| 34 | the gate; it prints the byte ledger and proves every escape room | |
| 35 | stays winnable across hundreds of seeds. ledger history in | |
| 36 | docs/SIZES.txt. | |
| 37 | ||
| 38 | tools/check.sh | |
| 39 | ||
| 40 | run it before each commit: | |
| 41 | ||
| 42 | ln -s ../../tools/pre-commit .git/hooks/pre-commit | |
| 43 | ||
| 44 | 1KB VERSION | |
| 45 | play: https://rogue.krz.sh/1kb/#g | |
| 46 | ||
| 47 | the whole game in about a kilobyte of html. no javascript, just | |
| 48 | links between rooms. find the key and the crown, make it back out | |
| 49 | through the gate. controls: click the links. | |
| 50 | ||
| 51 | LICENSE | |
| 52 | 0bsd. see LICENSE. | |
| 53 | ||
| 54 | ┌──────────────────────────────────────────────────────────────┐ | |
| 55 | │ krz.sh │ | |
| 56 | └──────────────────────────────────────────────────────────────┘ | |
README.org added +58
| @@ -0,0 +1,58 @@ | ||
| 1 | #+title: micro-roguelike | |
| 2 | ||
| 3 | * what | |
| 4 | two small roguelikes at two size limits. explore, grab loot, don't | |
| 5 | die, get out. open either in a browser. nothing to install. | |
| 6 | ||
| 7 | * 1mb version | |
| 8 | play: https://rogue.krz.sh/1mb/ | |
| 9 | ||
| 10 | a 12x12 grid, torches and shadows, a beast that hunts you, six | |
| 11 | floors to daylight, and a secret seventh. reach the gate on floor 6 | |
| 12 | with the crown and the key. | |
| 13 | ||
| 14 | #+begin_example | |
| 15 | controls: | |
| 16 | - arrow keys / wasd move | |
| 17 | - space or . wait a turn | |
| 18 | - t drop torch | |
| 19 | - m mute / unmute | |
| 20 | - r restart | |
| 21 | - c continue a saved run (title screen) | |
| 22 | #+end_example | |
| 23 | ||
| 24 | on mobile an on-screen d-pad appears. | |
| 25 | ||
| 26 | #+begin_example | |
| 27 | modes (press a number on the title screen): | |
| 28 | 1 standard 2 iron 3 greed 4 dark | |
| 29 | 5 daily 6 heavy 7 swift 8 warded | |
| 30 | #+end_example | |
| 31 | ||
| 32 | win once and a hidden seventh floor opens. | |
| 33 | ||
| 34 | budget: the game is the two raw files in 1mb/, no build step, and | |
| 35 | together they stay under 1,048,576 bytes (1 MiB). tools/check.sh is | |
| 36 | the gate; it prints the byte ledger and proves every escape room | |
| 37 | stays winnable across hundreds of seeds. ledger history in | |
| 38 | docs/SIZES.txt. | |
| 39 | ||
| 40 | #+begin_src sh | |
| 41 | tools/check.sh | |
| 42 | #+end_src | |
| 43 | ||
| 44 | run it before each commit: | |
| 45 | ||
| 46 | #+begin_src sh | |
| 47 | ln -s ../../tools/pre-commit .git/hooks/pre-commit | |
| 48 | #+end_src | |
| 49 | ||
| 50 | * 1kb version | |
| 51 | play: https://rogue.krz.sh/1kb/#g | |
| 52 | ||
| 53 | the whole game in about a kilobyte of html. no javascript, just | |
| 54 | links between rooms. find the key and the crown, make it back out | |
| 55 | through the gate. controls: click the links. | |
| 56 | ||
| 57 | * license | |
| 58 | 0bsd. see LICENSE. | |