Skip to content

Commit

Permalink
README: add project list
Browse files Browse the repository at this point in the history
Additionally made minor changes to wording of SDL2 example usage.
  • Loading branch information
deltabeard authored Sep 27, 2024
1 parent 4596d56 commit 66f7959
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,14 @@ accuracy is important.

## SDL2 Example

An example implementation is given in peanut_sdl.c, which uses SDL2 to draw the
screen and take input. Run `cmake` or `make` in the ./examples/sdl2/ folder to
compile it.
The flagship example implementation is given in peanut_sdl.c, which uses SDL2 to
draw the screen and take input. Run `cmake` or `make` in the ./examples/sdl2/
folder to compile it.

Execute in command line with `peanut-sdl game.gb` which will automatically
create the save file `game.sav` for the game if one isn't found. Or run with
`peanut-sdl game.gb save.sav` to specify a save file. Or even `peanut-sdl` to
create a *drop zone* window that you can drag and drop a ROM file to.
Run `peanut-sdl`, which creates a *drop-zone* window that you can drag and drop
a ROM file into. Alternatively, run in a terminal using `peanut-sdl game.gb`,
which will automatically create the save file `game.sav` for the game if one
isn't found. Or, run with `peanut-sdl game.gb save.sav` to specify a save file.

### Screenshot

Expand Down Expand Up @@ -100,6 +100,15 @@ between 60 FPS and 30 FPS.
Pressing 'b' will dump each frame as a 24-bit bitmap file in the current
folder. See /screencaps/README.md for more information.

## Projects Using Peanut-GB

In no particular order, and a non-exaustive list, the following projects use Peanut-GB.

* [Pico-GB](https://github.com/YouMakeTech/Pico-GB) - Game Boy emulation on the Raspberry Pi RP2040 microcontroller.
* [Peanut_gb-RGFW](https://github.com/ColleagueRiley/Peanut_gb-RGFW) - A Gameboy emulator example for [RGFW](https://github.com/ColleagueRiley/RGFW).
* [CPBoy](https://github.com/diddyholz/CPBoy) - A Game Boy (DMG) emulator for the Classpad II (fx-CP400).
* [PlayGB](https://github.com/risolvipro/PlayGB) - A Game Boy emulator for Playdate, based on Peanut-GB.

## Getting Started

Documentation of function prototypes can be found at the bottom of [peanut_gb.h](peanut_gb.h#L3960).
Expand Down

0 comments on commit 66f7959

Please sign in to comment.