Configuration - gabrielfvale/scrappy GitHub Wiki

On first start, Scrappy creates two configuration files: skyscraper_config.ini and config.ini.

Skyscraper Config

The skyscraper_config.ini file is the main configuration used by Skyscraper. You can find the full guide on how to configure this file in Skyscraper's official documentation.

Example skyscraper_config.ini:

[main]
cacheFolder="/mnt/mmc/MUOS/application/.scrappy/data/cache"
gameListFolder="/mnt/mmc/MUOS/application/.scrappy/data/output"
artworkXml="/mnt/mmc/MUOS/application/.scrappy/templates/box2d.xml"
gameListBackup="false"
videos="false"
verbosity="0"
hints="false"
unattend="true"

[screenscraper]
userCreds="USER:PASS"

[!CAUTION] The cacheFolder, gameListFolder, and artworkXml settings are pre-filled with default values. You can change these to suit your preferences (e.g., store the cache on the second SD card). However, leaving them empty or specifying invalid folders will cause Scrappy to malfunction.

Adding Credentials

In the [screenscraper] section, the userCreds entry is where you should add your Screenscraper.fr credentials. While you don't need an account to run Scrappy, creating a free account will significantly increase your scraping limit, as anonymous users are restricted to a small daily quota.

Example:

[screenscraper]
userCreds="example:example"

Scrappy Config

The config.ini file contains several key settings used by Scrappy to configure how the application runs.

Example config.ini:

[main]
filterTemplates=1
parseCache=1
sd=1

[platforms]
Arcade = arcade
Atari Lynx = atarilynx

[platformsSelected]
Arcade = 1
Atari Lynx = 0

---

[main] Section

This section contains general application settings.

• filterTemplates
  Enables filtering of artwork based on the device's resolution. This is useful when generating artwork for devices with specific resolutions (e.g., RG CubeXX or RG 40XXV).

• parseCache
  When enabled, this setting prevents redundant actions by using cached artwork if it already exists. Disable it only if you need to re-download artwork (e.g., after changing regions or encountering cache issues).

• sd
  Specifies the SD card preference for ROMs (set to 1 for SD1, 2 for SD2).

---

[platforms] Section

This section defines the mapping of platform names to their folder names.

• platforms
  The [platforms] section automatically maps platform names to their corresponding folder names in the system. This mapping is used by Scrappy to correctly identify platforms when scraping artwork.

Example:

[platforms]
Arcade = arcade
Atari Lynx = atarilynx

---

[platformsSelected] Section

This section allows you to specify which platforms are selected for the scraping process.

• platformsSelected
  You can select which platforms will be included in the scraping process. A 1 means selected, and a 0 means not selected.

Example:

[platformsSelected]
Arcade = 1
Atari Lynx = 0

---

[overrides] Section (Advanced)

The [overrides] section is used for debugging or testing in non-standard environments. You can specify custom paths for your ROMs and catalogue here.

Example:

[overrides]
romPath = /home/USER/Downloads/scrappy/roms
cataloguePath = /home/USER/Downloads/muos/catalogue