marcrobledo / super-game-boy-border-injector

Injects a custom Super Game Boy Border into any Game Boy ROM in the most possible user-friendly way!

Super Game Boy Border Injector

This project contains allows to inject a custom Super Game Boy Border into (almost) any Game Boy ROM in the most possible user-friendly way.

It comes in two different implementations:

• Web implementation
• ASM implementation

Some amazing examples made with SGB Border Injector:

• Wink & the Broken Robot (homebrew) by Max Oakland
• Kid Dracula (hack) by Kensuyjin_33
• Metroid II: Return of Samus (hack) by Ryallasha N'vetay

Web implementation

This is probably what everyone is looking for: a simple web app that does the magic for you!

Just select your desired ROM and Super Game Boy border data and the app will build the SGB compatible ROM with your border and even custom palette.

You might probably need Super Game Boy Border Converter, which will convert any image to the needed data the injector asks for.

This web injector just automatizes the process of injecting the assembled code from the ASM implementation below.

ASM implementation

This RGBDS skeleton project allows you to inject a custom Super Game Boy Border to any Game Boy ROM.

Thanks to xenophile, Imanol Barriuso and nitro2k01 for their help!

How to compile

1. Get RGBDS and unzip it at rgbds folder.
2. Place the game you are going to patch as roms/input.gb file.
3. Place sgb_map.bin, sgb_tiles.bin and sgb_palettes.bin in src/.
4. Read src/settings.asm carefully and edit it, filling all needed offsets and constants for your game.
5. Compile with assemble.bat (Windows) or assemble.sh (Unix).
6. If there were no errors, a ROM roms/output.gb will be created.

super-game-boy-border-injector's Issues

Incompatible ROM: Bank 0 has no free space error

This ROMs give the error:

Batman - The Animated Series (USA, Europe)
Castlevania II - Belmont's Revenge (USA, Europe)
Donkey Kong Land (USA, Europe) (SGB Enhanced)
Donkey Kong Land III (USA, Europe) (Rev 1) (SGB Enhanced)
Pokemon - Red Version (USA, Europe) (SGB Enhanced)
Pokemon - Blue Version (USA, Europe) (SGB Enhanced)
Super Mario Land 2 - 6 Golden Coins (USA, Europe) (Rev 2)
Wario Land - Super Mario Land 3 (World)

Incompatible ROM

Mega Man Xtreme (USA, Europe); El nuevo borde funciona bien, pero la paleta por defecto del juego sigue predominando.

Money Idol Exchanger (Japan) y Pocket Puyo Puyo Sun (Japan): Los bordes nuevos sólo aparecen antes de que el juego arranque, luego son reemplazados por los originales. En el caso del juego de Puyo Puyo se puede ver la paleta nueva, en Money Idol es posible que no funcione por tener múltiples paletas y más de alguna compartiendo pantalla.

Incompatible ROM: GAMES_WITH_JUNK is not defined

Wario Land - Super Mario Land 3 (World) lanza este error.

Game Boy Camera compatibility

Hi, thank you once again for offering this wonderful way of customizing our Game Boy games, and I'd love to be able to do it with the Game Boy Camera rom, which already incorporates an overlay that is, how shall I say ... Awfully ugly :D

Thank you in advance, and no pressure, you do it when you have the time ;) (signed: a Frenchman admiring your work :) )

Opaque game window in real hardware

Hello, first I want to say that I tested with a rom and a border that worked perfectly 1 month ago with your Super GB injector online, and today I have the same problem of "pink square" that appears after the boot screen of the Super Gb.

I tried to inject a border in a homebrew this morning with this rom (mai_nurse_v1.01.gb , download on https://lunoka.itch.io/mai-nurse) and a border created with GIMP (I've created 5 or 6 of them in the past, and they worked perfectly, so there's no need to worry about settings here.) and transformed with your Super GB border converter. When I play the game on a real SNES console, (after flashing the game on a cartridge), the central transparency doesn't appear, and the center remains pink. I tried again with a rom created with Gb injector a few weeks ago, on the same cartridge that I flashed again, and it worked, so no problem with the cartridge or the flash software!

So I thought I'd screwed up the colorimetry of the pink, and that the software wouldn't remove it because it was a different color, except that I used the basic image you provide on the site (the clone of the classic super Gb image), and the same result, the pink square remains (I forgot to specify, you can hear the sound of the background, and you can move around the menus etc. "by ear", so the game runs perfectly under the pink square).

So I tried with another rom to redo the procedure, so I re-used my files (rom + border) from 1 month ago, but same result, pink square remains in the center!
I tried a color other than pink to apply the transparency as allowed by your software, and strangely enough, it's still a pink square that appears after the Super GB boot (I tried green, blue etc. respecting the colorimetry suggested in your software, but it's still a pink square...).

A little short of ideas, I tried to tick the "custom gb palette" box, which I'd never ticked before (I've already done about 5.6 roms with your software, but that was 1 month ago), and now it works ...

In short, I just wanted to warn you. I'll also let you know that I ran the roms that left a pink square on the real SNES on an emulator that manages the Super Gb and it worked! (really incomprehensible!) but I imagine that the aim of the software is still to work on the original hardware...

I can't add the roms and borders via github because it doesn't handle this type of .gb .sgb file, but I tested with all sorts of rom + different borders and always came up with the "pink square" result. I'm posting 2 photos of the "pink square" results anyway. I know it's a shame on a flat screen, but it's all I had to hand!

Thanks again for this superb software, and thanks for reading ;)

Broken ROM: Wave Race

Generated a border to inject into Wave Race, but the game just hangs on load.
Injected the same border into Super Mario Land with no issues.

GBStudio 2 ROMs Incompatible

I know this was possibly expected, but it would be a great feature to add and one that would help me out since I'd love to release my games that aren't compatible with GBStudio 3 with SGB compatibility!

Here's a test ROM if interested: WinkBetaTestROM.gb.zip