dbousamra / hnes Goto Github PK

View Code? Open in Web Editor NEW

372.0 10.0 22.0 17.98 MB

:video_game: NES Emulator written in Haskell

License: BSD 3-Clause "New" or "Revised" License

Haskell 53.14% Assembly 46.84% Shell 0.02%

nes haskell emulator

hnes's Introduction

hnes

Welcome to hnes. hnes is a NES emulator written in Haskell.

Screenshots

Mapper support

The following mappers are supported:

NROM (0)
UNROM (2)
AOROM (7)

Lots of games run, but more don't. You can see which roms are compatible here: http://tuxnes.sourceforge.net/nesmapper.txt The best games seem to be MMC3, so that is a priority.

Mappers are basically custom memory modules that exist on the cartridges themselves, that allow referencing more memory than the NES originally shipped with. Sometimes they even do computation. A very clever idea, but a nightmare to emulate, since each mapper has to be emulated as well

Controls

Nintendo	Emulator
Up, Down, Left, Right	Arrow Keys
Start	Enter
Select	Space
A	Z
B	X

Building

Get Stack for building Haskell projects.

Windows instructions:

$ stack exec -- pacman -Sy mingw-w64-x86_64-pkg-config mingw-w64-x86_64-SDL2
$ stack build

OS X instructions:

$ brew install sdl2
$ stack build

Ubuntu Linux instructions:

$ sudo apt-get install libsdl2-dev
$ stack build

FreeBSD instructions:

$ pkg install sdl2
$ stack build

Running

To run:

stack exec -- hnes roms/tests/cpu/nestest/nestest.nes

Task list

Tests

There's a small test suite that is used to check for CPU and PPU accuracy. They use test roms rather than hand coding tests.

Just run stack test:

Known issues.

There are so many, where do I even begin.

Performance is pretty average still. I get around 80 fps on my 2015 i5 MacBook.
VBlank timing is off. I don't know the exact reasons, but it causes scrolling issues.

hnes's People

Contributors

Stargazers

Watchers

Forkers

chrisdone happy-ferret silky frnkbaum rdavison brianwitte ron-wolf bbarker tarsbase ivandsm haskell-game-archives smunix tekneblog hilbert-yaa retrocomp rezbyte lowarn-dsu jonathanjameswatson alexcode-cc

hnes's Issues

Broken submodule

There appears to be a broken submodule at https://github.com/dbousamra/hnes/tree/master/roms/tests. It could be either fixed by adding a .gitmodules file or removed with git rm --cached roms/tests/dump/.

Error compilation WINDOWS 10

Hello I tried to run your emulator on my windows 10 computer

I have an error during the stack build (the old commands were successful)

> stack build
sdl2-2.3.0: configure
sdl2-2.3.0: build
Progress 1/2

--  While building package sdl2-2.3.0 using:
      C:\sr\setup-exe-cache\x86_64-windows\Cabal-simple_Z6RU0evB_2.0.0.2_ghc-8.2.1.exe --builddir=.stack-work\dist\e53504d9 build --ghc-options " -ddump-hi -ddump-to-file -fdiagnostics-color=always"
    Process exited with code: ExitFailure 1
    Logs have been written to: C:\Users\CleaverCode\Desktop\hnes\.stack-work\logs\sdl2-2.3.0.log

    Configuring sdl2-2.3.0...
    Preprocessing library for sdl2-2.3.0..
    In file included from C:/Users/CleaverCode/AppData/Local/Programs/stack/x86_64-windows/msys2-20180531/mingw64/include/SDL2/SDL.h:32:0,
                     from Enum.hsc:910:
    C:/Users/CleaverCode/AppData/Local/Programs/stack/x86_64-windows/msys2-20180531/mingw64/include/SDL2/SDL_main.h:111:17: error: conflicting types for 'SDL_main'
     #define main    SDL_main
                     ^
    C:\Users\CleaverCode\AppData\Local\Temp\stack6704\sdl2-2.3.0\Enum.hsc:912:5: note: in expansion of macro 'main'
    C:/Users/CleaverCode/AppData/Local/Programs/stack/x86_64-windows/msys2-20180531/mingw64/include/SDL2/SDL_main.h:117:39: note: previous declaration of 'SDL_main' was here
     extern C_LINKAGE SDLMAIN_DECLSPEC int SDL_main(int argc, char *argv[]);
                                           ^~~~~~~~
    compiling .stack-work\dist\e53504d9\build\SDL\Raw\Enum_hsc_make.c failed (exit code

Performance

Hey, Any luck with the performance issues?
I see you're using -O2 which is good, but I'm guessing -XStrict hadd little effect?
I think the use of ST is probably good. Using mutable unboxed vectors is probably the fastest choice of data structure unless perhaps you plan on reversing time in your emulator, or exploring different branches of emulation. It's hard to see whats really causing the issue. Maybe use a better tool for visualizing the profiling info, e.g. https://github.com/maoe/tkyprof.