simalq 0.1.0

Usage

You can install SQ via pip from the Python Package Index (PyPI) with the command pip install simalq, or from source with pip install .. For the best display, you should use a terminal emulator that supports 24-bit color (I’m a fan of Konsole), but SQ should be able to cope with less color support and use the best approximations available via its dependency blessed.

Run SQ with python3 -m simalq, or run the tests with pytest. Use python3 -m simalq --help for options. A good way to start is Tutorial Quest: python3 -m simalq Tutorial_Quest.

The first time that SQ requires IQ’s original quests, it will download them automatically. The download is cached, so no Internet connection is needed afterwards.

See the tilepedia for an HTML compendium of tile info pages.

The story so far

Her Royal Highness Princess Triskaidecagonn XIII (whose friends call her “Tris”), tiring of her studies, shut the heavy grimoire of nonstandard analysis. “For too long I have been obliged to concern myself with tedious scholarship” she lamented aloud “while my older brother Argonn has sallied forth on many an heroic quest. Here I sit, idling, with nary an opportunity to test my own skills in the sword, the bow, and the sliding-block puzzle.”

“Aha!” cried the fell wizard Idok, deep in his underground laboratory, who had been spying on the princess through his mystical Macintosh LC so he could copy her homework answers. “Here is an opportunity to teach you, young princess, to be careful what you wish for.” He typed a dread incantation in Hy, the long-dead language of squids born of snakes, and in a swarm of foul parentheses, Tris was carried off to a vast dungeon deep beneath the faraway elven land of Québec. The place looked familiar, and Tris realized that Idok had plagiarized pretty much the whole thing from the thesis of his doctoral advisor, the wicked sorcerer Karvarel. Her brother had braved these very dungeons years ago. She didn’t have his memoirs handy, but she did know one really good magic spell, which allowed her to predict the future. Now, with this clairvoyance, her trusty sword and bow, and anything handy she happens to find lying around, Tris must escape the dungeon or die in the attempt. And if she can stuff her pockets with loot on the way, that would really help with her kingdom’s latest financial crisis.

Differences from IQ

Apart from cosmetic and other interface differences, the chief way SQ differs from IQ in its design is its commitment to determinism. SQ replaces IQ’s random mechanics, such as monster pathfinding, with deterministic equivalents, sometimes making aspects of the game stateful that were previously stateless. SQ also deliberately omits interface hijinks like darkness and confusion. SQ adds flavor text for tiles, mid-game saving and loading, undo, visibility of the map outside the hero’s shooting radius, fixes to bugs and weird behavior (e.g., winning with a “you have died” message if you win the game and die to poison on the same turn), removal of many engine limits (e.g., max and min level size), and the ability to adjust some core game rules (e.g., whether monsters can walk on items).

While the author of IQ kindly provided me with its source code for reference, SQ is an original work that doesn’t substantively copy IQ at the code level, and has many fine differences (deliberate, and probably also accidental) in behavior.

Development status

SQ is reasonably polished and allows playing through several complete quests. The primary thing that’s missing is the implementation of more tile types, to support more of IQ’s original quests. I also plan to do some larger-scale code cleanup and document some of the interesting parts of the implementation, so that SQ better serves its purpose as an instructive example Hy program.

Version history

• 0.1.0 (2023-07-13): First playable release.

License

This program is copyright 2023 Kodi B. Arfer.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.