Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 3.21 KB

README.md

File metadata and controls

54 lines (39 loc) · 3.21 KB

Oh Hi

Current Release Downloads Donate

A free utility for updating the openFPGA cores, and firmware, on your Analogue Pocket. The update process will check for pocket firmware updates, openfpga core updates, and install any required BIOS files and arcade ROMS. You're on your own when it comes to console ROMs.

A complete list of available cores can also be found here: https://joshcampbell191.github.io/openfpga-cores-inventory/analogue-pocket

Instructions

To run the updater, all you need to do is put the executable file for your platform (windows, mac os, or linux) in the root of your sd card and run the program.

Advanced Usage

The updater currently accepts 4 command line parameters. I will probably add more options in the future

 -p, --path      Absolute path to install location
 -a, --all       Extract all release assets, instead of just ones containing openFPGA cores.
 -c, --coreselector    Run the core selector.
 -f, --platformsfolder   Preserve the Platforms folder, so customizations aren't overwritten by updates

example: /path/to/pocket_updater -a -p /path/to/sdcard/

Core Selector

On your first run it will prompt you to select the cores you want tracked. After that initial run, you can always run this again by setting core_selector to true in the settings json file, or if running from the cli you can use the paramater -c

Allow pre-release cores

You can edit your pocket_updater_settings.json file and set the allowPrerelease flag to true for any core want to download, even though it's still pre-release

Disable Firmware Downloading

Set config.download_firmware to false in your settings file

Disable Asset Downloading

Set config.download_assets to false in your settings file, if you'd like to supply your own BIOS and arcade rom files

Preserve Platforms Folder Customizations

If you have any customizations to the Platforms folder, you can use this option to preserve them during the update process. Set config.preserve_platforms_folder to true in your settings file, or use -f as a command line parameter

Github Personal Access Token

If you're running up against the rate limit on the github api, you can provide your personal access token to the updater via the settings. Edit your local copy of pocket_updater_settings.json and put your token in config.github_token

Submitting new cores

You can submit new cores here https://github.com/joshcampbell191/openfpga-cores-inventory

Credits

This is a port of the work initially done by neil-morrison44 here https://gist.github.com/neil-morrison44/34fbb18de90cd9a32ca5bdafb2a812b8 with a few tweaks to suit my needs

Special thanks to RetroDriven for maintaining the arcade rom archive