MPF Check

MPF Check

MPF Check is an optional commandline component in the MPF project. This came about as a response to a lack of UI support on the Linux side. The goal of this program is to provide the same powerful library parsing and generation but without having to deal with the actual dumping part.

Usage

MPF.Check <standalone> [/path/to/output.cue/iso] ...

OR

MPF.Check <system> [options] </path/to/output.cue/iso> ...

Standalone Options

Flags	Short Description	Long Description
-h, -?, --help	Show help	Displays a help text to show possible options and parameters.
--version	Print version	Prints the current program version and quits
-lc, --listcodes	List supported comment/content site codes	Shows a list of all Redump.org site codes, along with an indicator as to whether they go in the Comments field or the Contents field
-lm, --listmedia	List media types	Shows a list of all possible media types, including ones that are currently unsupported
-ls, --listsystems	List systems	Shows a list of all possible systems, including the ones that are currently unsupported
-lp, --listprograms	List programs	Shows a list of currently supported dumping and verification programs
-i, --interactive	Enable interactive mode	Enters a minimal interactive mode to provide a TUI-like interface for users who want it.

NOTE: Interactive mode still requires file paths to be provided, unlike the other standalone options. All options provided in interactive mode will apply to all input paths, the same as the standard options below.

Site Codes

A list of all site codes is maintained at the Redump Wiki and will not be mirrored here.

System Types

There are a lot of systems that are technically supported for dumping and verification if only because a lot of media is similarly accessible. For convenience, the list of currently accepted systems below has been separated into categories. Each entry has the short name used for MPF Check along with a brief description.

Arcade

Value	Description
NO SHORT NAME	Amiga CUBO CD32
NO SHORT NAME	American Laser Games 3DO
NO SHORT NAME	Atari 3DO
NO SHORT NAME	Atronic
NO SHORT NAME	AUSCOM System 1
NO SHORT NAME	Bally Game Magic
NO SHORT NAME	Capcom CP System III
fpp	funworld PHOTO PLAY
NO SHORT NAME	Global VR PC-Based Systems
NO SHORT NAME	Global VR Vortek
NO SHORT NAME	Global VR Vortek V3
NO SHORT NAME	ICE PC-based Hardware
ite	Incredible Technologies Eagle
NO SHORT NAME	Incredible Technologies PC-Based Systems
NO SHORT NAME	JVL iTouch
kea	Konami e-Amusement
kfb	Konami FireBeat
km2	Konami M2
NO SHORT NAME	Konami / Bemani Python
NO SHORT NAME	Konami / Bemani Python 2
ks573	Konami System 573
ksgv	Konami System GV
kt	Konami Twinkle
NO SHORT NAME	Konami PC-Based Systems
NO SHORT NAME	Merit Industries Boardwalk
NO SHORT NAME	Merit Industries MegaTouch Force
NO SHORT NAME	Merit Industries MegaTouch ION
NO SHORT NAME	Merit Industries MegaTouch Maxx
NO SHORT NAME	Merit Industries MegaTouch XL
trf	Namco / Sega / Nintendo Triforce
ns12	Namco System 12
ns246	Namco System 246 / System 256
NO SHORT NAME	New Jatre CD-i
NO SHORT NAME	Nichibutsu High Rate System
NO SHORT NAME	Nichibutsu Super CD
NO SHORT NAME	Nichibutsu X-Rate System
m2	Panasonic M2
NO SHORT NAME	PhotoPlay PC-based Systems
NO SHORT NAME	Raw Thrills PC-Based Systems
NO SHORT NAME	Sega ALLS
chihiro	Sega Chihiro
NO SHORT NAME	Sega Europa-R
lindbergh	Sega Lindbergh
naomi	Sega Naomi
naomi2	Sega Naomi 2
NO SHORT NAME	Sega Nu
sre	Sega RingEdge
sre2	Sega RingEdge 2
NO SHORT NAME	Sega RingWide
NO SHORT NAME	Sega System 32
stv	Sega Titan Video
NO SHORT NAME	Seibu CATS System
quizard	TAB-Austria Quizard
NO SHORT NAME	Tsunami TsuMo Multi Game Motion System
NO SHORT NAME	UltraCade PC-based Systems

Computers

Value	Description
arch	Acorn Archimedes CD
mac	Apple Macintosh
acd	Commodore Amiga CD
fmt	Fujitsu FM Towns series
pc	IBM PC-Compatibles
pc-88	NEC PC-88 series
pc-98	NEC PC-98 series
x68k	Sharp X68000

Consoles

Value	Description
ajcd	Atari Jaguar CD Interactive Multimedia System
playdia	Bandai Playdia Quick Interactive System
pippin	Apple-Bandai Pippin ATMARK and @WORLD
cd32	Commodore Amiga CD32
cdtv	Commodore CDTV
NO SHORT NAME	Envizions EVO Smart Console
NO SHORT NAME	Fujitsu FM Towns Marty
NO SHORT NAME	Hasbro iON Educational Gaming System
hvn	Hasbro VideoNow
hvnc	Hasbro VideoNow Color
hvnjr	Hasbro VideoNow Jr.
hvnxp	Hasbro VideoNow XP
ixl	Mattel / Fisher Price iXL Learning System
hs	Mattel HyperScan
vis	Tandy-Memorex Visual Information System
xbox	Microsoft Xbox
xbox360	Microsoft Xbox 360
xboxone	Microsoft Xbox One
xboxsx	Microsoft Xbox Series X
pce	NEC PC-Engine CD / TurboGrafx CD
pc-fx	NEC PC-FX and PC-FXGA
gc	Ninendo GameCube
NO SHORT NAME	Nintendo-Sony Super NES CD-ROM System
wii	Nintendo Wii
wiiu	Nintendo Wii U
3do	Panasonic 3DO Interactive Multiplayer
cdi	Philips Compact Disc-Interactive
dc	Sega Dreamcast
mcd	Sega Mega-CD / Sega CD / Sega 32X CD
ss	Sega Saturn
ngcd	SNK Neo Geo CD
psx	Sony PlayStation
ps2	Sony PlayStation 2
ps3	Sony PlayStation 3
ps4	Sony PlayStation 4
ps5	Sony PlayStation 5
psp	Sony PlayStation Portable
nuon	VM Labs Nuon
vflash	VTech V.Flash and V.Smile Pro
gamewave	ZAPiT Games GameWave Family Entertainment System

Other

Value	Description
audio-cd	Audio CD
bd-video	Blu-Ray Video
NO SHORT NAME	DVD-Audio
dvd-video	DVD-Video
enhanced-cd	Enhanced CD
hddvd-video	HD DVD-Video
navi21	Navisoft Naviken 2.1
palm	Palm OS
photo-cd	Photo-CD
psxgs	PlayStation GameShark Update discs
ppc	Pocket PC
NO SHORT NAME	Rainbow Disc
sp21	Sega Prologue 21 Multimedia Karaoke System
NO SHORT NAME	Sony Electronic Book
NO SHORT NAME	Super Audio CD
iktv	Tao iKTV
ksite	Tomy Kiss-Site
vcd	Video CD

Options

Flags	Short Description	Long Description
-u <program> --use <program>	Set dumping program	REQUIRED Set the dumping program associated with your outputs with this input. See Overview for more details about supported programs.
--load-seed <path>	Load a seed submission JSON for user information	For advanced use cases, provide a path to a pre-existing submission JSON to avoid having to type in all information manually.
--no-placeholders	Disable placeholder values in submission info	When generating the submission outputs, disable putting in placeholder values for required and highly-suggested fields.
--create-ird	Create IRD from output files	PS3 ONLY Creates a standardized IRD file from the program outputs, if possible.
--no-retrieve	Disable retrieving match information from Redump	By default, the program will attempt to be matched against Redump, retrieving a subset of information to fill in the output submission. This disables that ability entirely.
-c <username> <password> --credentials <username> <password>	Redump Credentials	Include Redump credentials for pulling extra information from the site when generating the submission information
--pull-all	Pull all information from Redump	Requires --credentials. Pull all disc information from Redump, even information that varies between discs with the same data.
-p <drivepath> --path <drivepath>	Physical drive path for additional checks	Include the path that contains the original media related to the output. This can allow for extra information to be included that would otherwise be skipped without original media.
-s --scan	Scan for protection	Requires --path. Scan the original media for copy protection using the built-in BinaryObjectScanner library.
--disable-archives	Disable scanning archives	Requires --scan. Disable scanning archive contents to speed up processing. Please note that this can result in incomplete protection scanning outputs.
--enable-debug	Enable debug protection information	Requires --scan. In addition to normal protection scanning outputs, include debug information to assist the developers.
--hide-drive-letters	Hide drive letters from scan output	Requires --scan. In instances where possible, hide the drive letters during protection scanning output. Please note that this may not work on all systems.
-x --suffix	Enable adding filename suffix	Adds a suffix to the produced filenames.
-j --json	Enable submission JSON output	Outputs a JSON formatted submission information file, including all standard information from the outputs.
--include-artifacts	Include artifacts in JSON	Requires --json. Include all relevant output files as encoded artifacts in the output JSON file. Binary files are encoded using Base64. The JSON output will then be compressed using gzip compression.
-z --zip	Enable log file compression	Compress the log files into a named Zip archive.
-d --delete	Enable unnecessary file deletion	Deletes all unnecessary files (auxiliary files produced by the dumping program that are not required for submission).

Examples

Verify an IBM PC-Compatible CD dumped by DiscImageCreator and pull information from Redump without the original disc.

cd pc -c username password path\to\track.cue

Verify a Sony PlayStation CD dumped with DiscImageCreator, pull information from Redump, and pull information from the disc.

cd psx -c username password -p D: path\to\track.cue

Verify a Wii disc dumped by CleanRip and pull information from Redump.

wii wii -c username password -u cleanrip path\to\track.iso

Verify a DVD-Video dumped by Aaru.

dvd dvd-video -u aaru path\to\track.iso

Verify an IBM PC-Compatible DVD dumped by DiscImageCreator, scan for copy protection, and get information from the original disc.

dvd pc -p D: -s path\to\track.iso

Verify a Sony PlayStation Portable UMD dumped with UmdImageCreator.

umd psp -u uic path\to\track.iso