Skip to content

Commit

Permalink
fixed credits in README
Browse files Browse the repository at this point in the history
  • Loading branch information
marcrobledo committed Apr 8, 2024
1 parent b0db5bc commit 111f8f7
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,22 @@
Super Game Boy Border Injector
==============================
# 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

<div style="align=center">
[![SGB border for Wink & the Broken Robot (homebrew)](https://github.com/marcrobledo/super-game-boy-border-injector/blob/main/examples/wink.png?raw=true)](https://maxoakland.itch.io/wink-gameboy)
[![SGB border for Kid Dracula (hack)](https://github.com/marcrobledo/super-game-boy-border-injector/blob/main/examples/kid_dracula.png?raw=true)](https://www.romhacking.net/hacks/8524/)
[![SGB border for Metroid II: Return of Samus](https://github.com/marcrobledo/super-game-boy-border-injector/blob/main/examples/metroid_2.png?raw=true)](https://www.romhacking.net/hacks/8548/)
</div>
<div style="align=center; font-size:80%; font-style:italic">
(examples: [Wink & the Broken Robot (homebrew)](https://maxoakland.itch.io/wink-gameboy) by [Max Oakland](https://twitter.com/WinkWinkerson),

<small>(examples: [Wink & the Broken Robot (homebrew)](https://maxoakland.itch.io/wink-gameboy) by [Max Oakland](https://twitter.com/WinkWinkerson),
[Kid Dracula](https://www.romhacking.net/hacks/8524/) (hack) by [Kensuyjin_33](https://twitter.com/Kensuyjin_33/) &amp;
[Metroid II: Return of Samus](https://www.romhacking.net/hacks/8548/) by [Ryallasha N'vetay](https://twitter.com/Ryallasha))
</div>
[Metroid II: Return of Samus](https://www.romhacking.net/hacks/8548/) by [Ryallasha N'vetay](https://twitter.com/Ryallasha))</small>

## Web implementation

This is probably what everyone is looking for: a simple [web app](https://www.marcrobledo.com/super-game-boy-border-injector/) 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.
Expand All @@ -27,17 +25,17 @@ You might probably need [Super Game Boy Border Converter](https://github.com/mar

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



## ASM implementation

This [RGBDS](https://github.com/gbdev/rgbds) skeleton project allows you to inject a custom Super Game Boy Border to any Game Boy ROM.

Thanks to [xenophile](https://github.com/xenophile127), [Imanol Barriuso](https://github.com/imanolea) and [nitro2k01](https://github.com/nitro2k01) for their help!

### How to compile

1. Get [RGBDS](https://rgbds.gbdev.io/install) 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/`.
3. Read `src/settings.asm` carefully and edit it, filling all needed offsets and constants for your game.
4. Compile with `assemble.bat` (Windows) or `assemble.sh` (Unix).
5. If there were no errors, a ROM `roms/output.gb` will be created.
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.

0 comments on commit 111f8f7

Please sign in to comment.