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
lo, listconfig	List current configuration values
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.

Media Types

A list of all supported media types is available in the Supported Media Types section of the overview.

System Types

A list of all supported system types is available in the Supported Systems section of the overview.

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.
-U <username> --username <username>	Redump Username	Requires --password. Include Redump credentials for pulling extra information from the site when generating the submission information
-P <password> --password <password>	Redump Password	Requires --username. Include Redump credentials for pulling extra information from the site when generating the submission information
--pull-all	Pull all information from Redump	Requires --username and --password. 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.
--log-compression	Set the log compression type	Requires --zip. One of the following values: deflate (Default DEFLATE), max (DEFLATE maximum), zstd (Zstd Level 19)
-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.

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.

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

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

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

Verify a DVD-Video dumped by Aaru.

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.

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

Verify a Sony PlayStation Portable UMD dumped with UmdImageCreator.

psp -u uic path\to\track.iso