Consolidate engine docs and naming

This commit is contained in:
2026-05-19 11:09:37 +02:00
parent 121b174f2c
commit dbcb8f4284
47 changed files with 826 additions and 1992 deletions
+5 -5
View File
@@ -1,7 +1,7 @@
# Z-Code Story Files
Place your Z-machine story files here. The Zork Narrator engine looks for
`zork1.bin` by default. This can be overridden with the `ZORK_STORY_FILE`
Place your Z-machine story files here. The Z-code narrator engine looks for
`zork1.bin` by default. This can be overridden with the `ZCODE_STORY_FILE`
environment variable.
## Obtaining Zork I
@@ -18,13 +18,13 @@ You can obtain a legal copy via:
archived distributions listed under the Infocom catalogue.
Once you have the file, rename it to `zork1.bin` and place it in this folder,
or set `ZORK_STORY_FILE=./path/to/your/file` in your `.env`.
or set `ZCODE_STORY_FILE=./path/to/your/file` in your `.env`.
## Supported Formats
The `ifvms` interpreter accepts:
- `.z3`, `.z4`, `.z5`, `.z8` raw Z-machine story files
- `.zblorb` Blorb-wrapped story files (may include sound resources)
- `.z3`, `.z4`, `.z5`, `.z8` - raw Z-machine story files
- `.zblorb` - Blorb-wrapped story files (may include sound resources)
- Any file with the correct Z-machine header (the extension is ignored)
Zork I is a Z-machine version 3 (`.z3`) game.