| .. | ||
| README.md | ||
AGI game data
Everything in this folder except this file is ignored by git. No game's files are, or should ever be, committed to the repository.
Place each game in its own subdirectory:
games/
agidemo/ # Sierra's promotional AGIDEMO (freely redistributable)
kq3/ # Local copy extracted from your licensed King's Quest 3
...
scripts/test-agi.sh runs the host tests against every subdirectory that
holds a LOGDIR, and make iigs-game-disk-agi puts kq3 (or
AGI_GAME=NAME) on the bootable IIgs volume. Everywhere else the
interpreter reads the game from its DATA folder; joey-run --data games/kq3 copies a game there for one run.
Required files per game
For an AGI v2 game directory the loader needs:
LOGDIR- logic script indexPICDIR- picture (room background) indexVIEWDIR- view (sprite/animation) indexSNDDIR- sound indexVOL.0- resource volume 0 (always present)VOL.1..VOL.N- additional resource volumes (game-dependent)OBJECT- inventory tableWORDS.TOK- parser dictionary
and it reads Sierra's interpreter version from AGIDATA.OVL when the
folder has it, to behave as that version did (see agiQuirk); without
it the interpreter behaves as 2.435, the version it was measured on.
File names are uppercase by AGI convention; the loader looks them up literally so the directory should match.
Sourcing AGI data
This repository never ships copyrighted Sierra game data. Two legitimate sources for development and testing:
- Sierra's freely-distributed
AGIDEMOpromotional disk - redistributable since the late 1980s. - Fan-made AGI titles authored with AGI Studio - many are released under explicit redistribution licenses.
To test against a commercial Sierra game you legally own, extract the data files from your own copy and drop them in a new sibling directory here. Do not commit them.