detuNES

Project-Goal

The goal of this project is not to create an emulator for actual use, but rather for me to have fun implementing it and learning something along the way.

Features that WILL be implemented:

• passing certain test-ROMs
• running some games and outputting the graphics
• common mappers: NROM, MMC1, MMC3
• configurable input, supporting keyboard and gamepads (Windows and Linux, DirectInput and XInput, thanks to Jamepad)

Features that MIGHT be implemented:

• accurate timing
• fancy upscaling (xBRZ?)
• other mappers: UNROM, CNROM, ?

Features that WON'T be implemented:

• audio output (APU will only be implemented as far as necessary, but no actual output)
• persistency (neither save-states nor memory-snapshots)

Prerequisites

• Java 8+ (unless you're just executing the tests, you must stick to Java 8, because Darcula causes problems with Java 9+, see bulenkov/Darcula#41)
• Gradle 5.3 or later

Import into IntelliJ IDEA

• Open the Gradle project
• Enable "Use auto-import"
• Select "Use local gradle distribution"

Usage

These tasks can be saved in IntelliJ IDEA for easy access.

• Build JAR (executable):
  gradle clean shadowJar

• Run from Gradle:
  gradle run -PappArgs="['path/to/rom.nes']"

• Run from console:
  java -Xmx2g -jar build/libs/detuNES-0.1.0-all.jar path/to/rom.nes

• Run tests from Gradle:
  gradle cleanTest test

  This is not shown correctly in IDEA, see this issue. A workaround is to use a IDEA-JUnit task directly:

  • Create a new JUnit task
  • Set "Test kind" to "All in package" and "Search for tests" to "In whole project"
  • Add the Gradle task "prepareTest" to "Before launch"
  • To generate the JaCoCo report, you'll have to run gradle jacocoTestReport manually