QuickerNES, a modern version of quickNES
Go to file
Sergio Martin 131aa5bb97 Simplications in source, removing no longer needed files and simplifying tests 2024-01-19 17:03:47 +01:00
extern Simplications in source, removing no longer needed files and simplifying tests 2024-01-19 17:03:47 +01:00
overlay Adding tests and moving code around 2024-01-10 19:48:57 +01:00
source Simplications in source, removing no longer needed files and simplifying tests 2024-01-19 17:03:47 +01:00
tests Simplications in source, removing no longer needed files and simplifying tests 2024-01-19 17:03:47 +01:00
.gitignore Adding third party tools, meson scripts, starting with the player 2024-01-09 20:12:22 +01:00
.gitmodules Creating emulator interface class to mix both versions. This will be useful for verification purposes. Also fixed mapper070 for quicknes 2024-01-15 20:56:58 +01:00
LICENSE Adding initial version 2024-01-08 20:11:49 +01:00
README.md Created new functions for serialization and deserialization 2024-01-18 19:56:30 +01:00
meson.build Fixed stack overflow issue 2024-01-17 06:59:10 +01:00
meson_options.txt Making player optional, tests obligatory 2024-01-16 22:43:03 +01:00

README.md

quickerNES

quickerNES is an attempt to modernizing and improving the performance of quickNES. The goals for this project are, in order of importance:

  • Improve overall emulation performance for modern (x86) CPUs
  • Modernize the code base with best programming practices, including CI tests, benchmarks, and coverage analysis
  • Add support for more mappers, controllers, and features supported by other emulators
  • Improve accuracy, if possible

The main aim is to improve the performance of headless re-recording for TASing and botting (See: JaffarPlus) purposes. However, if this work can help regular play emulation, then much better.

Changes

  • Optimizations made in the CPU emulation core, including:
    • Forced alignment at the start of a page to prevent crossing cache line boundaries
    • Simplifying the 6502 CPU instruction fetching and decoding
  • Minimize compiled code size to reduce pressure on L1i cache
  • Reduce heap allocations
  • General code reorganization (make it header only to help compiler optimizations)

Credits

  • quickNES was originally by Shay Green (a.k.a. Blaarg) under the GNU GPLv2 license. The source code is still located here
  • The code was later improved and maintained by Christopher Snowhill (a.k.a. kode54)
  • I could trace further contributions (e.g., new mappers) by retrowertz, CaH4e3, some adaptations from the FCEUX emulator (see mapper021)
  • The latest version of the code is maintained by Libretro's community here
  • For the interactive player, this project drew some code from HeadlessQuickNES (HQN) by Drew (Binder News)
  • We use some of the NES test rom set made by multiple authors and gathered by Christopher Pow et al.
  • We also use some movies from the TASVideos website for testing. These movies are copied into this repository with authorization under the Creative Commons Attribution 2.0 license.

All base code for this project was found under open source licenses, which I preserved in their corresponding files/folders. Any non-credited work is unintentional and shall be immediately rectfied.