forge/testScripts/README.md
2026-10-06 16:57:52 -05:00

29 lines
1.6 KiB
Markdown

# Forge's tests
Each scene drives Forge or its runtime and says what it found: a line with FAIL in it when
something is wrong, and it quits by itself. Run them with testScripts/run.sh (see ../README.md).
They run from a folder holding Forge/ (a copy of ../forge) and this folder, as a game directory
holds a game; the disc and the font are Singe's own, Singe/menuBackground.mkv and
Singe/FreeSansBold.ttf.
| Scenes | What they cover |
|---|---|
| 52-57 | The runtime and the editor: a described platformer, the chooser, entities, rules |
| 58-60 | The description format: a shoot-em-up, a light gun game over video, the timeline |
| 61-63 | 3D: a rail shooter, a 3D platformer, the editor's 3D room |
| 64-65 | Adventures in 2D and 3D |
| 66-71 | Racing, tower defence, branching video, the editor's pickers, the long tail |
| 72-82 | The rest of the catalogue, occluders, gizmos, turning sprites |
| 83-92 | The ten tutorials, driven by the keys the book names (tutorialDrive.singe) |
| 93-98, 100 | The panel document, waves, sound, a game's own vocabulary, mash and hold, the light sensor |
author/ holds the sample descriptions the scenes build; ports/ holds the library port comparisons
(see FORGE.md section 14).
## Credits
Models/Fox.glb is the Fox from the Khronos glTF sample models, CC-BY 4.0: model by PixelMannen,
rigging and animation by tomkranis, glTF conversion by AsoboStudio and scurest. It and the other
files here -- crate.png, checker.png, strip.png, hills.png, crate.jxl, crackle.wav, tune.mp3,
chip.nsf, and the tracker files -- are copies of Singe's own test files; Singe's
testScripts/README.md says where each came from.