Skip to content

Commit

Permalink
added example images to the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
marcrobledo committed Apr 8, 2024
1 parent 969eaad commit 2534fa8
Show file tree
Hide file tree
Showing 10 changed files with 10 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
Super Game Boy Border Injector
==============================

This project contains code designed to inject a custom Super Game Boy Border into any Game Boy ROM in the most possible user-friendly way.
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

[![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)](hhttps://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/)



## Web implementation
Expand All @@ -31,4 +35,4 @@ Thanks to [xenophile](https://github.com/xenophile127), [Imanol Barriuso](https:
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.
5. If there were no errors, a ROM `roms/output.gb` will be created.
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
; Super Game Boy border injector for Kid Dracula
; by Marc Robledo 2024
;
; For use with SGB Border Injector (ASM implementation), replace settings.asm
; file with this one.
; More info at https://github.com/marcrobledo/super-game-boy-border-injector
; ------------------------------------------------------------------------------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
; Super Game Boy border injector for Zelda Link's Awakening (non-DX)
; by Marc Robledo 2024
;
; For use with SGB Border Injector (ASM implementation), replace settings.asm
; file with this one.
; More info at https://github.com/marcrobledo/super-game-boy-border-injector
; ------------------------------------------------------------------------------

Expand Down
Binary file added examples/kid_dracula.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed examples/kid_dracula/sgb_border.png
Binary file not shown.
Binary file removed examples/kid_dracula/sgb_border_map.bin
Binary file not shown.
Binary file removed examples/kid_dracula/sgb_border_palettes.bin
Binary file not shown.
Binary file removed examples/kid_dracula/sgb_border_tiles.bin
Binary file not shown.
Binary file added examples/metroid_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added examples/wink.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2534fa8

Please sign in to comment.