1.3.0 • Published 4 months ago

minui-scraper v1.3.0

Weekly downloads
-
License
MIT
Repository
github
Last release
4 months ago

🎨 minui-scraper

NPM version Build Status Node version XO code style License

Artwork scraper for MinUI.

!NOTE MinUI does't officially support boxarts, but still has some support for it as stated by its author.

Features:

  • Scrapes boxart for your ROMs, in a MinUI compatible format
  • No account needed, uses libretro thumbnails
  • Optionally uses local AI with Ollama for better boxart matching
  • No configuration needed

Installation

Requires Node.js, and optionally Ollama for AI matching.

This tool works with a Command Line Interface (CLI), and need to be installed and run from a terminal application.

Install the CLI globally with:

npm install -g minui-scraper

Usage

To run the scraper, open a terminal and use the following command:

mscraper <rompath> [options]

!TIP Max width must be adjusted depending of the device, the default works well for Trimui Brick. For 640x480 devices, try with --width 200.

Options

  • -w, --width <size>: Max width of the image (default: 300)
  • -h, --height <size>: Max height of the image
  • -t, --type <type>: Type of image to scrape (can be boxart, snap, title, box+snap, box+title) (default: boxart)
  • -a, --ai: Use AI for advanced matching (default: false)
  • -m, --ai-model <name>: Ollama model to use for AI matching (default: gemma2:2b)
  • -r, --regions <regions>: Preferred regions to use for AI matching (default: World,Europe,USA,Japan)
  • -f, --force: Force scraping over existing images
  • --cleanup: Removes all scraped images in target folder
  • --verbose: Show detailed logs
  • -v, --version: Show current version

Example

mscraper myroms --width 300 --ai

This will scrape the ROMs in the myroms folder with a max image width of 300 and using AI for advanced matching.

Supported Systems

The following systems are supported for scraping:

  • Nintendo - Game Boy Color
  • Nintendo - Game Boy Advance
  • Nintendo - Game Boy
  • Nintendo - Super Nintendo Entertainment System
  • Nintendo - Nintendo 64DD
  • Nintendo - Nintendo 64
  • Nintendo - Family Computer Disk System
  • Nintendo - Nintendo Entertainment System
  • Nintendo - Nintendo DSi
  • Nintendo - Nintendo DS
  • Nintendo - Pokemon Mini
  • Nintendo - Virtual Boy
  • Handheld Electronic Game
  • Sega - 32X
  • Sega - Dreamcast
  • Sega - Mega Drive - Genesis
  • Sega - Mega-CD - Sega CD
  • Sega - Game Gear
  • Sega - Master System - Mark III
  • Sega - Saturn
  • Sony - PlayStation
  • Sony - PlayStation Portable
  • Amstrad - CPC
  • Atari - 2600
  • Atari - 5200
  • Atari - 7800
  • Atari - Jaguar
  • Atari - Lynx
  • Atari - ST
  • Bandai - WonderSwan Color
  • Bandai - WonderSwan
  • Coleco - ColecoVision
  • Commodore - Amiga
  • Commodore - VIC-20
  • Commodore - 64
  • FBNeo - Arcade Games
  • GCE - Vectrex
  • GamePark - GP32
  • MAME
  • Microsoft - MSX
  • Mattel - Intellivision
  • NEC - PC Engine CD - TurboGrafx-CD
  • NEC - PC Engine SuperGrafx
  • NEC - PC Engine - TurboGrafx 16
  • SNK - Neo Geo CD
  • SNK - Neo Geo Pocket Color
  • SNK - Neo Geo Pocket
  • SNK - Neo Geo
  • Magnavox - Odyssey2
  • TIC-80
  • Sharp - X68000
  • Watara - Supervision
  • DOS
  • DOOM
  • ScummVM
1.3.0

4 months ago

1.2.0

4 months ago

1.1.0

4 months ago

1.0.0

4 months ago