Skip to main content

www.romhacking.net update checker

Project description

rhdndat finds rhdndat.ver files to check for romhacking.net updates

A version file is named rhdndat.ver and has a version number line followed by a romhacking.net url line, repeated. These correspond to each hack or translation. To check for needed updates to version file, if any patch version in the file does not match the version on the romhacking.net patch page, it presents a warning.

rhdndat-rn renames files and patches to new .DAT [1] [2] rom names if it can find the rom checksum in those .DAT files and memorizes the checksum of the ‘original rom’ as a extended attribute user.rhdndat.rom_sha1 to speed up renaming in subsequent executions (in unix, not windows).

To find the checksum of the original file for hardpatched roms, rhdndat-rn can support a custom convention for ‘revert patches’. Revert patches are a patch that you apply to a hardpatched file to get the original. These have the same name as the file and extension ‘.rxdelta’ and are done with xdelta3. I keep them for patch updates for cd images (since delta chd support is rare).

rhdndat-rn will read a xml dat file or every dat file from a directory given, and ask for renaming for every match where the rom filename is not equal to the dat name proposed. It will skip the question if all the names proposed already exist in the rom directory, and not allow a rename to a existing file in the rom directory.

Besides bare rom files, files affected by renames are compressed wii/gamecube .rvz files, .cue/.toc/.gdi (treated especially to not ask for every track), the softpatch types .ips, .bps, .ups, including the new retroarch multiple softpatch convention (a number after the softpatch extension), .rxdelta, .pal NES color palettes, and sbi subchannel data files.

No-intro recently changed its mind and all roms checksums in its dats no longer skip headers (regardless if they carry a headered and unheadered dat). To softpatch mismatching headers hacks, you can track down the right rom, hardpatch it, and create a softpatch from the current no-intro rom to the older patched rom. For sfc and pce ips hacks that target a headered rom I recommend ipsbehead³ to change the patch to target the no-header rom if possible.

When you update a no-intro set, all romhacks roms should not be also updated because otherwise the hacks stop working and yet users are encouraged go keep the same directory platforms roms in the same base directory, including hacks (for for example, have a single canonical retroarch playlist) which makes rhdndat-rn scans complain about the massive mismatching roms from older sets to the new set. I dont really encourage keeping a single combined hacks and nointro same directory set, but I do have a solution to make rhdndat-rn stop complaining: create a .rxdelta patch from each affected rom, to the new nointro rom, which allows you to update names for translations at least, if you keep the original name for those.

Requires xdelta3 (to process rxdelta) and dolphin-tool (to operate on rvz files) on path or the same directory.

To check for updates if you have the version files:

rhdndat romdir

check if there are any updates

To rename files if you have the dat files:

rhdndat-rn [--force] [--ext a78 --ext nes ...] romdir xmlpath

the rom extensions should be all file extensions on the files you want to rename (see below for default)

rhdndat [OPTIONS] ROMDIR
ROMDIR:

Directory to search for versions to check. [required]

--show

Show link to each checked directory.

--install-completion

Install completion for the current shell.

--show-completion

Show completion for the current shell, to copy it or customize the installation.

--help

Show this message and exit.

rhdndat-rn [OPTIONS] ROMDIR XMLPATH
ROMDIR:

Directory to search for roms to rename. [required]

XMLPATH:

Xml dat file or directory to search for xml dat files to use as source of new names. [required]

--skip DIRECTORY

Directory to skip, can be repeated.

--ext TEXT

ROM extensions to find names of, can be repeated. Note that you can ommit this argument to get the predefined list. [default: a78, hdi, fdi, ngc, ws, wsc, pce, gb, gba, gbc, n64, v64, z64, 3ds, nds, nes, lnx, fds, sfc, smc, bs, nsp, 32x, gg, sms, md, iso, dim, adf, ipf, dsi, wad, cue, gdi, toc, rvz]

--force

Force a recalculation and store of checksum (on windows the calculation always happens).

--no-rename

Check and store checksums only.

--verbose

Print more information about skipped roms.

--install-completion

Install completion for the current shell.

--show-completion

Show completion for the current shell, to copy it or customize the installation.

--help

Show this message and exit.

Install

rhdndat requires python 3.8 or later.

rhdndat may fail to execute in linux if the dir ~/.local/bin to is not in the $PATH.

In windows, you’ll want to check the option to “Add Python to PATH” when installing python.

The project can be installed with pip but you’ll have to provide your own xdelta3 and dolphin-tool executables in the path (or current dir) for supporting rvz and rxdelta.

In linux just installing xdelta3 from the repositories is enough, in windows, placing a executable for xdelta3 named xdelta3.exe in the python install Scripts directory if you installed with the path option selected is enough.

In linux you’ll have to build dolphin-tool (it’s not built by dolphin-emu packages) and place it in ~/.local/bin, and in windows you can copy it from the dolphin install directory, rename it to dolphin-tool.exe and place it in the python install Scripts directory.

Latest release

pip install --force-reinstall rhdndat

Current code

pip install --force-reinstall https://github.com/i30817/rhdndat/archive/master.zip

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rhdndat-2.8.1.tar.gz (29.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rhdndat-2.8.1-py3-none-any.whl (29.3 kB view details)

Uploaded Python 3

File details

Details for the file rhdndat-2.8.1.tar.gz.

File metadata

  • Download URL: rhdndat-2.8.1.tar.gz
  • Upload date:
  • Size: 29.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for rhdndat-2.8.1.tar.gz
Algorithm Hash digest
SHA256 ca6eddca9abae6d858ad1158c6017e3f9f3a01d81344cd69c0084199caa32fe3
MD5 36f147824c12ad71617672deecf5a501
BLAKE2b-256 3b15fdc0ca3d62c37904fd6a55537725b60ac0cef6a96f09c5479ed85c090858

See more details on using hashes here.

Provenance

The following attestation bundles were made for rhdndat-2.8.1.tar.gz:

Publisher: rhdndat.yml on i30817/rhdndat

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file rhdndat-2.8.1-py3-none-any.whl.

File metadata

  • Download URL: rhdndat-2.8.1-py3-none-any.whl
  • Upload date:
  • Size: 29.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for rhdndat-2.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7f83848eafe497db0c7c9ba04458fd5f96d8dbfcc8ad34ca58fa72ff72f969c5
MD5 c0a3becd5d79e21649ea0093008e59f9
BLAKE2b-256 a2f54d80d50713b8b1df9b1691ed09fda0fefb496e36e9e8225dd7724f653b04

See more details on using hashes here.

Provenance

The following attestation bundles were made for rhdndat-2.8.1-py3-none-any.whl:

Publisher: rhdndat.yml on i30817/rhdndat

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page