chocolate-doom
/
statcheck
mirror of https://github.com/chocolate-doom/statcheck.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add README

This commit is contained in:
Simon Howard 2024-09-01 20:26:15 -04:00
parent fcdff9cc69
commit b161a16d80
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md Normal file
View File

@ -0,0 +1,18 @@
This is a Doom source port regression testing system that uses the
thousands of demos in the
[Compet-N archive](https://doomwiki.org/wiki/Compet-n) to test demo
playback. It was developed for Chocolate Doom but it may be useful for
other source ports as well.
The demos have been played back in vanilla Doom running in
[statdump.exe](https://github.com/fragglet/vanilla-utilities)
to save statistics about the levels that were completed. The output
from statdump.exe (in the form of .txt files) gives a useful set of
expected outputs. A source port able to output the same statistics
data can then be tested by playing back the same demos and comparing
against this expected data set.
See [the Chocolate Doom
website](https://www.chocolate-doom.org/wiki/index.php/Statcheck) for
details about how to run the test suite.