Arduboy Wiki - User contributions [en]

Flashcart Format

2024-06-23T05:45:08Z

Haloopdy: /* Slot header */ Wrong type for reserved

The [[Flashcart]] is a binary blob stored on the external flash memory of [[Arduboy (Original)|Fx-modded Arduboys]], [[Arduboy FX]] and [[Arduboy Mini]]. It stores games and saves organized into categories.

== General format ==
(This section needs work; probably a visual representation of the cart)

The flashcart is a contiguous binary blob storing images, categories, sketches, data, and save data. It is separated into chunks called "slots", where each slot has a 256-byte header. Everything is a slot: both categories and programs. Each slot header is followed by a 1024-byte image which is shown on the Arduboy as you browse the flashcart, then all the data for that slot (sketch, data, save).

The flashcart ends when there are no more slots.

=== Slot header ===
Each slot in the flashcart starts with the 7 bytes for the ASCII string <code>ARDUBOY</code>. You know you have reached an invalid slot while scanning the flashcart when you reach a slot that does not start with those 7 bytes. The rest of the header are numbers and text explaining where items in the slot are and human-readable information about the program.

'''Note:''' all values on Arduboy are '''little endian'''

The header fields are as follows:
{| class="wikitable" style="margin:auto"
|+ Table describing the format of the Arduboy FX flashcart header
|-
! Byte Index !! Type !! Description
|-
| 0-6 || preamble || The bytes <code>ARDUBOY</code>
|-
| 7 || byte || Category number (mostly unused but required)
|-
| 8-9 || short || Previous slot page (0xFFFF if first slot) (page = 256 bytes)
|-
| 10-11 || short || Next slot page (0xFFFF if last slot)
|-
| 12-13 || short || Total slot size in pages
|-
| 14 || byte || Size of sketch in '''flash memory''' pages (128 bytes)
|-
| 15-16 || short || Starting page of sketch (technically redundant but required)
|-
| 17-18 || short || Starting page of FX data (0xFFFF if no FX data in slot)
|-
| 19-20 || short || Starting page of FX save (0xFFFF if no FX save in slot)
|-
| 21-22 || short || Size of FX data in pages ('''NOTE:''' not all cart builders set this value!)
|-
| 23-24 || short || Unused data (mostly)
|-
| 25-56 || sha256 || Raw bytes for SHA256 of program + data ('''after''' FX page align)
|-
| 57-255 || strings || Metadata for slot*
|}

==== Slot metadata ====
The final 199 bytes are used for 4 string fields, as follows:
* '''Title''' - Name of the program
* '''Version''' - Arbitrary text indicating the version of the program (no required format)
* '''Developer''' - Name of the developer or group for the program
* '''Description''' - A description of the program

Each field is separated by the null terminator, and the final field is truncated if it overflows. If the final field fills up the entire rest of the data, no null terminator is added.

The fields are not used on the Arduboy itself (they are not displayed anywhere), however they are '''extremely''' useful for cart editors, so they should always be included. Furthermore, certain cart editors depend on the version being in some recognizable form of [https://semver.org/ Semver] format, such as 0.1 or 1.0-r etc. Some cart editors use a combination of '''Title''' and '''Developer''' as a unique ID for the slot when figuring out if a program is new or an update.

'''Program slots''' use and expect all four fields, even if they're empty. Thus, at an absolute minimum, you should write <code>"\0\0\0\0"</code> to the metadata if you are not providing any information

'''Category slots''' only expect two fields: '''Title''' and '''Description'''. The version and developer fields are not stored. As a result, the minimum metadata for categories should be <code>"\0\0"</code>.

== Working with the flashcart ==
There are several programs which let you modify or create flashcarts:
* [[Cart Builder]] - This online repository of games will construct a custom cart for any given device
* [[Arduboy Toolset]] - This desktop app lets you modify flashcarts directly
* [[Ardugotools]] - This cli program gives you both low-level access to the flashcart and the ability to modify the flashcart with lua scripting
* [[Arduboy-Python-Utilitiles]] - The original python scripts made by the creator of the FX chip

Flashcart Format

2024-06-23T05:44:36Z

Haloopdy: /* Slot header */ Forgot the sha256

The [[Flashcart]] is a binary blob stored on the external flash memory of [[Arduboy (Original)|Fx-modded Arduboys]], [[Arduboy FX]] and [[Arduboy Mini]]. It stores games and saves organized into categories.

== General format ==
(This section needs work; probably a visual representation of the cart)

The flashcart is a contiguous binary blob storing images, categories, sketches, data, and save data. It is separated into chunks called "slots", where each slot has a 256-byte header. Everything is a slot: both categories and programs. Each slot header is followed by a 1024-byte image which is shown on the Arduboy as you browse the flashcart, then all the data for that slot (sketch, data, save).

The flashcart ends when there are no more slots.

=== Slot header ===
Each slot in the flashcart starts with the 7 bytes for the ASCII string <code>ARDUBOY</code>. You know you have reached an invalid slot while scanning the flashcart when you reach a slot that does not start with those 7 bytes. The rest of the header are numbers and text explaining where items in the slot are and human-readable information about the program.

'''Note:''' all values on Arduboy are '''little endian'''

The header fields are as follows:
{| class="wikitable" style="margin:auto"
|+ Table describing the format of the Arduboy FX flashcart header
|-
! Byte Index !! Type !! Description
|-
| 0-6 || preamble || The bytes <code>ARDUBOY</code>
|-
| 7 || byte || Category number (mostly unused but required)
|-
| 8-9 || short || Previous slot page (0xFFFF if first slot) (page = 256 bytes)
|-
| 10-11 || short || Next slot page (0xFFFF if last slot)
|-
| 12-13 || short || Total slot size in pages
|-
| 14 || byte || Size of sketch in '''flash memory''' pages (128 bytes)
|-
| 15-16 || short || Starting page of sketch (technically redundant but required)
|-
| 17-18 || short || Starting page of FX data (0xFFFF if no FX data in slot)
|-
| 19-20 || short || Starting page of FX save (0xFFFF if no FX save in slot)
|-
| 21-22 || short || Size of FX data in pages ('''NOTE:''' not all cart builders set this value!)
|-
| 23-24 || reserved || Unused data (mostly)
|-
| 25-56 || sha256 || Raw bytes for SHA256 of program + data ('''after''' FX page align)
|-
| 57-255 || strings || Metadata for slot*
|}

==== Slot metadata ====
The final 199 bytes are used for 4 string fields, as follows:
* '''Title''' - Name of the program
* '''Version''' - Arbitrary text indicating the version of the program (no required format)
* '''Developer''' - Name of the developer or group for the program
* '''Description''' - A description of the program

Each field is separated by the null terminator, and the final field is truncated if it overflows. If the final field fills up the entire rest of the data, no null terminator is added.

The fields are not used on the Arduboy itself (they are not displayed anywhere), however they are '''extremely''' useful for cart editors, so they should always be included. Furthermore, certain cart editors depend on the version being in some recognizable form of [https://semver.org/ Semver] format, such as 0.1 or 1.0-r etc. Some cart editors use a combination of '''Title''' and '''Developer''' as a unique ID for the slot when figuring out if a program is new or an update.

'''Program slots''' use and expect all four fields, even if they're empty. Thus, at an absolute minimum, you should write <code>"\0\0\0\0"</code> to the metadata if you are not providing any information

'''Category slots''' only expect two fields: '''Title''' and '''Description'''. The version and developer fields are not stored. As a result, the minimum metadata for categories should be <code>"\0\0"</code>.

== Working with the flashcart ==
There are several programs which let you modify or create flashcarts:
* [[Cart Builder]] - This online repository of games will construct a custom cart for any given device
* [[Arduboy Toolset]] - This desktop app lets you modify flashcarts directly
* [[Ardugotools]] - This cli program gives you both low-level access to the flashcart and the ability to modify the flashcart with lua scripting
* [[Arduboy-Python-Utilitiles]] - The original python scripts made by the creator of the FX chip

Flashcart Format

2024-06-22T22:30:35Z

Haloopdy: /* Slot header */ note about little endian

The [[Flashcart]] is a binary blob stored on the external flash memory of [[Arduboy (Original)|Fx-modded Arduboys]], [[Arduboy FX]] and [[Arduboy Mini]]. It stores games and saves organized into categories.

== General format ==
(This section needs work; probably a visual representation of the cart)

The flashcart is a contiguous binary blob storing images, categories, sketches, data, and save data. It is separated into chunks called "slots", where each slot has a 256-byte header. Everything is a slot: both categories and programs. Each slot header is followed by a 1024-byte image which is shown on the Arduboy as you browse the flashcart, then all the data for that slot (sketch, data, save).

The flashcart ends when there are no more slots.

=== Slot header ===
Each slot in the flashcart starts with the 7 bytes for the ASCII string <code>ARDUBOY</code>. You know you have reached an invalid slot while scanning the flashcart when you reach a slot that does not start with those 7 bytes. The rest of the header are numbers and text explaining where items in the slot are and human-readable information about the program.

'''Note:''' all values on Arduboy are '''little endian'''

The header fields are as follows:
{| class="wikitable" style="margin:auto"
|+ Table describing the format of the Arduboy FX flashcart header
|-
! Byte Index !! Type !! Description
|-
| 0-6 || preamble || The bytes <code>ARDUBOY</code>
|-
| 7 || byte || Category number (mostly unused but required)
|-
| 8-9 || short || Previous slot page (0xFFFF if first slot) (page = 256 bytes)
|-
| 10-11 || short || Next slot page (0xFFFF if last slot)
|-
| 12-13 || short || Total slot size in pages
|-
| 14 || byte || Size of sketch in '''flash memory''' pages (128 bytes)
|-
| 15-16 || short || Starting page of sketch (technically redundant but required)
|-
| 17-18 || short || Starting page of FX data (0xFFFF if no FX data in slot)
|-
| 19-20 || short || Starting page of FX save (0xFFFF if no FX save in slot)
|-
| 21-22 || short || Size of FX data in pages ('''NOTE:''' not all cart builders set this value!)
|-
| 23-56 || reserved || Unused data (mostly)
|-
| 57-255 || strings || Metadata for slot*
|}

==== Slot metadata ====
The final 199 bytes are used for 4 string fields, as follows:
* '''Title''' - Name of the program
* '''Version''' - Arbitrary text indicating the version of the program (no required format)
* '''Developer''' - Name of the developer or group for the program
* '''Description''' - A description of the program

Each field is separated by the null terminator, and the final field is truncated if it overflows. If the final field fills up the entire rest of the data, no null terminator is added.

The fields are not used on the Arduboy itself (they are not displayed anywhere), however they are '''extremely''' useful for cart editors, so they should always be included. Furthermore, certain cart editors depend on the version being in some recognizable form of [https://semver.org/ Semver] format, such as 0.1 or 1.0-r etc. Some cart editors use a combination of '''Title''' and '''Developer''' as a unique ID for the slot when figuring out if a program is new or an update.

'''Program slots''' use and expect all four fields, even if they're empty. Thus, at an absolute minimum, you should write <code>"\0\0\0\0"</code> to the metadata if you are not providing any information

'''Category slots''' only expect two fields: '''Title''' and '''Description'''. The version and developer fields are not stored. As a result, the minimum metadata for categories should be <code>"\0\0"</code>.

== Working with the flashcart ==
There are several programs which let you modify or create flashcarts:
* [[Cart Builder]] - This online repository of games will construct a custom cart for any given device
* [[Arduboy Toolset]] - This desktop app lets you modify flashcarts directly
* [[Ardugotools]] - This cli program gives you both low-level access to the flashcart and the ability to modify the flashcart with lua scripting
* [[Arduboy-Python-Utilitiles]] - The original python scripts made by the creator of the FX chip

Flashcart Format

2024-06-22T22:27:48Z

Haloopdy: Beginning new documentation for flashcart

The [[Flashcart]] is a binary blob stored on the external flash memory of [[Arduboy (Original)|Fx-modded Arduboys]], [[Arduboy FX]] and [[Arduboy Mini]]. It stores games and saves organized into categories.

== General format ==
(This section needs work; probably a visual representation of the cart)

The flashcart is a contiguous binary blob storing images, categories, sketches, data, and save data. It is separated into chunks called "slots", where each slot has a 256-byte header. Everything is a slot: both categories and programs. Each slot header is followed by a 1024-byte image which is shown on the Arduboy as you browse the flashcart, then all the data for that slot (sketch, data, save).

The flashcart ends when there are no more slots.

=== Slot header ===
Each slot in the flashcart starts with the 7 bytes for the ASCII string <code>ARDUBOY</code>. You know you have reached an invalid slot while scanning the flashcart when you reach a slot that does not start with those 7 bytes. The rest of the header are numbers and text explaining where items in the slot are and human-readable information about the program.

The header fields are as follows:
{| class="wikitable" style="margin:auto"
|+ Table describing the format of the Arduboy FX flashcart header
|-
! Byte Index !! Type !! Description
|-
| 0-6 || preamble || The bytes <code>ARDUBOY</code>
|-
| 7 || byte || Category number (mostly unused but required)
|-
| 8-9 || short || Previous slot page (0xFFFF if first slot) (page = 256 bytes)
|-
| 10-11 || short || Next slot page (0xFFFF if last slot)
|-
| 12-13 || short || Total slot size in pages
|-
| 14 || byte || Size of sketch in '''flash memory''' pages (128 bytes)
|-
| 15-16 || short || Starting page of sketch (technically redundant but required)
|-
| 17-18 || short || Starting page of FX data (0xFFFF if no FX data in slot)
|-
| 19-20 || short || Starting page of FX save (0xFFFF if no FX save in slot)
|-
| 21-22 || short || Size of FX data in pages ('''NOTE:''' not all cart builders set this value!)
|-
| 23-56 || reserved || Unused data (mostly)
|-
| 57-255 || strings || Metadata for slot*
|}

==== Slot metadata ====
The final 199 bytes are used for 4 string fields, as follows:
* '''Title''' - Name of the program
* '''Version''' - Arbitrary text indicating the version of the program (no required format)
* '''Developer''' - Name of the developer or group for the program
* '''Description''' - A description of the program

Each field is separated by the null terminator, and the final field is truncated if it overflows. If the final field fills up the entire rest of the data, no null terminator is added.

The fields are not used on the Arduboy itself (they are not displayed anywhere), however they are '''extremely''' useful for cart editors, so they should always be included. Furthermore, certain cart editors depend on the version being in some recognizable form of [https://semver.org/ Semver] format, such as 0.1 or 1.0-r etc. Some cart editors use a combination of '''Title''' and '''Developer''' as a unique ID for the slot when figuring out if a program is new or an update.

'''Program slots''' use and expect all four fields, even if they're empty. Thus, at an absolute minimum, you should write <code>"\0\0\0\0"</code> to the metadata if you are not providing any information

'''Category slots''' only expect two fields: '''Title''' and '''Description'''. The version and developer fields are not stored. As a result, the minimum metadata for categories should be <code>"\0\0"</code>.

== Working with the flashcart ==
There are several programs which let you modify or create flashcarts:
* [[Cart Builder]] - This online repository of games will construct a custom cart for any given device
* [[Arduboy Toolset]] - This desktop app lets you modify flashcarts directly
* [[Ardugotools]] - This cli program gives you both low-level access to the flashcart and the ability to modify the flashcart with lua scripting
* [[Arduboy-Python-Utilitiles]] - The original python scripts made by the creator of the FX chip

Main Page

2024-06-22T21:50:56Z

Haloopdy: Add flashcart format page + documentation section

== Getting started ==

* [[What is the Arduboy|What is the Arduboy?]]
** [[What is the Arduboy#Arduboy Variants|Arduboy Variants]]
* [[Installing Games]]
* [[Developing Games]]

Don't know where to start at all? See the official [https://www.arduboy.com/quick-start Quickstart guide] for a simplified overview.

There is also a [https://community.arduboy.com/t/quick-start-guide/2790 Legacy Quickstart guide] that might be of some use (made for older Arduboy variants but still mostly relevant)

== Community ==

Come chat with the community and show off your games at https://community.arduboy.com/! The bulk of the Arduboy community exists on the forums; there isn't an official Discord/etc.

* '''Main Arduboy website:''' https://www.arduboy.com/
* '''Community website:''' https://community.arduboy.com/

== Tools ==
* [[Ardens]] - Debugger, profiler, and emulator
* [[Arduboy Toolset]] - Various tools for uploading, converting, etc
* [[Cart Builder]] - Home for the official flashcart + all games made available for it
* [[Arduboy-Python-Utilities]] - Command line python tools for uploading, converting, etc

== Tutorials ==
* State Machines
** [[State%20Machines|Introduction]]
** [[State Machines - Organising Variables|Organising Variables]]
* [[Frogger Getting Started|Frogger]]

== Documentation ==
* [[Flashcart Format]]

Main Page

2024-06-21T16:46:13Z

Haloopdy: /* Tools */ Add descriptions + ardens

Arduboy Toolset

2024-06-21T16:41:02Z

Haloopdy: Normalize spacing according to Filmote's edits

[[File:Screenshot_tools_main.png|thumb]]
[[File:Screenshot_cartbuilder_main.png|thumb]]
[[File:Screenshot_imageconvert_main.png|thumb]]
[[File:Screenshot_package_main.png|thumb]]

The [https://github.com/randomouscrap98/arduboy_toolset Arduboy Toolset] is a cross-platform, all-in-one, portable application for working with Arduboy. It lets you do almost everything you'd need, aside from compiling games

This is a GUI program written in Python. If you want a lightweight CLI program instead, see [[Ardugotools]]

== Download ==

Get the latest version from [https://github.com/randomouscrap98/arduboy_toolset/releases/latest Github releases]

== Features ==

* Upload and backup [[Sketches]], [[Flashcart|Flashcarts]], and [[EEPROM]]
* [[Converting Images|Convert images]] to program data (sprites, tilesheets, etc)
* Modify the [[Flashcart]] to add games, modify categories + title images, etc
* Update your [[Arduboy FX]] and [[Arduboy Mini]] with the latest games from the [[Cart Builder]]
* Create [[Arduboy Package|Arduboy Packages]] to share you games with the community

== Using the toolset ==

See the forum post for more information: https://community.arduboy.com/t/arduboy-toolset/11227

== FAQ ==

==== The toolset doesn't run on my system ====

===== Windows =====
The toolset targets Windows 10+. The targets for Windows and Mac are determined by [https://pyinstaller.org/en/stable/ PyInstaller], so I don't have control over the very high targets (I'm sorry).

===== MacOS =====
The toolset targets the latest MacOS. The targets for Windows and Mac are determined by [https://pyinstaller.org/en/stable/ PyInstaller], so I don't have control over the very high targets (I'm sorry).

If you are having trouble opening the app, you may have to follow special instructions to get MacOS to "trust" the app, since it is unsigned: https://community.arduboy.com/t/arduboy-toolset/11227/69

===== Linux =====
The toolset targets Python 3.8 and QT 6. I know that's a weird combo, I'm sorry.

If you suspect you are having a different issue, please open an issue on [https://github.com/randomouscrap98/arduboy_toolset/issues Github] or leave a post on the [https://community.arduboy.com/t/arduboy-toolset/11227 Community thread].

==== Windows/etc is reporting the toolset has a virus ====
Virus detection is imprecise and basically all programs built with [https://pyinstaller.org/en/stable/ Pyinstaller] will be flagged as a virus. I understand if this causes you not to want to use the program, but you should know this is a [https://github.com/pyinstaller/pyinstaller/issues?q=label%3Aantivirus-false-positives+is%3Aclosed widely known issue] that doesn't seem able to be overcome at this time.

==== How do I get to the so-called "cart editor" ====
https://community.arduboy.com/t/arduboy-toolset/11227/27

==== How do I get the latest games on my flashcart? ====
https://community.arduboy.com/t/arduboy-toolset/11227/198

==== How do I add a game to the flashcart? ====
https://community.arduboy.com/t/arduboy-toolset/11227/147

What is the Arduboy

2024-06-21T16:34:10Z

Haloopdy: Added basic hardware overview and additional suggested pages we need

Arduboy is both a [https://www.arduboy.com/shop device you can buy] and an [https://community.arduboy.com/t/12-arduboy-compatible-system/236 open specification](verification needed) for an [https://www.arduino.cc/ Arduino]-powered 8-bit gaming device. Think "open-source modern gameboy".

It comes in various configurations, with the most common being the [[Arduboy FX]]. This configuration gives you a credit-card-sized game system with the ability to store up to 16MiB of programs, called [[Sketches]]. Other configurations (such as the [[Original]] and older) didn't come with this extra storage and can only play one game at a time. See [[#Determining Hardware|Determining Hardware]](section needed) to figure out which device you have.

== Hardware ==

=== Board ===
All Arduboys are built around an [https://docs.arduino.cc/hardware/leonardo/ Arduino Leonardo] board, which has an [https://www.microchip.com/en-us/product/atmega32u4 ATmega32u4] microcontroller. This gives it:
* 16Mhz 8-bit CPU
* 2.5KiB RAM
* 32KiB Flash (program memory)
* Options for 2-4KiB protected [[Bootloader]]
* Various IO pins for input, screen, etc

=== Display ===
Arduboys are designed to use a 128x64 black and white (1 bit) display. Many Arduboy devices use a screen capable of running in a limited [[Grayscale|grayscale mode]]; you may see some games designed to take advantage of this.

All premade Arduboys use a black and white OLED panel, typically the [https://cdn-shop.adafruit.com/datasheets/SSD1306.pdf SSD1306], which is capable of using the aforementioned grayscale mode.

=== IO ===
Arduboys are designed to use 6 buttons: 4 cardinal direction inputs (d-pad) and two buttons (A and B). The Arduboy also has either a micro USB or USB-C port for flashing games and providing limited control over the system.

=== Additional Storage ===
Without "external storage" (external to the Arduino board, not generally something you insert or attach), the Arduboy is only capable of storing and running 1 game at a time, from its onboard 32KiB flash. The [[Arduboy FX]] and [[Arduboy Mini]] both have an additional 16MiB NAND flash soldered on, often referred to as just the [[FX chip]], which allows the Arduboy to select from any game stored in a [[Flashcart]].

This started as a mod chip for the original Arduboy, hence the name "FX chip", and eventually became part of the prebuilt system, now called the Arduboy FX. An original Arduboy modded with the FX chip is functionally equivalent to an Arduboy FX.

== Arduboy Variants ==

* [[Arduboy DevKit|DevKit]]
* [[Arduboy Kickstarter Editions|Kickstarter editions]]
* [[Arduboy (Original)|Original]]
* [[Arduboy FX|FX]]
* [[Arduboy Mini|Mini]]

Arduboy Toolset

2024-06-21T01:14:37Z

Haloopdy: Add screenshots (will fix up later)

File:Screenshot tools main.png

2024-06-21T01:10:24Z

Haloopdy:

File:Screenshot cartbuilder main.png

2024-06-21T01:10:13Z

Haloopdy:

File:Screenshot package main.png

2024-06-21T01:09:55Z

Haloopdy:

File:Screenshot imageconvert main.png

2024-06-21T01:08:22Z

Haloopdy: Image conversion in Arduboy Toolset

== Summary ==
Image conversion in Arduboy Toolset

Arduboy Toolset

2024-06-21T01:01:19Z

Haloopdy: /* FAQ */ Spacing

The [https://github.com/randomouscrap98/arduboy_toolset Arduboy Toolset] is a cross-platform, all-in-one, portable application for working with Arduboy. It lets you do almost everything you'd need, aside from compiling games:
* Upload and backup [[Sketches]], [[Flashcart|Flashcarts]], and [[EEPROM]]
* [[Converting Images|Convert images]] to program data (sprites, tilesheets, etc)
* Modify the [[Flashcart]] to add games, modify categories + title images, etc
* Update your [[Arduboy FX]] and [[Arduboy Mini]] with the latest games from the [[Cart Builder]]
* Create [[Arduboy Package|Arduboy Packages]] to share you games with the community

This is a GUI program written in Python. If you want a lightweight CLI program instead, see [[Ardugotools]]

== Using the toolset ==

See the forum post for more information: https://community.arduboy.com/t/arduboy-toolset/11227

== FAQ ==

==== The toolset doesn't run on my system ====

===== Windows =====
The toolset targets Windows 10+. The targets for Windows and Mac are determined by [https://pyinstaller.org/en/stable/ PyInstaller], so I don't have control over the very high targets (I'm sorry).

===== MacOS =====
The toolset targets the latest MacOS. The targets for Windows and Mac are determined by [https://pyinstaller.org/en/stable/ PyInstaller], so I don't have control over the very high targets (I'm sorry).

If you are having trouble opening the app, you may have to follow special instructions to get MacOS to "trust" the app, since it is unsigned: https://community.arduboy.com/t/arduboy-toolset/11227/69

===== Linux =====
The toolset targets Python 3.8 and QT 6. I know that's a weird combo, I'm sorry.

If you suspect you are having a different issue, please open an issue on [https://github.com/randomouscrap98/arduboy_toolset/issues Github] or leave a post on the [https://community.arduboy.com/t/arduboy-toolset/11227 Community thread].

==== Windows/etc is reporting the toolset has a virus ====
Virus detection is imprecise and basically all programs built with [https://pyinstaller.org/en/stable/ Pyinstaller] will be flagged as a virus. I understand if this causes you not to want to use the program, but you should know this is a [https://github.com/pyinstaller/pyinstaller/issues?q=label%3Aantivirus-false-positives+is%3Aclosed widely known issue] that doesn't seem able to be overcome at this time.

==== How do I get to the so-called "cart editor" ====
https://community.arduboy.com/t/arduboy-toolset/11227/27

==== How do I get the latest games on my flashcart? ====
https://community.arduboy.com/t/arduboy-toolset/11227/198

==== How do I add a game to the flashcart? ====
https://community.arduboy.com/t/arduboy-toolset/11227/147

Arduboy Toolset

2024-06-21T01:00:42Z

Haloopdy: Expand upon "not working" section

Arduboy Toolset

2024-06-21T00:57:13Z

Haloopdy: FAQ

The [https://github.com/randomouscrap98/arduboy_toolset Arduboy Toolset] is a cross-platform, all-in-one, portable application for working with Arduboy. It lets you do almost everything you'd need, aside from compiling games:
* Upload and backup [[Sketches]], [[Flashcart|Flashcarts]], and [[EEPROM]]
* [[Converting Images|Convert images]] to program data (sprites, tilesheets, etc)
* Modify the [[Flashcart]] to add games, modify categories + title images, etc
* Update your [[Arduboy FX]] and [[Arduboy Mini]] with the latest games from the [[Cart Builder]]
* Create [[Arduboy Package|Arduboy Packages]] to share you games with the community

This is a GUI program written in Python. If you want a lightweight CLI program instead, see [[Ardugotools]]

== Using the toolset ==

See the forum post for more information: https://community.arduboy.com/t/arduboy-toolset/11227

== FAQ ==

==== The toolset doesn't run on my system (Windows) ====
The toolset targets Windows 10+. The targets for Windows and Mac are determined by [https://pyinstaller.org/en/stable/ PyInstaller], so I don't have control over the very high targets (I'm sorry).

If you suspect you are having a different issue, please open an issue on [https://github.com/randomouscrap98/arduboy_toolset/issues Github] or leave a post on the [https://community.arduboy.com/t/arduboy-toolset/11227 Community thread].

==== Windows/etc is reporting the toolset has a virus ====
Virus detection is imprecise and basically all programs built with [https://pyinstaller.org/en/stable/ Pyinstaller] will be flagged as a virus. I understand if this causes you not to want to use the program, but you should know this is a [https://github.com/pyinstaller/pyinstaller/issues?q=label%3Aantivirus-false-positives+is%3Aclosed widely known issue] that doesn't seem able to be overcome at this time.

==== How do I get to the so-called "cart editor" ====
https://community.arduboy.com/t/arduboy-toolset/11227/27

==== How do I get the latest games on my flashcart? ====
https://community.arduboy.com/t/arduboy-toolset/11227/198

==== How do I add a game to the flashcart? ====
https://community.arduboy.com/t/arduboy-toolset/11227/147

Arduboy Toolset

2024-06-21T00:47:09Z

Haloopdy: Add initial information on Arduboy Toolset

What is the Arduboy

2024-06-21T00:36:41Z

Haloopdy: Change some links to actual pages for topics that are probably too big for a single subsection

What is the Arduboy

2024-06-21T00:32:15Z

Haloopdy: Add actual link to DIY arduboy post

Main Page

2024-06-21T00:30:08Z

Haloopdy: /* Getting started */ Add legacy quickstart guide for organization

== Getting started ==

* [[What is the Arduboy|What is the Arduboy?]]
** [[What is the Arduboy#Arduboy Variants|Arduboy Variants]]
* [[Installing Games]]
* [[Developing Games]]

Don't know where to start at all? See the official [https://www.arduboy.com/quick-start Quickstart guide] for a simplified overview.

There is also a [https://community.arduboy.com/t/quick-start-guide/2790 Legacy Quickstart guide] that might be of some use (made for older Arduboy variants but still mostly relevant)

== Community ==

Come chat with the community and show off your games at https://community.arduboy.com/! The bulk of the Arduboy community exists on the forums; there isn't an official Discord/etc.

* '''Main Arduboy website:''' https://www.arduboy.com/
* '''Community website:''' https://community.arduboy.com/

== Tools ==
* [[Arduboy Toolset]]
* [[Cart Builder]]
* [[Arduboy-Python-Utilities]]

== Tutorials ==
* [[Frogger Getting Started|Frogger]]

What is the Arduboy

2024-06-21T00:27:37Z

Haloopdy: Exclamation not necessary

Arduboy is both a [https://www.arduboy.com/shop device you can buy] and an [https://community.arduboy.com open specification](source needed) for an [https://www.arduino.cc/ Arduino]-powered 8-bit gaming device. Think "open-source modern gameboy".

It comes in various configurations, with the most common being the [[#Arduboy FX|Arduboy FX]](section needed). This configuration gives you a credit-card-sized game system with the ability to store up to 16MiB of programs, called [[Sketches]]. Other configurations (such as the [[#Original|Original]](section needed) and older) didn't come with this extra storage and can only play one game at a time. See [[#Determining Hardware|Determining Hardware]](section needed) to figure out which device you have.

== Arduboy Variants ==

* DevKit
* Kickstarter editions
* Original
* FX
* Mini

Main Page

2024-06-21T00:24:38Z

Haloopdy: /* Getting started */ - add link to quickstart guide

What is the Arduboy

2024-06-21T00:18:22Z

Haloopdy: Small explanation and framework of possible sections

Arduboy is both a [https://www.arduboy.com/shop device you can buy] and an [https://community.arduboy.com open specification](source needed) for an [https://www.arduino.cc/ Arduino]-powered 8-bit gaming device. Think of an open-source modern gameboy!

It comes in various configurations, with the most common being the [[#Arduboy FX|Arduboy FX]](section needed). This configuration gives you a credit-card-sized game system with the ability to store up to 16MiB of programs, called [[Sketches]]. Other configurations (such as the [[#Original|Original]](section needed) and older) didn't come with this extra storage and can only play one game at a time. See [[#Determining Hardware|Determining Hardware]](section needed) to figure out which device you have.

== Arduboy Variants ==

* DevKit
* Kickstarter editions
* Original
* FX
* Mini

Main Page

2024-06-20T23:56:14Z

Haloopdy: Add small community section

== Getting started ==

* [[What is the Arduboy|What is the Arduboy?]]
** [[What is the Arduboy#Arduboy Variants|Arduboy Variants]]
* [[Installing Games]]
* [[Developing Games]]

== Community ==

Come chat with the community and show off your games at https://community.arduboy.com/! The bulk of the Arduboy community exists on the forums; there isn't an official Discord/etc.

* '''Main Arduboy website:''' https://www.arduboy.com/
* '''Community website:''' https://community.arduboy.com/

== Tools ==
* [[Arduboy Toolset]]
* [[Cart Builder]]
* [[Arduboy-Python-Utilities]]

== Tutorials ==
* [[Frogger Getting Started|Frogger]]