Installing Games

The process for installing games on your Arduboy is dependant on the variant you have. Older Arduboys can only support a single game whereas new FX and Mini variants are equipped with a flash chip that allows it to store many games at once and these are made accessible by a menu when the unit is first turned on.

Distribution Methods

Arduboy games can be distributed multiple ways and the method affects how it can be installed onto a physical unit.

Distribution methods include:

• as source code. Prior to installing the game, you will need to compile it within an Arduboy development environment - such as the Arduino IDE or VS Code - and then upload it to the unit. Refer to sections Installing a Single Game using the Arduino IDE, Installing a Single Game using the VS Code IDE or Installing a Single Game using the Arduboy Toolset for instructions.

• as a single .hex file. This is a compiled version of the game and is ready to be uploaded to a physical unit immediately. Refer to Installing a Single Game using the Arduboy Toolset for instructions.

• as a single .hex file and accompanied by one .bin files. The presence of the .bin file indicates that the game can only be used on an Arduboy FX, Arduboy Mini or a homegrown unit that has an FX chip and cannot be run on earlier variants. The .bin file maybe a 'development file' or a 'production file' and its important to know which type it is prior to attempting to upload it. Although not always the case, 'development files' will typically be named fxdata.bin and 'production files' will have a name similar to fxdata-data.bin. Refer to Installing a Single Game using the Arduboy Toolset for installing a game's .hex file and accompanying 'development file'. Refer to Adding a new game to the Arduboy Cart for installing a game's .hex file and accompanying 'production file'.

• as a single .hex file and accompanied by two .bin files. The presence of the two .bin files indicate that the game can only be used on an Arduboy FX, Arduboy Mini or a homegrown unit that has an FX chip and cannot be run on earlier variants. Refer to Adding a new game to the Arduboy Cart for installing a game's .hex file and accompanying .bin files.

• as an .arduboy file. The .arduboy format is an archive file that contains the program's main .hex file, any supporting .bin files and graphics in a single package for convenience. Refer to Adding a new game to the Arduboy Cart for installing an .arduboy file.

Installing a Single Game

Applies to all Arduboy variants.

There are many different ways to install a single game onto the Arduboy.

Installing a Single Game using the Arduino IDE

The Arduino IDE allows Arduboy programs to be compiled and uploaded to the unit automatically.

Detailed instructions can be found here.

Installing a Single Game using the VS Code IDE

The VS Code allows Arduboy programs to be compiled and uploaded to the unit automatically.

Detailed instructions can be found here.

Installing a Single Game using the Arduboy Toolset

The Arduboy Toolset provides a convenient, GUI based tool for uploading `.hex` files and (optionally) a single `'bin` file.

Detailed instructions can be found here.

Updating an Arduboy's Cart

Applies to the Arduboy FX, Arduboy Mini and homegrown variants that have an FX extension.