hallem / pupdate Goto Github PK

A free utility for updating the openFPGA cores, firmware, and a bunch of other stuff on your Analogue Pocket.

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

I can't (and don't want to) support old versions, so please make sure you download the latest release before submitting any issues.

If you just want to use this utility, do not clone the source repository. Just download the latest release. Unzip it, put the executable file for your platform (windows, mac os, or linux) in the root of your sd card, and run the program.

At the main menu run Settings to have it walk through the available settings for you.

For a full view of the interactive console menu, see here.

Update All | Update Firmware | Select Cores | Download Assets | Backup Saves & Memories | Image Packs | Library Images | GameBoy Palettes | PC Engine CD | Game & Watch | Display Modes | Super GameBoy Aspect Ratio | Pocket Maintenance | Pocket Extras | Settings | Additional Settings | CLI Commands and Parameters | Jotego Beta Cores |

Install/Update all of your cores, plus a bunch of other stuff. It can basically be used as the "do everything I want" option. Everything marked with a * can be turned on/off via settings.

1. Checks for new firmware updates *
2. Compress and backup Saves and Memories *
3. Installs/updates every core you have selected
4. Checks for missing required assets for each core you have selected *
5. Deletes cores that you do not have selected *
6. Runs the instance JSON generator for each core you have selected (currently, only PC Engine CD) *
7. Rename every Jotego core you have selected *

Self explanatory. Just checks for firmware updates and exits.

This will prompt you to ask if you want new cores installed by default, with 3 options:

• Yes
  • Selecting this automatically chooses all existing cores, and will continue to automatically install new cores as they are released.
• No
  • Selecting this means as new cores are released, they will not be installed automatically, nor will you be asked about them. Then you will be presented with a list of all currently available cores, to select from for yourself.
• Ask
  • Selecting this means as new cores are released, you will be notified each time you run the app and have the option to select them for installation. Then you will be presented with a list of all currently available cores, to select from for yourself.

Checks for missing assets for each core you have selected (mainly arcade ROM files and BIOSes).

Note: You are responsible for finding and adding your own ROMs for non-arcade cores.

This will compress the Saves and Memories directories from your Pocket to the location specified in the config settings.

This will present you with a list of available image packs and automatically download and extract it to the Platforms/_images directory for you

This will download the System Library Images that were published by Spiritualized1997. They are used for the Library functionality on the Pocket.

This will download the palette files for the Pocket GameBoy cartridges. This is currently maintained by davewongillies on GitHub and by R.A.Helllord on Discord and Reddit.

Contents:

• All official GBC, SGB, NSO, and 3DS VC palettes
• Custom palettes for all Limited Edition Pockets
• SGB2 Vaporwave Edition palettes courtesy of flamepanther
• Trashuncle's palettes for Mister
• Sameboy and BGB palettes
• Pipboy palettes (Amber, Green, Blue, and White)
• 300+ palettes covering a ton of systems and themes by TheWolfBunny64

• Only supported by PC Engine CD, currently

• Put your games in /Assets/{platform}/common

• Each game needs to be in its own directory (and be sure to name the directory the full title of the game)

• Examples:

  • /Assets/pcecd/common/Rondo of Blood
  • /Assets/pcecd/common/Bonk
  • etc

• All games (for PC Engine CD) must be in cue/bin format. The generated json file will be saved using the same filename as the cue file, so be sure to also name that with the full title of the game

• When you run the Generate Instance JSON Files or Update All menu items, it will search through every directory in common and create a json file that can be launched by the core

• You can disable this process in Update All by setting build_instance_jsons to false in your settings file, if you don't want it to run every time you update.

How to build game and watch roms that are compatible with the Pocket:

Create 2 new folders.

/Assets/gameandwatch/agg23.GameAndWatch/artwork and /Assets/gameandwatch/agg23.GameAndWatch/roms

Place your [artwork].zip files into the artwork folder and your [rom].zip files into the roms folder

Should look like this:

/Assets/gameandwatch/agg23.GameAndWatch/artwork/gnw_dkong.zip

/Assets/gameandwatch/agg23.GameAndWatch/roms/gnw_dkong.zip

Now just run the menu option in the updater and it will build your games

This will enable all of the Pocket Display Modes for the openFPGA cores.

This allows you to apply the 8:7 aspect ratio to any of the Super GameBoy cores you may have installed. When selected you will be asked which cores you want to do this for.

The 8:7 aspect ratio gives you a more 'full screen' look and feel on the Pocket.

You also have the ability to reset any of the Super GameBoy cores back to the original 4:3 aspect ratio.

These give you the ability to reinstall all or select cores. The reinstall will erase and reinstall all core specific files and assets. It will not touch your ROMs or Save files.

If you wish to uninstall one or more cores, selecting 'Uninstall Select Cores' will allow you to choose which cores you'd like to remove. It will also prompt you to ask if you wish to remove core specific assets. Doing so will not touch your ROMs or Save files.

This section contains some extra functionality that individuals have created. Each item in this menu will provide a description and links to the authors GitHub before installing it. That way you get more information and can choose accordingly.

Note: If you are an advanced user, you can disable the description functionality by setting the show_menu_description config setting to false

There are 3 main categories:

This contains extras that enhance or modify existing cores. For example, addition additional ROM support to Arcade cores or allowing an Arcade core to load multiple games rather than just one.

This type of extra requires you have the necessary core installed. If you don't, you will be prompted to install it.

This contains new platforms that combine multiple cores into a single one. This helps in reducing the number of items you see in your openFPGA menu on your Pocket and to leverage the 'Change Core' functionality.

This contains a list of alternate core setups. These take existing cores and make copies of them with some changes, leaving the original core intact and providing new functionality with the additional core.

The following settings are all available via the Settings menu item.

The following settings can be set by editing pupdate_settings.json in a text editor.

  menu                     Interactive Main Menu (Default Verb)
    -p, --path                Absolute path to install location
    -s, --skip-update         Go straight to the menu, without looking for an update

  fund                     List sponsor links. Lists all if no core is provided
    -p, --path                Absolute path to install location
    -c, --core                The core to check funding links for
    
  update                   Run update all. (Can be configured via the settings menu)
    -p, --path                Absolute path to install location
    -c, --core                The core you want to update. Runs for all otherwise
    -r, --clean               Clean install. Remove all existing core files, and force a fresh re-install
  
  uninstall                Delete a core
    -p, --path                Absolute path to install location
    -c, --core                The core you want to uninstall. Required
    -a, --assets              Delete the core specific Assets folder. ex: Assets/{platform}/{corename}

  assets                   Run the asset downloader
    -p, --path                Absolute path to install location
    -c, --core                The core you want to download assets for.

  firmware                 Check for Pocket firmware updates
    -p, --path                Absolute path to install location

  images                   Download image packs
    -p, --path                Absolute path to install location
    -o, --owner               Image pack repo username
    -i, --imagepack           Github repo name for image pack
    -v, --variant             The optional variant

  instance-generator       Run the instance JSON generator for PC Engine CD
    -p, --path                Absolute path to install location

  backup-saves             Compress and backup Saves & Memories directories
    -p, --path                Absolute path to install location
    -l, --location            Absolute path to backup location. Required
    -s, --save                Save settings to the config file for use during 'Update All'

  gameboy-palettes         Run the instance JSON generator
    -p, --path                Absolute path to install location

  pocket-library-images    Run the instance JSON generator
    -p, --path                Absolute path to install location

  pocket-extras            Download Pocket Extras
    -p, --path                Absolute path to install location
    -n, --name                The name of the extra to install. Required
    -i, --info                Shows the details for the specified 'name'
    -l, --list                Lists out all of the values for 'name' and their details

  display-modes            Enable all Display Modes
    -p, --path                Absolute path to install location

  update-self              Check for updates to pupdate

  help                     Display more information on a specific command.

  version                  Display version information.

examples:

/path/to/pupdate -p /path/to/sdcard/

/path/to/pupdate update -c boogermann.bankpanic

/path/to/pupdate assets -c jotego.jtcontra

/path/to/pupdate images -i pocket-platform-images -o dyreschlock -v home

Now that Jotego is releasing his beta cores publicly (and requiring a beta key to play them), you can just drop the jtbeta.zip file from patreon onto the root of your sd card and run Update All, and it will automatically copy the beta key to the correct folders for the cores that need it. It also will let you install the yhe cores directly from the updater, now. Make sure you don't rename the file, it's going to look for exactly jtbeta.zip

• Slow asset downloads? Try toggling use_custom_archive to true, in your settings.

• If you run the update process and get a message like Error in framework RS: bridge not responding when running a core, try to run the updater in a local folder on your pc, and then copy the files over to the sd card afterwards. I'm not entirely sure what the issue is, but I've seen it reported a bunch of times now and running the updater locally seems to help.

• I keep getting a Missing ROM ID [1] message when trying to launch arcade games in the _alternatives folder. Check your settings and make sure you have Skip Alternative ROMS turned off.

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

Thanks to neil-morrison44. This is a port built on top of the work originally done by him here.

Michael Hallett for contributing a ton to the project.

RetroDriven for maintaining the arcade rom archive.

dyreschlock for hosting the updated platform files for Jotego's cores.

espiox for maintaining the game & watch rom archive.

If you're looking for something with a few more features and a user interface, check out this updater. https://github.com/RetroDriven/Pocket_Updater

Or if you want something cross platform that will run on a mac or linux: https://github.com/neil-morrison44/pocket-sync