A nearly complete NES emulator in a single 750-line C++ source file
Go to file
Anthony Wang e04fab8004
Update README.md
2020-06-06 12:55:15 -05:00
.gitignore Update .gitignore 2020-05-20 21:29:10 -05:00
LICENSE Create LICENSE 2020-05-17 21:01:10 -05:00
README.md Update README.md 2020-06-06 12:55:15 -05:00
main.cpp Savestate update 2 2020-05-19 15:02:32 -05:00

  ____            _ _   _ ______  _____ 
 |  _ \          | | \ | |  ____|/ ____|
 | |_) | __ _  __| |  \| | |__  | (___  
 |  _ < / _` |/ _` | . ` |  __|  \___ \ 
 | |_) | (_| | (_| | |\  | |____ ____) |
 |____/ \__,_|\__,_|_| \_|______|_____/ 
                                EMULATOR

A nearly complete NES emulator in a single 750-line C++ source file, based on LaiNES.

cloc main.cpp
       1 text file.
       1 unique file.                              
       0 files ignored.

github.com/AlDanial/cloc v 1.74  T=0.03 s (33.6 files/s, 27684.4 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
C++                              1              6             60            757
-------------------------------------------------------------------------------

Features

  • Cycle accurate
  • Savestates (Beta, expect bugs!)
  • Supports Mappers 0, 1, 2, 3, 4, and 7
  • Extremely minimal: only 750 lines in one source file with no dependencies

Usage

First, head over to the release tab and grab a release. Releases marked as beta may be unstable!

If a release doesn't work, you can also build it yourself, as described below.

*nix systems

./badnes [path to ROM]

Windows

Drag ROM over badnes.exe

Alternatively, use

badnes.exe [path to ROM]

Controls

        UP  -  UP
      DOWN  -  DOWN
      LEFT  -  LEFT
     RIGHT  -  RIGHT
         A  -  A
         B  -  S
     START  -  ENTER
    SELECT  -  SPACE
SAVE STATE  -  Q
LOAD STATE  -  W

Compatibility

BadNES implements the most common mappers, which should be enough for a good percentage of the games:

  • NROM (Mapper 000)
  • MMC1 / SxROM (Mapper 001)
  • UxROM (Mapper 002)
  • CNROM (Mapper 003)
  • MMC3, MMC6 / TxROM (Mapper 004)
  • AxROM (Mapper 007) (Beta, expect bugs!)

You can check the compatibility for each ROM in the following list: http://tuxnes.sourceforge.net/nesmapper.txt

Building

Requirements

  • C++11
  • SDL2

*nix systems

git clone --recursive https://github.com/Ta180m/BadNES && cd BadNES
g++ main.cpp -o badnes -std=c++11 -lSDL2main -lSDL2 -O3

Windows

git clone --recursive https://github.com/Ta180m/BadNES && cd BadNES
g++ main.cpp -o badnes -std=c++11 -IC:\mingw\include\SDL2 -LC:\mingw\lib -w -Wl,-subsystem,windows -lmingw32 -lSDL2main -lSDL2 -O3

FAQ

Why the name?

http://www.usaco.org/index.php?page=viewproblem2&cpid=1041

Why did you do this?

I really like LaiNES: it's very minimal and compact — but it has several dependencies, so I try to write the shortest NES emulator possible, in a single source file.

There's no sound!

I'm working on it right now. You can also check out the sound branch, although it's still in a very early stage right now.

What do you mean by "nearly complete"?

I'll say it's complete once I finish implementing the APU.

This game doesn't work!

Check to make sure BadNES implements its mapper.

Mapper 7 / Savestates / etc. doesn't work!

Those features are still in beta right now so expect bugs.

Credits

Special thanks to Andrea Orru for creating LaiNES, the emulator that this project derives much of its code from.