Quickstart

ℹ️
All commands should be run from the root of the boxart-buddy repository

Bootstrap 

make bootstrap

This will generate config files inside ./user_config folder.

    • config.yml
    • config_folder.yml
    • config_portmaster.yml
    • folder_roms.yml
    • name_extra.json

    • You must edit config.yml and config_folder.yml before you can proceed.

    Bootstrap attempts to auto generate config_folder.yml for you but there may be folders you need to map manually.

    See Configuration Reference for more details

    Download Cache (Optional) 

    make dl-cache

    You can download a cache file which will likely reduce the amount of roms you need to scrape, this is optional but highly recommended.

    Scrape 

    make scrape

    This process is slow and can take hours depending on number of roms
    This only needs to be done once.

    Generate 

    make build
    See templates gallery for previews
    See build options for options

    Standfirst

    Completed artwork will be output into ./package.
    See templates transfer for information on copying to device

    ⚠️
    After generating, some roms may be skipped due to not being scraped properly. See the skipped section for how to handle this
    InstallationSkipped