Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 2.46 KB

README.md

File metadata and controls

74 lines (50 loc) · 2.46 KB

Wolf

Wolf

Wolf is a simple side scrolling platformer where the screen advances automatically and the player must react.

This is a ultra-mega-work-in-progress homebrew platformer for the original Gameboy. It is written entirely in GB Z80 ASM using rgbds for the assembler/linker toolchain.

Beyond simple experimentation Wolf is my first attempt at GB Z80 / Gameboy development. It will probably never be finished and the code is varying degrees of unoptimized hot trash.

Wolf is 10000% not finished!

Development

Building ROM from source

To, build the ROM rgbds must be installed and the rgbasm, rgblink, and rgbfix commands must be in your $PATH.

  1. Run make.
  2. Load wolf.gb into an emulator, or onto a ROM cartridge for use in real hardware.

Development Tools

For development tools wine must be installed and the wine command must be in your $PATH.

By default the Makefile assumes all development tools are kept in the $HOME/wine directory. If you place yours elsewhere be sure to update TOOLS_ROOT in the Makefile.

Godmode

To aid with testing you can also build the ROM with gravity and death disabled:

  1. Run make clean to remove any previous builds.
  2. Run make GODMODE=1 to build with no gravity or death.

Debugging/Emulating

  1. Download BGB and place bgb.exe in $HOME/wine/
  2. Run make debug

Pro-tip: BGB can be configured to automatically break on many conditions that can happen when your code is buggy. Enable all of the possible debugger exceptions that can be found under the bgp control panel under the Exceptions tab:

BGB Exceptions Configuration

For more information see these BGB debugger tips/tricks.

Tile Editing

  1. Download GBTD and place GBTD.EXE in $HOME/wine/gbtd.exe (Note the case change, all caps .exe's are silly...)
  2. Run make tiles

Map Editing

  1. Download GBMD and place GBMD.EXE in $HOME/wine/gbmd.exe (Note the case change, all caps .exe's are silly...)
  2. Run make map