quickerNES/README.md

32 lines
2.2 KiB
Markdown
Raw Normal View History

2024-01-08 19:11:49 +00:00
quickerNES
============
quickerNES is an attempt to modernizing and improving the performance of quickNES, the fastest NES emulator in the interwebs (as far as I know). The goals for this project are, in order of importance:
- Improve overall emulation performance even more
- 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
2024-01-14 05:12:32 +00:00
The main aim is to improve the performance of skip (non-rendering, no-audio) frame advances for brute force botting. (See: [JaffarPlus](https://github.com/SergioMartin86/jaffarPlus)). However, if this work might help with homebrew emulation and other people having more fun, then much better!
Changes
=========
- Optimizations made in the CPU emulation core
- Sound is no longer emulated during skip frames
2024-01-08 19:11:49 +00:00
Credits
=========
2024-01-08 19:19:59 +00:00
- quickNES was originally by Shay Green (a.k.a. [Blaarg](http://www.slack.net/~ant/)) under the GNU GPLv2 license. The source code is still located [here](https://github.com/kode54/QuickNES)
2024-01-08 19:12:49 +00:00
- The code was later improved and maintained by Christopher Snowhill (a.k.a. [kode54](https://kode54.net/))
- I could trace further contributions (e.g., new mappers) by retrowertz, CaH4e3, some adaptations from the [FCEUX emulator](https://github.com/TASEmulators/fceux) (see mapper021)
2024-01-08 19:19:59 +00:00
- The latest version of the code is maintained by Libretro's community [here](https://github.com/libretro/QuickNES_Core)
2024-01-10 18:48:57 +00:00
- For the interactive player, this project uses a modified version of [HeadlessQuickNES (HQN)](https://github.com/Bindernews/HeadlessQuickNes) by Drew (Binder News)
- We use some of the [NES test rom set](https://github.com/christopherpow/nes-test-roms) made by multiple authors and gathered by Christopher Pow et al.
- We also use some movies from the (TASVideos)[tasvideos.org] website for testing. These movies are copied into this repository with authorization under the Creative Commons Attribution 2.0 license.
2024-01-08 19:11:49 +00:00
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.
2024-01-08 19:11:49 +00:00