Skip to main content

romledger

Track which retro games you have and which are missing, verified against No-Intro and Redump DATs. It runs on one computer: point it at a folder of ROMs and it reports, per platform, what is there and what is not.

How it works

  1. Run romledger init once. It creates the config file, library/ and inbox/.
  2. Download a game: use the browser extension on Vimm's Lair, drop or upload files in the dashboard, or run romledger fetch. The files land in the inbox.
  3. Import. Under romledger serve it runs by itself; otherwise press Import in the dashboard or run romledger import. Each file is checked against the DAT, renamed to its DAT name and filed under library/<platform>/.
  4. Files that do not fit are set aside inside the inbox, never deleted: inbox/unmatched/ (not in any DAT), inbox/unwanted/ (a valid dump you did not ask for) and inbox/duplicates/ (you already have it).

The inbox is a plain folder. Copy files into it yourself, zipped or not, and the next import processes whatever is there. A zip is matched by the ROM inside it and the ROM is extracted, so you do not unzip it.

The romledger overview page: one card per platform with a progress bar and counts of games had, in the inbox, missing and unmatched.

A terminal running romledger status, which lists wanted, have, inbox, missing and unmatched counts per platform, then romledger missing snes, which lists missing games.

How it fits

  • igir matches files to DATs and moves them into place.
  • romledger decides what you have and what is missing.
  • RomM is optional. The library layout is RomM's folder naming (roms/<platform>/), and romledger works the same without RomM.

Install

Requires Python 3.11+ and Node.js 22.22+ (romledger runs igir through npx).

uv tool install romledger

or, with pipx:

pipx install romledger

Configure

romledger init

It asks for a ROM folder and the platforms to track, creates <roms>/library and <roms>/inbox, and writes ~/.config/romledger/config.toml. romledger platforms lists the platform names. Without a terminal, pass romledger init --roms ~/roms --platform nes --platform snes.

Then fetch the DATs, scan and open the dashboard:

romledger dats update
romledger scan
romledger serve --open

See docs/setup.md for all options, docs/deploy.md to run it as a container, docs/extension.md for the browser extension, docs/playing.md to play what you collect, docs/sources.md for download sources and docs/troubleshooting.md for error messages.

To work on romledger, see CONTRIBUTING.md.

Metadata

Release files for romledger 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for romledger 0.5.0
File Size Uploaded
romledger-0.5.0.tar.gz 239.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for romledger 0.5.0
File Interpreter ABI Platform
romledger-0.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 313.0 kB

Release files / romledger-0.5.0.tar.gz

Download URL romledger-0.5.0.tar.gz
Size 239.3 kB
Tags Source
SHA-256 checksum
How to use checksums
891b3e1065c9f3e7e17a21d6a265075a6581a6e45f2e9610538b0a6c271359ec
BLAKE2b-256 checksum
How to use checksums
8425c40ddc6cd2ddc7c6e8158b3e5581c7f6c5d1163a3fe2929e8a82135691c7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / romledger-0.5.0-py3-none-any.whl

Download URL romledger-0.5.0-py3-none-any.whl
Size 73.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4e91b87fee870869b41074d2bf25fc8e1bd5c368597247122c46e2caca31087a
BLAKE2b-256 checksum
How to use checksums
d0c917aeae6c5d8965187a75985f73c3aacd7be858ecf4dad51f73cfba8e0b7f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

0.5.1

2 release files

This release

0.5.0 This release

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page