13 How to use the GS Dump Runner

GS Dump Runner - How to use (Qt project only)

The GS dump runner is designed to automatically run and compare a large number of GS dumps and output any differences found w/pictures. It's not perfect, but it saves a heck of a lot of time!

pcsx2-gsrunner does not build by default. You need to right click in the solution explorer in VS, and select Build.

To use:

Note: You can add the -parallel 4 as a parameter for it to run multiple dumps at once (preferred), replace 4 with the number you want to do at once, but this is the recommended value.

To use hardware hacks by using the -renderhacks parameter followed by the following

• af = AutoFlush
• cpufb = CPU Framebuffer Conversion
• dds = Disable Depth Support
• dpi = Disable Partial Invalidation
• dsf = Disable Safe Features
• tinrt = Texture in Render Target
• plf = Preload Frame Data

You can string them together like afcpufbddsdpidsftinrtplf or separate with commans/colons and it will split them out.

Run the python script to generate a baseline:

python test_run_dumps.py -runner path\to\baseline-build\pcsx2-gsrunnerx64-avx2.exe -dumpdir path\to\results\baseline -gsdir path\to\gs\dumps -renderer vulkan

Note: Renderer options are 'auto', 'dx11', 'dx12', 'gl', 'vulkan' or 'sw'

Run the python script again to generate a test set:

python test_run_dumps.py -runner path\to\modified-build\pcsx2-gsrunnerx64-avx2.exe -dumpdir path\to\results\modified -gsdir path\to\gs\dumps -renderer vulkan

Note: Renderer options are 'auto', 'dx11', 'dx12', 'gl', 'vulkan' or 'sw'

Now, you can compare them:

python test_check_dumps.py -baselinedir path\to\results\baseline -testdir path\to\results\modified changes.html

It will log any different frames to both the terminal, as well as the HTML file you specify. It ain't pretty, but it gets the job done.