punesemu/puNES

Qt-based Nintendo Entertainment System emulator and NSF/NSFe Music Player

💾 Work in Progress (WIP) Builds

These executables are always updated to the latest commit:

• Windows 32 bit : 🔗OpenGL - 🔗D3D9
• Windows 64 bit : 🔗OpenGL - 🔗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.

🍺 Support

If you want buy me a beer :

You can help translate puNES on Crowdin

📷 Screenshots

⌨️ Configuration

To run in portable mode there is 3 distinct ways:

1. If the executable is in a folder containing the puNES.cfg file.
2. Rename the executable by adding the suffix _p.
   • Examples: punes.exe -> punes_p.exe or punes64.exe -> punes64_p.exe
3. Run the emulator with the "--portable" option.

To see a list of available command-line options, start puNES with the -h argument.

🔌 Supported Mappers

🔌 Unif

NROM, NROM-128, NROM-256, Transformer, SLROM, UOROM, UNROM, CNROM, TLROM, TBROM, TFROM, TKROM, ANROM, AMROM, AOROM, SL1632, SC-127, CC-21, SuperHIK8in1, STREETFIGTER-GAME4IN1, A60AS, Supervision16in1, MARIO1-MALEE2, T3H53, D1038, NTBROM, SA-016-1M, VRC7, TEK90, BB, H2288, LH32, 22211, SA-72008, T4A54A, Sachen-8259D, Sachen-8259B, Sachen-8259C, Sachen-8259A, KS7032, SA-NROM, SA-72007, TC-U01-1.5M, SA-0037, SA-0036, Sachen-74LS374N, FS304, Super24in1SC03, WAIXING-FS005, FK23C, FK23CA, FC-28-5027, NovelDiamond9999999in1, JC-016-2, 8237, 8237A, N625092, Ghostbusters63in1, WAIXING-FW01, 42in1ResetSwitch, 150in1A, 212-HONG-KONG, 70in1, 70in1B, 603-5052, 43272, OneBus, DANCE, 158B, F-15, HPXX, HP2018-A, 810544-C-A1, SHERO, KOF97, YOKO, T-262, CITYFIGHT, COOLBOY, MINDKIDS, 22026, 80013-B, GS-2004, GS-2013, A65AS, DRIPGAME, BS-5, 411120-C, K-3088, GKCXIN1, 60311C, NTD-03, DRAGONFIGHTER, 13in1JY110, TF1201, 11160, 190in1, 8157, KS7057, KS7017, SMB2J, KS7031, KS7016, KS7037, TH2131-1, LH51, KS7013B, RESET-TXROM, 64in1NoRepeat, 830134C, HP898F, 830425C-4391T, K-3033, FARID_SLROM_8-IN-1, FARID_UNROM_8-IN-1, MALISB, 10-24-C-A1, RT-01, EDU2000, 12-IN-1, WS, 8-IN-1, NEWSTAR-GRM070-8IN1, CTC-09, K-3046, CTC-12IN1, SA005-A, K-3006, K-3036, TJ-03, COOLGIRL, RESETNROM-XIN1, GN-26, L6IN1, KS7012, KS7030, 830118C, G-146, 891227, KS106C, 3D-BLOCK, SB-5013, N49C-300, 820561C, M2C52A, 830752C, BS-400R, BS-4040R, K-3010, K-3071, SA-9602B, DANCE2000, EH8813A, DREAMTECH01, LH10, 900218, KS7021A, BJ-56, AX-40G, 831128C, T-230, AX5705, CHINA_ER_SAN2, 82112C, KONAMI-QTAI, AC08, S-2009

ℹ️ How to Compile

• 🐧 Linux
• 😈 FreeBSD
• 🐡 OpenBSD
• 💻 Windows

CMake Options

🐧 Linux

Dependencies

• CMake >= 3.14 (Ninja build system is optional)
• Qt5 or Qt6 with OpenGL support (qtcore, qtgui, qtwidgets, qtnetwork, qtsvg and qttools)
• nvidia-cg
• alsa
• libudev
• libX11 and libXrandr
• p7zip for compressed file support (lib7zip uses the 7z.so library on unix-like systems)
• (optional) ffmpeg libraries >= 4.0 if you want video and audio recording support (libavcodec, libavformat, libavutil, libswresample and libswscale). See notes.

Compilation of puNES

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:

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:

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:

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

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

./build/src/punes

😈 FreeBSD

Dependencies

• CMake >= 3.14 (Ninja build system is optional)
• Qt5 or Qt6 with OpenGL support (qtcore, qtgui, qtwidgets, qtnetwork, qtsvg and qttools)
• sndio
• libX11 and libXrandr
• p7zip for compressed file support (lib7zip uses the 7z.so library on unix-like systems)
• (optional) ffmpeg libraries >= 4.0 if you want video and audio recording support (libavcodec, libavformat, libavutil, libswresample and libswscale). See notes.

Compilation of puNES

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:

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:

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:

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.

🐡 OpenBSD

Dependencies

• CMake >= 3.14 (Ninja build system is optional)
• Qt5 or Qt6 with OpenGL support (qtcore, qtgui, qtwidgets, qtnetwork, qtsvg and qttools)
• sndio
• libX11 and libXrandr
• p7zip for compressed file support (lib7zip uses the 7z.so library on unix-like systems)
• (optional) ffmpeg libraries >= 4.0 if you want video and audio recording support (libavcodec, libavformat, libavutil, libswresample and libswscale). See notes

Compilation of puNES

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:

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:

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:

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.

💻 Windows

Dependencies

• Qt5 with OpenGL support (5.6.3 is the last if you want the support for Windows XP)

Development Environment installation

1. install MSYS2
2. open "MSYS2 MinGW 64-bit" shell (or 32 bit if you want compile the 32 bit version of puNES)

pacman -Syu

3. close the MSYS2 window and run it again from Start menu

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

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:

"../../../../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

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

make install
cp -v $MINGW_PREFIX/lib/qt5/pkgconfig/* $MINGW_PREFIX/lib/pkgconfig/.
cd ..

8. now it's time for the SVG module...

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

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

git clone https://github.com/punesemu/puNES
cd puNES

if you want D3D9 version :

cmake -B build -G Ninja -DENABLE_FFMPEG:BOOL=ON -DENABLE_OPENGL:BOOL=OFF
cmake --build build -j2

otherwise :

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 : 🔗64bit version or 🔗32bit 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:

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.

🎥 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:

• WAV Audio
• MP3 Audio (lame) (*)
• AAC Audio
• Flac Audio
• Ogg Audio (vorbis) (*)
• Opus Audio (libopus) (*)

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.