Installing Games: Difference between revisions
No edit summary |
No edit summary |
||
Line 8: | Line 8: | ||
Distribution methods include: | 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. | * 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]] and | ||
* as a single <code>.hex</code> file. | |||
* as an `.arduboy` file. The `.arduboy` format is an archive file that contains the program's main | * as a single <code>.hex</code> file and accompanied by one or more <code>.bin</code> files. | ||
* as an `.arduboy` file. The `.arduboy` format is an archive file that contains the program's main <code>.hex</code> file, any supporting <code>.bin</code> files and graphics in a single package for convenience. | |||
== Installing a Single Game == | == Installing a Single Game == | ||
Line 21: | Line 22: | ||
The Arduino IDE allows Arduboy programs to be compiled and uploaded to the unit automatically. | The Arduino IDE allows Arduboy programs to be compiled and uploaded to the unit automatically. | ||
Compiling a game produces a <code>.hex</code> file and (optionally) one or more <code>.bin</code> files. | |||
=== Installing a Single Game using the VS Code IDE === | === Installing a Single Game using the VS Code IDE === |
Revision as of 04:28, 16 June 2024
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 and
- as a single
.hex
file. - as a single
.hex
file and accompanied by one or more.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.
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.
Compiling a game produces a .hex
file and (optionally) one or more .bin
files.
Installing a Single Game using the VS Code IDE
The VS Code allows Arduboy programs to be compiled and uploaded to the unit automatically.
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.
Updating an Arduboy's Cart
Applies to the Arduboy FX, Arduboy Mini and homegrown variants that have an FX extension.