Emulation/pinky
1
0
Fork 0
mirror of https://github.com/koute/pinky.git synced 2024-06-01 02:48:08 -04:00
Code Issues Packages Projects Releases Wiki Activity
An NES emulator written in Rust
17 commits 1 branch 0 tags 1.2 MiB
Rust 65.8%
Assembly 30.2%
Ruby 1.3%
JavaScript 1%
Python 0.8%
Other 0.8%
Go to file
Jan Bujak 4016b60e49 Add a new PPU testsuite based on a transistor level simulation of RP2C02.
2016-10-30 00:16:54 +02:00
emumisc Initial commit 2016-10-23 19:50:32 +02:00
mos6502 Initial commit 2016-10-23 19:50:32 +02:00
nes Add a new PPU testsuite based on a transistor level simulation of RP2C02. 2016-10-30 00:16:54 +02:00
nes-testsuite Do not strictly enforce the frame limit when running test ROMs. 2016-10-29 17:12:48 +02:00
pinky-devui Add env_logger to development UI 2016-10-27 23:15:31 +02:00
pinky-libretro Switch pinky-libretro crate type to cdylib 2016-10-24 20:33:37 +02:00
rp2c02-testsuite Add a new PPU testsuite based on a transistor level simulation of RP2C02. 2016-10-30 00:16:54 +02:00
.gitignore Add a new PPU testsuite based on a transistor level simulation of RP2C02. 2016-10-30 00:16:54 +02:00
.gitmodules Add a new PPU testsuite based on a transistor level simulation of RP2C02. 2016-10-30 00:16:54 +02:00
LICENSE-APACHE.txt Initial commit 2016-10-23 19:50:32 +02:00
LICENSE-MIT.txt Initial commit 2016-10-23 19:50:32 +02:00
README.md Remove libretro-backend remark from the README 2016-10-24 18:31:15 +02:00

README.md

Pinky

Pinky is an NES emulator written in Rust completely from scratch based only on publicly available documentation.

Features

  • Accurate-ish (cycle accurate) 6502, PPU and APU emulation.
  • A testsuite based on test ROMs.
  • Can be compiled as a libretro core.

There are still many things missing, including:

  • Unofficial 6502 instructions support.
  • Mappers other than NROM.
  • Accurate PPU sprite overflow.
  • Savestate support.

Currently this is not a production quality emulator, though it can play NROM games such as Super Mario Brothers or Donkey Kong quite well.

Getting started

Internally this project is split into multiple crates.

The pinky-libretro contains the libretro core of this emulator, which is the intended way to run it. It should be compatible with any libretro frontend, but it was only tested with RetroArch.

After compiling the libretro core you can run it like this with RetroArch:

retroarch -L libpinky_libretro.so your_rom.nes

There's also a simple standalone SDL2-based frontend in the pinky-devui directory; running it is just a matter of passing it a path to your game ROM on the command line.

The nes-testsuite contains an emulator agnostic testsuite of NES roms, which could be easily hooked to any other emulator simply by implementing a single trait (see nes/src/testsuite.rs).

The nes contains the emulator itself. mos6502 has the 6502 interpreter, which could be useful for emulating other 6502-based machines.

There are already hundreds of NES emulators out there; why another?

Because why not? Writing a game console emulator is one of the most fun and rewarding projects out there, and nothing can compare with the feeling of beating one of your favorite games on an emulator you've wrote yourself.

The choice of NES is also an obvious one - it's the easiest console to emulate simply due to the fact that it's extremely well documented.