~groovestomp/gsnes

ref: 9de07668b1fbbdc9470247b82ffbe5e2d80330d8 gsnes/README.md -rw-r--r-- 1.7 KiB
9de07668 — GrooveStomp Foreground rendering works 1 year, 5 months ago

#GrooveStomp's NES Emulator

AGPLv3 license OLC-3 license

This NES emulator is based heavily off of the work done by OneLoneCoder ie., javidx9. I have written this emulator in C11 instead of the source C++17 used by javidx9.

#License

While this software is licensed under AGPLv3, this software also retains the original license provided by OneLoneCoder. Note that AGPLv3 is a much more strict license than the OLC-3 license used by javidx9.

#Development

#Requirements

  • make
  • gcc
  • sdl2
  • doxygen (For documentation generation)

This is developed for Linux and no effort has been made to support it elsewhere.

#Building

There are four targets in the Makefile:

  • clean
  • debug
  • release
  • docs

The default target is release. release builds gsnes at release/gsnes. debug builds gsnes at debug/gsnes. docs builds the documentation with Doxygen.

#Using

For now the emulator is not configurable outside of modifying source directly. The NES rom to load is hardcoded into main.c.

#Input

  • a: Select
  • s: Start
  • z: B
  • x: A
  • left: Left
  • right: Right
  • up: Up
  • down: Down

#Screenshots

NES Test Donkey Kong Ice Climber