eried/arduboycollection

Collection of Arduboy compiled games, demos and applications. Fork the repo and add your own games via Pull requests.

Erwin's Arduboy Collection

You can browse this repo here: http://arduboy.ried.cl

Json file for the repository: http://arduboy.ried.cl/repo.json

Play games

Windows

1. Install Arduboy Uploader

2. Browse this repository using http://arduboy.ried.cl, if you clicked yes to the arduboy: protocol association when installing Arduboy Uploader, you can click "Upload to my Arduboy", otherwise just download the games and open Arduboy Uploader manually

Also, check out alternatives for this platform.

Android

1. Install Arby Utility

2. Click "Upload to my Arduboy" in http://arduboy.ried.cl and follow Arduboy Utility steps in your phone

Also, check out alternatives for this platform.

Submit your game

1. Fork this repo (If you do not get what this step means, stop and follow this steps) and also Star this repo
2. Create a new unique folder (case insensitive) for your game under an existent category folder (i.e. Arcade, RPG, etc)
3. Inside your folder, place:

Filename	Description
anything.hex	Your compiled game for the Arduboy (check below for more details)
anything.png	Banner image / screenshot of the game
anything.url	Game details URL (using the typical browser format for bookmark files, check below)
game.ini	Information of the game (check below for format details)
source.url	(Optional) Contains the URL of the source code of the game

4. Sync your fork and Create a Pull request

game.ini format

title=Game name
date=yyyy-MM-ddTHH:mm:ssZ
author=Author
description=Description of the game
license=Identifier of the license used in the game

Instead of typing the date and time for the date variable, you can use: https://www.utctime.net/

For the license variable, you need to use one of the identifiers defined here: https://spdx.org/licenses/

You can also add the following entry to reference a remote file. If you are linking to github, make sure it is the "Raw" version of the url and not the github details for the file. You can include extra files, but they wont appear anywhere and your Pull Request may not be accepted if the commit is too messy.

hex=http://url.to/your/own/server-with-the/game.hex

This file is parsed by php's parse-ini-file function, try to avoid trailing spaces.

.url format

TIP: You can drag from the left side of your browser's address bar to a folder to get the .url file of the current webpage

[InternetShortcut]
URL=https://url.to/the/website

A webhook updates the repository static json file after a commit automatically.

Get your game.hex file

1. Open your code in Arduino IDE
2. Click Sketch / Export compiled Binary
3. Click Sketch / Show Sketch Folder

WARNING: Do not use the with_bootloader.leonardo.hex file. This file may brick your Arduboy. Arduboy Uploader will protect your Arduboy from this kind of issues, but if you manage to brick your device, check the following instructions

arduboycollection's Issues

Snake?

It would be great if we had a nokia snake style game in this repo! :)

Cheers!

Change to the new auth method in github

https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/

Check why some part of the url gets encoded to %2F on the update

More info in JSON

Hey,

I needed working sourceUrls so I started using an edited version of your JSON file.
There's still a bunch missing, but it's a start. Would you like to merge it back?

https://felipemanga.github.io/ProjectABE/repo-eried.json

Parse '\n' escape code in descriptions

Several descriptions are using \n but these aren't getting parsed and translated into page breaks.

Rather than removing all the \n and replacing them with spaces, perhaps it would be possible to turn them into page breaks?

Otherwise, replacing them with spaces would make sense.

Replace that with a relative url

ArduboyCollection/.admin/public_html/arduboy/run_update.php

Line 204 in 083fdeb

$template = file_get_contents("http://arduboy.ried.cl/template.html");

GPL games must have source code distributed with them

So, I didn't realize this a few days ago when I started this process, but today I was reading about the GPL and came upon this fact:

I downloaded just the binary from the net. If I distribute copies, do I have to get the source and distribute that too?

Yes. The general rule is, if you distribute binaries, you must distribute the complete corresponding source code too. The exception for the case where you received a written offer for source code is quite limited.

https://www.gnu.org/licenses/gpl-faq.html#UnchangedJustBinary

This means that distributing the .hex files as we are may actually violate the terms of the GPL license itself. We have to distribute the source code in the repo for these games as well.

I'm not sure if linking to the source code on a different server is enough. Perhaps we should find this out.

Access-Control-Allow-Origin

Would it be possible to add "Access-Control-Allow-Origin:*" to the repo.json HTTP headers?

Without it, ProjectABE can't access the repo directly and depends on the cors-anywhere service, which isn't meant for production use.

For the hex files, I'm using https://gitcdn.xyz/, which should be OK.

Add TEAM a.r.g. games

I noticed TEAM a.r.g.'s games aren't in the repo. They distribute their games in .arduboy format, which may be why, but they're just glorified ZIP files which contain the .hex within. I've started working on extracting the .hex's and adding them to this repo but wanted to make a note in case I don't get around to doing them all.

http://www.team-arg.org/games.html (Arduboy games have a little gameboy icon)

Include game license on page and allow filtering by license

Hi, thanks for building this nice library!

I'd like to discover only FLOSS games, and it's unfortunate that many Arduboy games don't have a license. This essentially renders them proprietary, even though the source is available.

It would be much easier if I could see which games are FLOSS right on the front page and filter them by this.

I'd be willing to send a PR with the license added to each game if you want to do this.

Is source.url actually being used?

When making an update to Minesweeper I looked on the main website to see where source.url is being used and it seems that it isn't being used?

All of 'download hex', 'play in emulator' and 'upload to my arduboy' use the hex uploaded to the repo.
The url provided in source.url doesn't appear to be used at all?

Add the number of registered games to the main page

I recently made a comment on the Arduboy forums and it got me thinking.
It would be nice if the main page displayed how many games there are in the repo.

Use poster for video banner before it loads

I noticed there's an unused banner.jpg which would serve this purpose. Basically as the video is loading, it would show the image behind the unloaded video instead of a gray background.

See here: https://www.w3schools.com/TAgs/att_video_poster.asp