Getting Started - gabrielfvale/scrappy GitHub Wiki

Installation

To install Scrappy, follow these steps:

  1. Download the latest release (not the update package - that's for OTA!).
  2. Move the downloaded file to the /mnt/mmc/MUOS/ARCHIVE folder.
  3. Open Archive Manager and select the file.
  4. After extraction, you’ll find an entry called "Scrappy" in the Applications section.

When you run Scrappy for the first time, it will create two configuration files: skyscraper_config.ini and config.ini.

These files, and the rest of the Scrappy content, will be located at /mnt/mmc/MUOS/application/Scrappy/.scrappy

Post-Install

Screenscraper account

[!TIP] You can scrape without an account, but it's completely free and its usage limits are more than enough for most users.

It is highly recommended that you create a free Screenscraper account to avoid limiting the scraping process. If you want to speed up the scraping, consider supporting the website to get access to more threads.

Follow the instructions in the Configuration section to add your Screenscraper credentials. If no credentials are provided, you'll get this warning:

  • No credentials provided in skyscraper_config.ini

Core assignments

[!WARNING] Make sure you have cores assigned to your ROM folders. Scrappy reads from muOS to map which folders correspond to which platforms to scrape.

If no assigned cores are found, you'll get this warning:

  • No platforms found; your paths might not have cores assigned

Reporting bugs

This is a project that is being developed at a fast pace, and bugs will happen. If they happen to you, it is extremely important that you provide relevant information when opening an issue or requesting support in the Discord thread.

  1. Report which version of Scrappy you are running (v2.1.0 for example)
  2. Provide your log file of when the bug happened. Logs are located at /mnt/mmc/MUOS/application/Scrappy/.scrappy/logs
  3. If necessary, provide a screenshot of a crash or any other relevant information
  4. If necessary, provide your configuration files (config.ini and skyscraper_config.ini) removing your Screenscraper credentials first!