Arduboy Game Format
The Arduboy community has been working very hard on a unified .arduboy file format that will make it as easy as possible for users to upload a game/app and provide extra info about that game/app.
The .arduboy file
An .arduboy file typically has the follow items included, where the bold ones are required. These files are zipped and the extension .zip has been renamed to .arduboy If you create one yourself, some OS might complain, when you’re trying to change the extension of a file, but in this case you can safely ignore that warning.
- one or more binaries
- one banner image (700px × 192px)
- one or more screenshots (128px × 64px)
- one LICENSE.txt
While it is not required to add screenshots or a banner, it does add to the game. Creating a screenshot shouldn’t be to hard, creating a nice banner isn’t always that easy. Because we want to help people, we will provide templates, people can use freely: https://github.com/TEAMarg/arduboy-file-format/tree/master/templateBanners
The info.json file
The json schema is used for including the extra meta-data. Again, not all fields are required, but the ones bellow are:
Following the link bellow, you will see a schema containing metadata with instructions on how to create an actual info.json file.
If you would like to see an actual example of such a info.json file, you can by following/saving (right mouse button “save as”) this link:
The LICENSE.txt file
Depending on the license, you might need to include the license itself. Here you have a link to the MIT license text: https://opensource.org/licenses/MIT Make sure you have the file name in capitals, followed by the .txt in lowercase.
Create online an info.json file
Using Jeremy Dorn his JSON editor, we are providing a form where you can fill out all fields and it will create a correct json schema, you then can copy paste in your own info.json file. Because of the nature of the link, I had to shrink the link with TinyURL.
If you feel uncomfortable following a shortened link, you can see the URL here, before actually proceeding to it:
Loaders for .arduboy files
- Arduboy Manager by @crait
- Team A.R.G. Game Loader by Team A.R.G. members @delegatevoid and @JO3RI
- Arduboy Mate by @mockfrog
Discuss this topic
If you would like to talk about this Guide, you can do so in your own topic OR go to this one: