~groovestomp/gsnes

ref: d307e0dd788d55eaf8a981010796fba53230983f gsnes/README.md -rw-r--r-- 1.6 KiB
d307e0dd — GrooveStomp Fix executable naming 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 gstxt at release/gsnes. debug builds gstxt 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.

#Screenshots

NES Test Donkey Kong Ice Climber