MiSTer_artwork_pack

KO | EN

gitlite — search

#windows #automation #large-language-models #editor #ai-agent #cross-platform #database #python #tensorflow #svg

MiSTer_artwork_pack

(★ 9)

No description available.

File Explorer

ZIP Download

- dup_classify.py
- pack_index.py
.gitignore
bootstrap_repos.sh
build_pack.py
exclude_keys.py
excludes.tsv
media_rejects.tsv
names.tsv
neogeo_dat.py
overrides.tsv
PACK_FORMAT.md
publish.sh
README.md
reject_media.py
republish_all.sh
rotate_keys.py
rotations.tsv
scope.ini.example
stage_dats.sh
validate_db.py

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Builds game artwork packs for MiSTer FPGA, distributed through the standard
Downloader and selectable from **Update All** (2.10 or newer) under
*Extra Content → Game Artwork DBs*. Images are fetched from ScreenScraper
once, offline, and served as plain files on the SD card — consumers need no
network access and no credentials.

**Published today:** 39 systems, 23,658 images, in all three styles —
2.39 GB in `box2d`, 2.14 GB in `box3d`, 2.04 GB in `mixrbv2`. The three
serve the same games through the same index, so switching styles is a clean
replacement. The full list, with a `db_id` and repository per system, is in
[PACK_FORMAT.md](PACK_FORMAT.md).

This repository holds the builder. The images themselves live in separate
`artworkdb-*` repositories, one per hardware family.

## What a pack looks like on the SD card

```
docs/<System>/Artwork/<key>.jpg      the image
docs/<System>/Artwork/index.tsv      every known dump -> key
docs/<System>/Artwork/gameinfo.tsv   name, year, genre, developer, players
docs/<System>/Artwork/synopsis_*.tsv one per language
docs/<System>/Artwork/manifest.tsv   style and ScreenScraper system per image
```

The path is part of the format, not a configuration option. Reading a pack
means joining `docs/`, the system folder and the game key — nothing else.

**Keys** are No-Intro names for cartridges, Redump names for CD systems, and
MAME setnames for arcade and Neo Geo. **`index.tsv`** resolves everything
that is not an exact key: clones to their parent, alternate names, and
CRC+size. **`gameinfo.tsv`** also lists games that have metadata but no
image, so a consumer can still show details when artwork is missing.

Images are baseline JPEG, at most 768 px on the long side.

**Writing a consumer?** [PACK_FORMAT.md](PACK_FORMAT.md) is the
specification: the TSV columns, the resolution algorithm the MiSTer Monitor
uses, the shared-catalogue rules, and what is stable across releases.

## Styles

Three, mutually exclusive. A user installs one; consumers read whatever is
there and never need to know which.

| Style | Content | Example |
|---|---|:---:|
| `box2d` | flat box scan | <img src="https://raw.githubusercontent.com/chipster6502/artworkdb-sega/media-box2d/docs/Genesis/Artwork/Sonic%20The%20Hedgehog%20%28USA%2C%20Europe%29.jpg" height="200"> |
| `box3d` | 3D box render | <img src="https://raw.githubusercontent.com/chipster6502/artworkdb-sega/media-box3d/docs/Genesis/Artwork/Sonic%20The%20Hedgehog%20%28USA%2C%20Europe%29.jpg" height="200"> |
| `mixrbv2` | screenshot inside a TV frame | <img src="https://raw.githubusercontent.com/chipster6502/artworkdb-sega/media-mixrbv2/docs/Genesis/Artwork/Sonic%20The%20Hedgehog%20%28USA%2C%20Europe%29.jpg" height="200"> |

All three write the same path and share a `db_id`, so switching styles is a
clean replacement rather than two databases fighting over one file. All
three are published for every system in the table.

## Installing

### From Update All (recommended)

Update All 2.10 lists every pack. Run *Update All* from the Scripts menu,
press **UP** during the countdown to open the settings, and go to
**Extra Content → Game Artwork DBs**:

- **Select All** enables every system; each entry below it toggles one.
- **Style for Selected DBs** sets the style for everything selected. Each
  system can also carry its own style; the same three names appear in both
  places: **2D Boxes** (`box2d`), **3D Boxes** (`box3d`) and
  **Box + Screenshot** (`mixrbv2`).
- Save and let Update All run. It writes the selection to
  `downloader_chipster6502_artworkdb.ini` and the Downloader installs the
  images under `docs/`.

Changing a system's style replaces its images on the next run; deselecting
it removes them. Consumers do not need to know any of this — they read
whatever is on the card.

### By hand

For setups that run the Downloader without Update All, add one section per
system to `downloader.ini`. The `db_url` selects the style:

```ini
[chipster6502/artworkdb-genesis]
db_url = https://raw.githubusercontent.com/chipster6502/artworkdb-sega/db/genesis_box2d.json.zip
```

The URL follows one pattern for every system —
`artworkdb-<group>/db/<system>_<style>.json.zip` — and the group of each
system is in the table in [PACK_FORMAT.md](PACK_FORMAT.md).

Every file is tagged `docs`, `artwork`, `<system>` and `<system>artwork`, so
a global filter can narrow things down:

```ini
[mister]
filter = artwork !arcadeartwork
```

## Building

Four resumable stages, driven by `scope.ini`:

| Stage | Does |
|---|---|
| `identify` | queries ScreenScraper for each game in scope and caches the reply |
| `fetch` | downloads the first media in the style recipe that exists |
| `assemble` | normalises images, writes the TSVs |
| `package` | emits `db.json.zip` and the `downloader.ini` section |

Plus `verify`, which compares what is published against what was built —
run it before announcing an update — and `resolve`, which sweeps
ScreenScraper subsystems for games the transversality guard rejected and
proposes `overrides.tsv` lines.

```bash
export SS_DEVID=... SS_DEVPASSWORD=... SS_SSID=... SS_SSPASSWORD=...
python3 build_pack.py identify --system Genesis
python3 build_pack.py fetch    --system Genesis --style box3d
python3 build_pack.py assemble --system Genesis --style box3d --prune
python3 build_pack.py package  --system Genesis --style box3d
python3 build_pack.py verify   --system Genesis --style box3d
```

All state lives on disk. Any stage can be interrupted and resumed, and
deleting a file forces only that piece to be rebuilt. `--prune` removes
images whose key left the scope; `--retry-miss` re-queries games previously
marked as misses, which is how an edited `overrides.tsv` takes effect.

Five reviewed tables refine a build, and together with the DATs they are
what makes it reproducible: `overrides.tsv` pins the ScreenScraper subsystem
for a key whose name resolves elsewhere, `names.tsv` fixes a display name
where ScreenScraper's own is wrong, `rotations.tsv` turns a scan that
ScreenScraper stores sideways, `excludes.tsv` lists the keys reviewed out of
the pack — a demo, a hardware test, a box that is not the game's — which
`identify` never queries again, and `media_rejects.tsv` refuses one media of
one game without dropping the key, so a bad mix costs that game its mix and
nothing else. `neogeo_dat.py` turns the
Neo Geo core's `romsets.xml` into the Parent/Clone DAT the builder reads.

A second style mirrors the first: `--like box2d` makes `fetch` request only
the keys the `box2d` pack serves and `assemble` write the same keys through
the same `index.tsv`, copying the `box2d` image where the new style has
none — `manifest.tsv` records which style each image came from.

## Helpers

Around the four stages, in the order they are used:

| Script | Does |
|---|---|
| `stage_dats.sh` | copies the No-Intro DATs `scope.ini` expects from an unpacked No-Intro pack into `dats/`, under stable names; reports first, `apply` copies |
| `bootstrap_repos.sh` | clones every `artworkdb-<group>` repository into `../pub-<group>` and creates the `media-<style>` and `db` branches |
| `exclude_keys.py` | adds reviewed keys to `excludes.tsv` and deletes what was already built for them |
| `rotate_keys.py` | registers rotations in `rotations.tsv` for keys reviewed as sideways and deletes their built images so `assemble` re-encodes them |
| `reject_media.py` | registers a refused media in `media_rejects.tsv` and deletes only the images each style's manifest attributes to it |
| `publish.sh` | pushes one system to its media branch and its database to the `db` branch; refuses if anything outside that system would change |
| `republish_all.sh` | runs assemble–package–publish–verify for every system in `scope.ini`, stopping at the first failure |
| `tools/pack_index.py` | prints the *Published systems* table of `PACK_FORMAT.md` from the built databases, so the document is pasted, never typed |
| `validate_db.py` | parses a generated database with the Downloader's own code |
| `tools/dup_classify.py` | a measurement, not a step: checks that no two images in a system are the same box, and lists the byte-identical pairs across fiches for review |

Both key-list scripts read the keys from a file, one per line, because
No-Intro names carry parentheses, quotes and `!!` that the shell mangles even
when quoted.

## Configuration

Copy `scope.ini.example` to `scope.ini` and fill in your ScreenScraper
softname. Credentials are read **only** from the environment and are redacted
from caches and error output; they never touch the file.

Each style declares its own recipe and, where it matters, its own quality:

```ini
[style:box3d]
recipe = box-3D>mixrbv2
quality = 95
```

Quality is per style on purpose. Card blocks are typically 128 KB, so an image
below that threshold occupies a whole block anyway — the useful setting is the
highest quality that still fits in one. That lands at 85 for `box2d`, 95 for
`box3d` and 65 for `mixrbv2`. An image that still spills into a second block
is compressed a little harder until it fits, down to a floor of 75.

Each system declares which repository hosts its media:

```ini
[system:Genesis]
ss_id = 1
group = sega
```

The `db_id` stays per system regardless of `group`, so regrouping later only
changes the URL inside `db.json` and breaks nobody's `downloader.ini`.

## Credits

Artwork and metadata come from [ScreenScraper](https://www.screenscraper.fr),
contributed by its community. Arcade scope is derived from the MAME listxml.

MiSTer_artwork_pack

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

Download README