OxyROMon is a cross-platform opinionated CLI ROM organizer written in Rust. Like most ROM managers, it checks ROM files against known good databases. It is designed with archiving in mind, as such it only supports original and lossless ROM formats. Sorting can be done in regions mode, in so-called 1G1R mode, or both.
Configuration is done from the command line and settings are stored in the SQLite database.
The database itself is stored in ${data_dir}/oxyromon as defined in the
dirs crate.
Available settings:
- ROM_DIRECTORY: Full path to your ROM directory, defaults to ${home_dir}/Emulation as defined in the
dirs crate
- TMP_DIRECTORY: Full path to a temporary directory for file extraction, defaults to
temp_dir
- DISCARD_FLAGS: List of ROM flags to discard (eg: Virtual Console)
- DISCARD_RELEASES: List of ROM releases to discard (eg: Beta)
- REGIONS_ALL: Unordered list of regions for which you want to keep all ROM files
- REGIONS_ONE: Ordered list of regions for which you want to keep a single ROM file
Note: TMP_DIRECTORY should have at least 8GB of free space to extract those big DVDs.
${ROM_DIRECTORY}
...
⮡ ${SYSTEM_NAME} # Base directory for each system, allowed regions will be stored here
⮡ 1G1R # Sub directory for 1G1R games
⮡ Trash # Sub directory for trashed games
...
These should be in your ${PATH} for extra features.
USAGE:
oxyromon [SUBCOMMAND]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
SUBCOMMANDS:
help Prints this message or the help of the given subcommand(s)
config Queries and modifies the oxyromon settings
import-dats Parses and imports No-Intro and Redump DAT files into oxyromon
download-dats Downloads No-Intro and Redump DAT files and imports them into oxyromon
import-roms Validates and imports ROM files into oxyromon
sort-roms Sorts ROM files according to region and version preferences
convert-roms Converts ROM files between common formats
check-roms Checks ROM files integrity
purge-roms Purges deleted or moved ROM files
Queries and configures the oxyromon settings
The settings can be queried, modified and deleted from the command line.
USAGE:
oxyromon config [FLAGS] [OPTIONS]
FLAGS:
-l, --list Prints the whole configuration
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-a, --add <KEY> <VALUE> Adds an entry to a list
-g, --get <KEY> Prints a single setting
-r, --remove <KEY> <VALUE> Removes an entry from a list
-s, --set <KEY> <VALUE> Configures a single setting
EXAMPLE:
oxyromon config -a REGIONS_ONE US
Parses and imports No-Intro and Redump DAT files into oxyromon
The standard Logiqx XML format is supported, this includes Parent-Clone DAT files.
Supported DAT providers: * No-Intro * Redump
Note: Some systems require a header definition to be placed alongside the DAT file.
USAGE:
oxyromon import-dats [FLAGS] <DATS>...
FLAGS:
-i, --info Shows the DAT information and exit
-h, --help Prints help information
-V, --version Prints version information
ARGS:
<DATS>... Sets the DAT files to import
Downloads No-Intro and Redump DAT files and imports them into oxyromon
Redump ofers direct downloads, but no summary, whereas No-Intro offers a summary but no direct downloads. For now the No-intro counterpart will only tell you if an update is available, but the Redump one is able to download brand new dats and update those you've already imported.
Supported DAT providers: * Redump (Download and update) * No-Intro (Update check only)
USAGE:
oxyromon download-dats [FLAGS] --nointro --redump
FLAGS:
-a, --all Imports all systems
-f, --force Forces import of outdated DAT files
-n, --nointro Downloads No-Intro DAT files
-r, --redump Downloads Redump DAT files
-u, --update Checks for system updates
-h, --help Prints help information
-V, --version Prints version information
Validates and imports ROM files into oxyromon
ROM files that match against the database will be placed in the base directory of the system they belong to. You will be prompted for the system you want to check your ROMs against. Most files will be moved as-is, with the exception of archives containing multiple games which are extracted.
Supported ROM formats: * All No-Intro and Redump supported formats * 7Z and ZIP archives * CHD (Compressed Hunks of Data) * CSO (Compressed ISO)
Note: Importing a CHD containing multiple partitions requires the matching CUE file from Redump.
USAGE:
oxyromon import-roms <ROMS>...
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
ARGS:
<ROMS>... Sets the rom files to import
Sorts ROM files according to region and version preferences
Sorting can be done using several strategies. You can also choose to discard certain types of games. Optionally you can print a list of games you may be missing, you hoarder, you.
Supported modes: - Regions mode - 1G1R mode - Hybrid mode
In regions mode, games belonging to at least one of the specified regions will be placed in the base directory of the
system.
Regions are set via the REGIONS_ALL setting, and can overriden via the CLI -g flag.
In 1G1R mode, only one game from a Parent-Clone game group will be placed in the 1G1R subdirectory, by order of
precedence.
Regions are set via the REGIONS_ONE setting, and can overriden via the CLI -r flag.
In hybrid mode, the 1G1R rule applies, plus all remaining games from the selected regions will be placed in the base directory.
In every mode, discarded games are placed in the Trash subdirectory.
1G1R and hybrid modes are still useful even without a Parent-Clone DAT file, it lets you separate games you will actually play, while keeping original Japanese games for translation patches and other hacks.
The region format uses 2-letter codes according to TOSEC's naming convention.
USAGE:
oxyromon sort-roms [FLAGS] [OPTIONS]
FLAGS:
-a, --all Sorts all systems
-m, --missing Shows missing games
-y, --yes Automatically says yes to prompts
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-g, --1g1r <REGIONS_ONE>... Sets the 1G1R regions to keep (ordered)
-r, --regions <REGIONS_ALL>... Sets the regions to keep (unordered)
EXAMPLE:
oxyromon sort-roms -g US EU -r US EU JP
Converts ROM files between common formats
ROMs can be converted back and forth at most one format away from their original format. That means you can convert an ISO to a CSO, but not a CSO to a 7Z archive. Invoking this command will convert all eligible roms for some or all systems. You may optionally filter ROMs by name, the matching string is not case sensitive and doesn't need to be the full ROM name.
Supported ROM formats:
Note: CHD will be extracted to their original split CUE/BIN when applicable.
USAGE:
oxyromon convert-roms [FLAGS] [OPTIONS]
FLAGS:
-a, --all Converts all systems/all ROMs
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-f, --format <FORMAT> Sets the destination format [possible values: 7Z, CHD, CSO, ORIGINAL, ZIP]
-n, --name <NAME> Selects ROMs by name
Checks ROM files integrity
This will scan every ROM file in each specified system and move corrupt files to their respective Trash directory.
USAGE:
oxyromon check-roms [FLAGS]
FLAGS:
-a, --all Checks all systems
-y, --yes Automatically says yes to prompts
-h, --help Prints help information
-V, --version Prints version information
Purges trashed, missing and orphan ROM files
This will optionally purge the database from every ROM file that has gone missing or that is not currently associated
with a ROM, as well as physically delete all files in the Trash subdirectories.
USAGE:
oxyromon purge-roms [FLAGS]
FLAGS:
-m, --missing Deletes missing ROM files from the database
-o, --orphan Deletes ROM files without an associated ROM from the database
-t, --trash Physically deletes ROM files from the trash directories
-y, --yes Automatically says yes to prompts
-h, --help Prints help information
-V, --version Prints version information