Installing Games: Difference between revisions

From Arduboy Wiki
Jump to navigation Jump to search
No edit summary
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:


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.
The process for installing games on your Arduboy is dependant on the [[What is the Arduboy#Arduboy Variants|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 ==
== Distribution Methods ==


Line 8: Line 7:
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. Refer to sections [[#Installing a Single Game using the Arduino IDE| Installing a Single Game using the Arduino IDE]] and
* 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 Arduino IDE]], [[#Installing a Single Game using the VS Code IDE| Installing a Single Game using the VS Code IDE]] or [[#Installing a Single Game using the Arduboy Toolset|Installing a Single Game using the Arduboy Toolset]] for instructions.
* as a single <code>.hex</code> file.
* 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.
 
asdasdasdas
das
d
asd
a
da
sd
asd
as
das
d
asd
asd
a
sda
sd
asd
as
asd
as
da
d
asd
as
asd
as
da
sd
asd
as
da
sd
asd
a
da
da
sd
as
da
sd
ad
a
sda
sd
asd
 
as
da
sd
a
dsa
sda
 
sd


a
* as a single <code>.hex</code> 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|Installing a Single Game using the Arduboy Toolset]] for instructions.


da
* as a single <code>.hex</code> file and accompanied by one <code>.bin</code> files. The presence of the <code>.bin</code> 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 [[What is the Arduboy#Arduboy Variants|variants]]. The <code>.bin</code> 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 <code>fxdata.bin</code> and 'production files' will have a name similar to <code>fxdata-data.bin</code>. Refer to [[#Installing a Single Game using the Arduboy Toolset|Installing a Single Game using the Arduboy Toolset]] for installing a game's <code>.hex</code> file and accompanying 'development file'.  Refer to [[#Adding a new game to the Arduboy Cart|Adding a new game to the Arduboy Cart]] for installing a game's <code>.hex</code> file and accompanying 'production file'. 
sd


asd
* as a single <code>.hex</code> file and accompanied by two <code>.bin</code> files. The presence of the two <code>.bin</code> 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 [[What is the Arduboy#Arduboy Variants|variants]]. Refer to [[#Adding a new game to the Arduboy Cart|Adding a new game to the Arduboy Cart]] for installing a game's <code>.hex</code> file and accompanying <code>.bin</code> files.
a
sd
asd
a
 
da
dasda
s


* as an <code>.arduboy</code> file. The <code>.arduboy</code> 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.  Refer to [[#Adding a new game to the Arduboy Cart|Adding a new game to the Arduboy Cart]] for installing an <code>.arduboy</code> file.
== Installing a Single Game ==
== Installing a Single Game ==


Applies to all Arduboy variants.
Applies to all Arduboy [[What is the Arduboy#Arduboy Variants|variants]].


There are many different ways to install a single game onto the Arduboy.  
There are many different ways to install a single game onto the Arduboy.  
Line 92: Line 25:


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.
 
Detailed instructions can be found [[Installing a Single Game using the Arduino IDE|here]].


=== Installing a Single Game using the VS Code IDE ===
=== Installing a Single Game using the VS Code IDE ===


The VS Code allows Arduboy programs to be compiled and uploaded to the unit automatically.  
The VS Code allows Arduboy programs to be compiled and uploaded to the unit automatically.  
Detailed instructions can be found [[Installing a Single Game using the VS Code IDE|here]].


=== Installing a Single Game using the Arduboy Toolset ===
=== 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.  
The Arduboy Toolset provides a convenient, GUI based tool for uploading `.hex` files and (optionally) a single `'bin` file.  
Detailed instructions can be found [[Installing a Single Game using the Arduboy Toolset|here]].


== Updating an Arduboy's Cart ==
== Updating an Arduboy's Cart ==


Applies to the Arduboy FX, Arduboy Mini and homegrown variants that have an FX extension.
Applies to the Arduboy FX, Arduboy Mini and homegrown variants that have an FX extension.
The Arduboy cart is actively maintained by the community with recent updates being posted in the community forum post [https://community.arduboy.com/t/arduboy-fx-cart-builder/10395 Arduboy FX Cart Builder].
=== Updating the Arduboy Cart with the 'Full Enchilada' ===
Updated carts can be flashed to the Arduboy a number of different ways:
* via the [https://www.bloggingadeadhorse.com/cart/Cart.html Cart Builder] website. Instructions can be found [[Flashing a Cart using Chrome / WebSerial|here]].
* using the [[Arduboy Toolset]]. Instructions can be found [[Flashing a Cart using the Arduboy Toolset|here]].
* using Mr.Blinky's Python Scripts. Instructions can be found [[Flashing a Cart using the Python Scripts|here]].
=== Adding a new game to the Arduboy Cart ===

Latest revision as of 02:44, 22 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 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.

The Arduboy cart is actively maintained by the community with recent updates being posted in the community forum post Arduboy FX Cart Builder.

Updating the Arduboy Cart with the 'Full Enchilada'

Updated carts can be flashed to the Arduboy a number of different ways:

Adding a new game to the Arduboy Cart