Home

Skyscraper does not have a wiki. Instead, all documentation is located in the docs subfolder of the repository.

The different files in the docs subfolder provides documentation as follows:

• ARTWORK.md - Describes how to customize the artwork Skyscraper outputs for your gamelists.
• CACHE.md - Describes the Skyscraper resource cache. One of the most important features of the scraper.
• CLIHELP.md - A complete list and descriptions of all Skyscraper's available command-line options.
• CONFIGINI.md - A description of how Skyscraper's config.ini works (/home/USER/.skyscraper/config.ini) and all of the options that are available.
• FAQ.md - A Frequently Asked Questions document that aims to answer the most asked questions Skyscraper users have.
• IMPORT.md - Describes the import module of Skyscraper, which allows you to import your own artwork and textual data into the Skyscraper resource cache.
• LANGUAGES.md - Describes how languages are handled and set up inside of Skyscraper. This relates to the returned game descriptions and some other textual data.
• PLATFORMS.md - A full human-readable list of all the platforms Skyscraper currently supports.
• REGIONS.md - Describes how regions are handled and set up inside of Skyscraper. This relates to the returned game artwork such as specific region cover art.
• SCRAPINGMODULES.md - Describes all of the third-party sources that Skyscraper supports. This is where all of the data comes from.
• USECASE.md - A good read if you are a first-time user. It describes a typical use case of Skyscraper to get your feet wet.