I’ve been working on in-game documentation for the past few days, and it’s finally done! Basically, all the documentation is drawn from text files (with some special markup in them). This makes it possible to edit hlep without having to recompile; it also means you can just read the text files if you want (a simple regex will remove the markup).
Here’s a screenshot of the help screen:
That’s a Cuss interface, of course, with lots of keybindings.
In some places, the help actually describes things not implemented yet, so it’s a bit of a crystal ball.
The three items at the bottom are special. Rather than being just long instructional texts, they’re “live:”
- Key commands - This looks at the currently-loaded keybindings file and tells you what keys do what. Like in Cataclysm 1, you can re-bind your keys here.
- Item Index - This one is kind of cool. Lots of roguelikes kind of force you to use a wiki to look up items, monsters, etc. Rather than do that, I figured I’d make things easy on the player and bring the wiki to them. The Item Index allows you to type the full or partial name of any item in the game, and bring up a description of that item, just like if you were examining it in your inventory. Yes, it’s a bit spoilery, but I’m okay with this kind of “technical” spoiler. Experienced players will learn it fast; I just want to put newbies on the same ground as them.
- Monster Index - Same idea as the item index. Roguelikes (and other games) suffer from the player encountering a new monster, and really having no idea what the heck it’s supposed to be, what its abilities are, etc. This will help a bit by letting the player pull a description of any monster in the game. Of course, if randomized “legendary” monsters are in the game, they won’t appear here (being randomized and all). And it won’t help with NPCs either!