awesomenes's Introduction

🎮 awesomenes

A NES emulator written in Go.

Getting and running

awesomenes uses sdl2 for rendering and input processing. It may be necessary to install it beforehand. On macOS, using homebrew:

$ brew install sdl2

Other systems/package managers should provide similar sdl2/libsdl2 packages. Then use the go get:

$ go get github.com/rbaron/awesomenes
$ awesomenes MY_ROM.nes

Status

Games that use the mapper 0 (NROM) mostly work, although without audio so far. Games that use mapper 4 (mmc3) should work with some eventual glitches.

Tested games:

Donkey Kong (NROM)
Super Mario Bros. (NROM)
Super Mario Bros. 2 (mmc3)
Super Mario Bros. 3 (mmc3, with some glitches)

Controller inputs

Keyboard (controller 1)

Arrow keys  -> NES arrows
A           -> NES A
S           -> NES B
Enter       -> NES start
Right shift -> NES select

Nintendo Switch Joycon (controller 1)

Directional -> NES arrows
Down arrow  -> NES A
Right arrow -> NES B
SL          -> NES select
SR          -> NES start

Roadmap

✅ CPU emulation

✅ Video support (picture processing unit - PPU)

✅ Keyboard input

✅ Mapper 0

✅ Joystick input (tested with Nintendo Switch Joycon)

✅ Mapper 4 (...kinda)

➖ More mappers

➖ Save state

➖ Audio support (audio processing unit - APU)

Resources

All the information used to build this emulator was found on the awesome nesdev wiki.

awesomenes's People

Contributors

Stargazers

Watchers

awesomenes's Issues

Can't install (No package 'sdl2' found)

Tried to go get it with Go 1.10:

$ go get github.com/rbaron/awesomenes
# pkg-config --cflags sdl2
Package sdl2 was not found in the pkg-config search path.
Perhaps you should add the directory containing `sdl2.pc'
to the PKG_CONFIG_PATH environment variable
No package 'sdl2' found
pkg-config: exit status 1

Any idea?

BTW, awesome job, really would love to use it :)

Great job!

I'm not a Lobster's member :( Github needs to allow comments. I've written a NES emulator (http://github.com/dbousamra/hnes), so I know how tricky the NES is. I found your code really clean, and easy to understand. Nice work!

Recommend Projects