Qt-based Nintendo Entertainment System emulator and NSF/NSF2/NSFe Music Player
:floppy_disk: Work in Progress (WIP) Builds 
These executables are always updated to the latest commit:
- Linux AppImage : :link:
x86_64 - Windows 32 bit : :link:
OpenGL- :link:D3D9 - Windows 64 bit : :link:
OpenGL- :link:D3D9
Notes:
- WARNING save states of version 0.110 or earlier are no longer compatible.
- Due to the many changes I'm making to the core of the emulator, new bugs may have been introduced, if you find that the roms no longer work properly compared to version 0.110, please let me know.
- 32 bit versions are Windows XP compatible.
:beer: Support
If you want buy me a beer :
Multilingual Support
A big thank you to everyone who contributed to the translations:
- Arabic
- Chinese
- English
- French
- German
- Hungarian
- Italian
- Polish
- Portuguese
- Russian
- Spanish
- Turkish
Help with Translations here
:camera: Screenshots
:keyboard: Configuration
To run in portable mode there is 3 distinct ways:
- If the executable is in a folder containing the puNES.cfg file.
- Rename the executable by adding the suffix
_p.- Examples:
punes.exe -> punes_p.exeorpunes64.exe -> punes64_p.exe
- Examples:
- Run the emulator with the "--portable" option.
To see a list of available command-line options, start puNES with the -h argument.
:electric_plug: Supported Mappers
| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 |
|---|---|---|---|---|---|---|---|---|---|---|
| 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 |
| 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 |
| 33 | 34 | 35 | 36 | 37 | 38 | 40 | 41 | 42 | 43 | |
| 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | |
| 55 | 56 | 57 | 58 | 59 | 60 | 61 | 62 | 63 | 64 | 65 |
| 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 |
| 77 | 78 | 79 | 80 | 81 | 82 | 83 | 85 | 86 | 87 | |
| 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | |
| 99 | 100 | 101 | 103 | 104 | 105 | 106 | 107 | 108 | ||
| 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | |
| 121 | 122 | 123 | 125 | 126 | ||||||
| 132 | 133 | 134 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | |
| 143 | 144 | 145 | 146 | 147 | 148 | 149 | 150 | 151 | 152 | 153 |
| 154 | 155 | 156 | 157 | 158 | 159 | 162 | 163 | 164 | ||
| 165 | 166 | 167 | 168 | 170 | 171 | 172 | 173 | 175 | ||
| 176 | 177 | 178 | 179 | 180 | 182 | 183 | 184 | 185 | 186 | |
| 187 | 188 | 189 | 190 | 191 | 192 | 193 | 194 | 195 | 196 | 197 |
| 198 | 199 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 |
| 209 | 210 | 211 | 212 | 213 | 214 | 215 | 216 | 217 | 218 | 219 |
| 221 | 222 | 224 | 225 | 226 | 227 | 228 | 229 | 230 | ||
| 231 | 232 | 233 | 234 | 235 | 236 | 237 | 238 | 240 | 241 | |
| 242 | 243 | 244 | 245 | 246 | 248 | 249 | 250 | 252 | ||
| 253 | 254 | 255 | 256 | 258 | 259 | 260 | 261 | 262 | 263 | |
| 264 | 265 | 266 | 267 | 268 | 269 | 271 | 272 | 274 | ||
| 281 | 282 | 283 | 284 | 285 | ||||||
| 286 | 287 | 288 | 289 | 290 | 291 | 292 | 295 | |||
| 297 | 298 | 299 | 300 | 301 | 302 | 303 | 304 | 305 | 306 | 307 |
| 308 | 309 | 311 | 312 | 313 | 314 | 315 | ||||
| 319 | 320 | 322 | 323 | 324 | 325 | 327 | 328 | 329 | ||
| 331 | 332 | 333 | 334 | 335 | 336 | 337 | 338 | 339 | 340 | |
| 341 | 342 | 343 | 344 | 345 | 346 | 347 | 348 | 349 | 350 | 351 |
| 352 | 353 | 354 | 355 | 356 | 357 | 358 | 359 | 360 | 361 | 362 |
| 366 | 368 | 369 | 370 | 372 | ||||||
| 374 | 375 | 377 | 380 | 381 | 382 | 384 | ||||
| 386 | 387 | 388 | 389 | 390 | 393 | 394 | 395 | |||
| 396 | 397 | 398 | 399 | 400 | 401 | 403 | 404 | 406 | ||
| 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | ||
| 420 | 421 | 422 | 428 | |||||||
| 429 | 431 | 432 | 433 | 434 | 436 | 437 | 438 | |||
| 442 | 446 | 447 | ||||||||
| 451 | 452 | 455 | 456 | 457 | ||||||
| 471 | ||||||||||
| 512 | 513 | 516 | ||||||||
| 517 | 518 | 519 | 521 | 522 | 524 | 525 | 526 | 527 | ||
| 528 | 529 | 530 | 532 | 534 | 536 | 537 | 538 | |||
| 539 | 540 | 541 | 543 | 547 | ||||||
| 550 | 551 | 552 | 554 | 555 | 556 | 557 | 558 | 559 | 560 | |
| 561 | 562 |
:electric_plug: UNIF boards
- 3D-BLOCK
- 8-IN-1
- 10-24-C-A1
- 12-IN-1
- 13in1JY110
- 42in1ResetSwitch
- 64in1NoRepeat
- 70in1
- 70in1B
- 150in1A
- 158B
- 190in1
- 212-HONG-KONG
- 603-5052
- 8157
- 8237
- 8237A
- 11160
- 22026
- 22211
- 43272
- 60311C
- 80013-B
- 82112C
- 411120-C
- 810544-C-A1
- 820561C
- 830118C
- 830134C
- 830425C-4391T
- 830752C
- 831128C
- 891227
- 900218
- A60AS
- A65AS
- AC08
- AMROM
- ANROM
- AOROM
- AX5705
- AX-40G
- BB
- BJ-56
- BOY
- BS-5
- BS-400R
- BS-4040R
- CC-21
- CHINA_ER_SAN2
- CITYFIGHT
- CNROM
- COOLBOY
- COOLGIRL
- CTC-09
- CTC-12IN1
- D1038
- DANCE
- DANCE2000
- DRAGONFIGHTER
- DREAMTECH01
- DRIPGAME
- EDU2000
- EH8813A
- F-15
- FARID_SLROM_8-IN-1
- FARID_UNROM_8-IN-1
- FC-28-5027
- FK23C
- FK23CA
- FS304
- G-146
- Ghostbusters63in1
- GKCXIN1
- GN-26
- GS-2004
- GS-2013
- H2288
- HP898F
- HP2018-A
- HPXX
- JC-016-2
- K-3006
- K-3010
- K-3033
- K-3036
- K-3046
- K-3071
- K-3088
- KOF97
- KONAMI-QTAI
- KS106C
- KS7012
- KS7013B
- KS7016
- KS7017
- KS7021A
- KS7030
- KS7031
- KS7032
- KS7037
- KS7057
- L6IN1
- LH09
- LH10
- LH32
- LH51
- M2C52A
- MALISB
- MARIO1-MALEE2
- MINDKIDS
- N49C-300
- N625092
- NEWSTAR-GRM070-8IN1
- NovelDiamond9999999in1
- NROM
- NROM-128
- NROM-256
- NTBROM
- NTD-03
- OneBus
- RESET-TXROM
- RESETNROM-XIN1
- RT-01
- S-2009
- SA005-A
- SA-0036
- SA-0037
- SA-016-1M
- SA-9602B
- SA-72007
- SA-72008
- SA-NROM
- Sachen-74LS374N
- Sachen-8259A
- Sachen-8259B
- Sachen-8259C
- Sachen-8259D
- SB-5013
- SC-127
- SHERO
- SL1632
- SLROM
- SMB2J
- STREETFIGTER-GAME4IN1
- Super24in1SC03
- SuperHIK8in1
- Supervision16in1
- T3H53
- T4A54A
- T-230
- T-262
- TBROM
- TC-U01-1.5M
- TEK90
- TF1201
- TFROM
- TH2131-1
- TJ-03
- TKROM
- TLROM
- Transformer
- UNROM
- UOROM
- VRC7
- WAIXING-FS005
- WAIXING-FW01
- WS
- YOKO
:information_source: How to Compile
CMake Options
| CMake Option | Description | Default |
|---|---|---|
| ENABLE_RELEASE | Build release version | ON |
| ENABLE_FFMPEG | Enable FFMPEG support | ON |
| ENABLE_OPENGL | Use OpenGL support instead of Direct3D 9 (only for Windows) | ON |
| ENABLE_OPENGL_CG | Enable OpenGL nVidia Cg Toolkit support | OFF |
| ENABLE_FULLSCREEN_RESFREQ | Enable Fullscreen resolution and auto frequency | ON |
| ENABLE_QT6_LIBS | Enable support for QT6 libraries | OFF |
| DISABLE_PORTABLE_MODE | Disable portable mode handling (useful with sandbox environments like Flatpak) |
OFF |
:penguin: Linux
Expand
#### Dependencies - [CMake >= 3.14](https://cmake.org) ([Ninja](https://ninja-build.org) build system is optional) - [Qt5](https://www.qt.io) or [Qt6](https://www.qt.io) with OpenGL support (qtcore, qtgui, qtwidgets, qtnetwork, qtsvg and qttools) - [nvidia-cg](https://developer.nvidia.com/cg-toolkit) - [alsa](https://www.alsa-project.org) - libudev - [libX11 and libXrandr](https://www.x.org) - [p7zip](https://github.com/p7zip-project/p7zip) for compressed file support (lib7zip uses the 7z.so library on unix-like systems) - (optional) [ffmpeg libraries >= 4.0](https://ffmpeg.org) if you want video and audio recording support (libavcodec, libavformat, libavutil, libswresample and libswscale). See [notes](#movie_camera-ffmpeg). #### Compilation of puNES ```bash git clone https://github.com/punesemu/puNES cd puNES cmake -B build -G Ninja -DENABLE_FFMPEG:BOOL=ON -DENABLE_OPENGL_CG:BOOL=ON cmake --build build -j2 ``` if you don't want to use the Ninja build system and prefer the classic Makefile: ```bash cmake -B build -DENABLE_FFMPEG:BOOL=ON -DENABLE_OPENGL_CG:BOOL=ON make -j2 ``` the executable `punes` is in the `build/src` directory. #### Linux Debug version If you need the debug version then you need to replace the `cmake -B build -G Ninja` command of the previous examples with the following: ```bash cmake -B build -G Ninja -DCMAKE_C_FLAGS_DEBUG:STRING='-O0 -g -DDEBUG' -DCMAKE_CXX_FLAGS_DEBUG:STRING='-O0 -g -DDEBUG' -DCMAKE_BUILD_TYPE:STRING=Debug -DENABLE_RELEASE:BOL=OFF [...] cmake --build build -j2 ``` or if you prefer the classic Makefile: ```bash cmake -B build -DCMAKE_C_FLAGS_DEBUG:STRING='-O0 -g -DDEBUG' -DCMAKE_CXX_FLAGS_DEBUG:STRING='-O0 -g -DDEBUG' -DCMAKE_BUILD_TYPE:STRING=Debug -DENABLE_RELEASE:BOL=OFF [...] make -j2 ``` where `[...]` are the other necessary options. #### Example on how to compile on Ubuntu 22.04 ```bash sudo apt-get install git cmake ninja-build libtool build-essential pkg-config libudev-dev libasound2-dev sudo apt-get install qtbase5-dev qttools5-dev qttools5-dev-tools libqt5svg5-dev nvidia-cg-toolkit libx11-dev libxrandr-dev sudo apt-get install libavcodec-dev libavformat-dev libavutil-dev libswresample-dev libswscale-dev p7zip-full git clone https://github.com/punesemu/puNES cd puNES cmake -B build -G Ninja cmake --build build -j2 ``` to start the emulator ```bash ./build/src/punes ```:smiling_imp: FreeBSD
Expand
#### Dependencies - [CMake >= 3.14](https://cmake.org) ([Ninja](https://ninja-build.org) build system is optional) - [Qt5](https://www.qt.io) or [Qt6](https://www.qt.io) with OpenGL support (qtcore, qtgui, qtwidgets, qtnetwork, qtsvg and qttools) - [sndio](http://www.sndio.org) - [libX11 and libXrandr](https://www.x.org) - [p7zip](https://github.com/p7zip-project/p7zip) for compressed file support (lib7zip uses the 7z.so library on unix-like systems) - (optional) [ffmpeg libraries >= 4.0](https://ffmpeg.org) if you want video and audio recording support (libavcodec, libavformat, libavutil, libswresample and libswscale). See [notes](#movie_camera-ffmpeg). #### Compilation of puNES ```bash sudo pkg install -y devel/cmake devel/ninja devel/pkgconf devel/git multimedia/ffmpeg audio/sndio devel/qt5-qmake sudo pkg install -y devel/qt5-buildtools devel/qt5-core x11-toolkits/qt5-gui x11-toolkits/qt5-widgets graphics/qt5-svg sudo pkg install -y devel/qt5-linguisttools git clone https://github.com/punesemu/puNES cd puNES cmake -B build -G Ninja -DQt5_DIR=/usr/local/lib/qt5/cmake/Qt5 -DENABLE_FFMPEG:BOOL=ON cmake --build build -j2 ``` if you don't want to use the Ninja build system and prefer the classic Makefile: ```bash cmake -B build -DQt5_DIR=/usr/local/lib/qt5/cmake/Qt5 -DENABLE_FFMPEG:BOOL=ON make -j2 ``` the executable `punes` is in the `build/src` directory. #### FreeBSD Debug version If you need the debug version then you need to replace the `cmake -B Build -G Ninja` command of the previous examples with the following: ```bash cmake -B build -G Ninja -DCMAKE_C_FLAGS_DEBUG:STRING='-O0 -g -DDEBUG' -DCMAKE_CXX_FLAGS_DEBUG:STRING='-O0 -g -DDEBUG' -DCMAKE_BUILD_TYPE:STRING=Debug -DENABLE_RELEASE:BOOL=OFF [...] cmake --build build -j2 ``` or if you prefer the classic Makefile: ```bash cmake -B build -DCMAKE_C_FLAGS_DEBUG:STRING='-O0 -g -DDEBUG' -DCMAKE_CXX_FLAGS_DEBUG:STRING='-O0 -g -DDEBUG' -DCMAKE_BUILD_TYPE:STRING=Debug -DENABLE_RELEASE:BOOL=OFF [...] make -j2 ``` where `[...]` are the other necessary options.:blowfish: OpenBSD
Expand
#### Dependencies - [CMake >= 3.14](https://cmake.org) ([Ninja](https://ninja-build.org) build system is optional) - [Qt5](https://www.qt.io) or [Qt6](https://www.qt.io) with OpenGL support (qtcore, qtgui, qtwidgets, qtnetwork, qtsvg and qttools) - [sndio](http://www.sndio.org) - [libX11 and libXrandr](https://www.x.org) - [p7zip](https://github.com/p7zip-project/p7zip) for compressed file support (lib7zip uses the 7z.so library on unix-like systems) - (optional) [ffmpeg libraries >= 4.0](https://ffmpeg.org) if you want video and audio recording support (libavcodec, libavformat, libavutil, libswresample and libswscale). See [notes](#movie_camera-ffmpeg) #### Compilation of puNES ```bash git clone https://github.com/punesemu/puNES cd puNES cmake -B build -G Ninja -DQt5_DIR=/usr/local/lib/qt5/cmake/Qt5 -DENABLE_FFMPEG:BOOL=ON cmake --build build -j2 ``` if you don't want to use the Ninja build system and prefer the classic Makefile: ```bash cmake -B build -DQt5_DIR=/usr/local/lib/qt5/cmake/Qt5 -DENABLE_FFMPEG:BOOL=ON make -j2 ``` the executable `punes` is in the `buid/src` directory. #### OpenBSD Debug version If you need the debug version then you need to replace the `cmake -B Build -G Ninja` command of the previous examples with the following: ```bash cmake -B build -G Ninja -DCMAKE_C_FLAGS_DEBUG:STRING='-O0 -g -DDEBUG' -DCMAKE_CXX_FLAGS_DEBUG:STRING='-O0 -g -DDEBUG' -DCMAKE_BUILD_TYPE:STRING=Debug -DENABLE_RELEASE:BOOL=OFF [...] cmake --build build -j2 ``` or if you prefer the classic Makefile: ```bash cmake -B build -DCMAKE_C_FLAGS_DEBUG:STRING='-O0 -g -DDEBUG' -DCMAKE_CXX_FLAGS_DEBUG:STRING='-O0 -g -DDEBUG' -DCMAKE_BUILD_TYPE:STRING=Debug -DENABLE_RELEASE:BOOL=OFF [...] make -j2 ``` where `[...]` are the other necessary options.:computer: Windows
Expand
#### Dependencies - [Qt5](https://www.qt.io) with OpenGL support (5.6.3 is the last if you want the support for Windows XP) #### Development Environment installation 1. install [MSYS2](https://www.msys2.org/) 2. open "MSYS2 MinGW 64-bit" shell (or 32 bit if you want compile the 32 bit version of puNES) ```bash pacman -Syu ``` 3. close the MSYS2 window and run it again from Start menu ```bash pacman -Su pacman -S base-devel git wget p7zip unzip mingw-w64-i686-cmake mingw-w64-x86_64-cmake pacman -S perl ruby python2 mingw-w64-i686-toolchain mingw-w64-x86_64-toolchain pacman -S mingw-w64-i686-ffmpeg mingw-w64-x86_64-ffmpeg exit ``` 4. open a new MSYS2 shell and build the necessary libraries #### Compilation of the Qt5 libraries 5. download and unzip the sources ```bash wget http://download.qt.io/archive/qt/5.15/5.15.8/submodules/qtbase-everywhere-opensource-src-5.15.8.zip unzip qtbase-everywhere-opensource-src-5.15.8.zip mv qtbase-everywhere-src-5.15.8 qt5 ``` the renaming of the directory is necessary to not generate a compile-time error caused by the 255 characters maximum path length limitation on Windows, This is the typical error message you might encounter: ```code "../../../../include/QtEventDispatcherSupport/5.15.8/QtEventDispatcherSupport/private/qwindowsguieventdispatcher_p.h:1:10: fatal error: ../../../../../src/platformsupport/eventdispatchers/qwindowsguieventdispatcher_p.h: No such file or directory" ``` 6. compile the libraries ```bash cd qt5 echo -e "QMAKE_LFLAGS += -static -static-libgcc\nDEFINES += QT_STATIC_BUILD\n" >> mkspecs/win32-g++/qmake.conf ./configure.bat -prefix $MINGW_PREFIX -extprefix $MINGW_PREFIX -bindir $MINGW_PREFIX/lib/qt5/bin -headerdir $MINGW_PREFIX/include/qt5 -libdir $MINGW_PREFIX/lib/qt5 -archdatadir $MINGW_PREFIX/lib/qt5 -plugindir $MINGW_PREFIX/lib/qt5/plugins -libexecdir $MINGW_PREFIX/lib/qt5/bin -datadir $MINGW_PREFIX/share/qt5 -docdir $MINGW_PREFIX/share/doc/qt5 -translationdir $MINGW_PREFIX/share/qt5/translations -sysconfdir $MINGW_PREFIX/etc/xdg -examplesdir $MINGW_PREFIX/share/qt5/examples -testsdir $MINGW_PREFIX/share/qt5/tests -platform win32-g++ -nomake examples -nomake tests -nomake tools -no-compile-examples -release -opensource -confirm-license -static -c++std c++17 -sse2 -static-runtime -make libs -no-ltcg -no-dbus -no-accessibility -no-inotify -no-iconv -no-icu -no-openssl -no-system-proxies -no-cups -no-fontconfig -no-zstd -opengl desktop -no-angle -gif -ico -qt-libpng -qt-libjpeg -qt-pcre -qt-zlib -qt-freetype make ``` 7. and finally install them ```bash make install cp -v $MINGW_PREFIX/lib/qt5/pkgconfig/* $MINGW_PREFIX/lib/pkgconfig/. cd .. ``` 8. now it's time for the SVG module... ```bash wget http://download.qt.io/archive/qt/5.15/5.15.8/submodules/qtsvg-everywhere-opensource-src-5.15.8.zip unzip qtsvg-everywhere-opensource-src-5.15.8.zip mv qtsvg-everywhere-src-5.15.8 qt5svg cd qt5svg $MINGW_PREFIX/lib/qt5/bin/qmake make make install cp -v $MINGW_PREFIX/lib/qt5/pkgconfig/* $MINGW_PREFIX/lib/pkgconfig/. cd .. ``` 9. ...and for the tools ```bash wget http://download.qt.io/archive/qt/5.15/5.15.8/submodules/qttools-everywhere-opensource-src-5.15.8.zip unzip qttools-everywhere-opensource-src-5.15.8.zip mv qttools-everywhere-src-5.15.8 qt5tools cd qt5tools $MINGW_PREFIX/lib/qt5/bin/qmake make make install cd .. ``` #### Compilation of puNES 10. Now you have everything you need to compile correctly puNES ```bash git clone https://github.com/punesemu/puNES cd puNES ``` if you want D3D9 version : ```bash cmake -B build -G Ninja -DENABLE_FFMPEG:BOOL=ON -DENABLE_OPENGL:BOOL=OFF cmake --build build -j2 ``` otherwise : ```bash cmake -B build -G Ninja -DENABLE_FFMPEG:BOOL=ON cmake --build build -j2 ``` The executable `punes.exe` is in the `build/src` directory but in order to run it you need the following dlls: - 7z.dl - avcodec-58.dll - avformat-58.dll - avutil-56.dll - cg.dll - cgD3D9.dll (only for D3D9 version) - cgGL.dll (only for OpenGL version) - libwinpthread-1.dll - swresample-3.dll - swscale-5.dll that you can download here : :link:[`64bit`](https://www.dropbox.com/s/d632cjezybz6a74/puNES_x86_64_dlls.zip?dl=1) version or :link:[`32bit`](https://www.dropbox.com/s/ye00129nyacdl05/puNES_i686_dlls.zip?dl=1) version. #### Windows Debug version If you need the debug version then you need to replace the `cmake -B build -G Ninja` command of the previous examples with the following: ```bash cmake -B build -G Ninja -DCMAKE_C_FLAGS_DEBUG:STRING='-O0 -g -DDEBUG' -DCMAKE_CXX_FLAGS_DEBUG:STRING='-O0 -g -DDEBUG' -DCMAKE_BUILD_TYPE:STRING=Debug -DENABLE_RELEASE:BOOL=OFF [...] ``` where `[...]` are the other necessary options.:movie_camera: FFmpeg
It is always possible to disable audio/video recording support by specifying the configure parameter --without-ffmpeg.
If the installed version is lower than 4.0 the support will be disabled automatically.
Supported audio recording formats:
Supported video recording formats:
- MPEG 1 Video
- MPEG 2 Video
- MPEG 4 Video
- MPEG H264 Video (libx264) (*)
- High Efficiency Video Codec (libx265) (*)
- WebM Video (libvpx) (*)
- Windows Media Video
- AVI FF Video
- AVI Video
(*) if compiled in FFmpeg.