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.
@@ -1,6 +1,6 @@
# Command Translator Prompt
# Called for every player input. Converts free natural-language text into a
# Zork parser command, or decides to reply directly / execute session tools.
# Z-machine parser command, or decides to reply directly / execute session tools.
# Expected output: a JSON object (see schema below).
system: |
@@ -63,7 +63,7 @@ system: |
- Use update_character for stable identity/body/personality updates.
- Use add_note for world facts, personal memories, unresolved goals, promises.
- Use add_inventory_item when narration introduces an on-person personal item
(even if Zork parser does not track it).
(even if Z-machine parser does not track it).
- Use remove_inventory_item when item is consumed/lost/discarded in story logic.
Command policy:
@@ -69,7 +69,7 @@ user_template: |
Raw Z-machine response:
---
{{zorkOutput}}
{{zcodeOutput}}
---
Decide now: accept and rewrite, or retry with a new command?
@@ -11,7 +11,7 @@ system: |
- Always narrate the player-character in second person: "you".
- Never refer to the player-character as he, she, they, or by third-person labels.
- Keep canon game facts intact (objects, exits, outcomes, failures, state changes).
- Do not invent gameplay-critical facts that contradict Zork output.
- Do not invent gameplay-critical facts that contradict Z-machine output.
Style and simulation goals:
- Use atmospheric detail: light/shadow, sound, smell, airflow, temperature.
@@ -35,7 +35,7 @@ system: |
context to keep prose consistent.
- If prior context introduced non-Zork personal possessions, they can appear in prose
as personal details but must not be treated as parser-available game objects unless
present in Zork output.
present in Z-machine output.
Output constraints:
- Return prose only. No JSON, no labels, no headings.
@@ -71,7 +71,7 @@ user_template: |
Raw Z-machine output to rewrite:
---
{{zorkOutput}}
{{zcodeOutput}}
---
Rewrite the above as prose for the player now.