| Core | ||
| Dependencies | ||
| DependencyPacker | ||
| Docs | ||
| GUI.NET | ||
| InteropDLL | ||
| Libretro | ||
| Linux | ||
| Lua | ||
| PGOHelper | ||
| SevenZip | ||
| TestHelper | ||
| UpdateHelper | ||
| Utilities | ||
| Windows | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| build.sh | ||
| buildPGO.sh | ||
| LICENSE | ||
| makefile | ||
| Mesen.sln | ||
| README.md | ||
Mesen
Mesen is a cross-platform NES/Famicom emulator for Windows & Linux built in C++ and C#.
If you want to support this project, please consider making a donation:
Website (https://www.mesen.ca)
Documentation (https://www.mesen.ca/docs)
Development Builds
Development builds of the latest commit are available from Appveyor. For stable release builds, see the Releases section below.
Warning: These are development builds and may be unstable. Using them may also increase the chances of your settings being corrupted, or having issues when upgrading to the next official release. Additionally, these builds are currently not optimized via PGO and will typically run 20-30% slower than the official release builds.
Windows:
Linux:
Releases
Windows
The latest version is available on the website. Older releases are available from the releases tab on GitHub.
Ubuntu
The official releases (same downloads as the Windows builds above) also contain the Linux version of Mesen, built under Ubuntu 16 - you should be able to use that in most cases if you are using Ubuntu.
The Linux version is a standard .NET executable file and requires Mono to run - you may need to configure your environment to allow it to automatically run .exe files through Mono, or manually run Mesen by using mono (e.g: "mono Mesen.exe").
The following packages need to be installed to run Mesen:
- mono-complete
- libsdl2-2.0
- gnome-themes-standard
Note: Mono 4.6.2 or higher is recommended, some older versions of Mono (e.g 4.2.2) appear to have some stability and performance issues which can cause crashes and slow down the UI.
Arch Linux
Packages are available here: https://aur.archlinux.org/packages/mesen
Roadmap
Things that may or may not be added in the future, in no particular order:
- Support for more UNIF boards and more NES/Famicom input devices
- Shaders
- TAS editor
Compiling
Windows
Standalone
- Open the solution in VS2017
- Compile as Release/x64 or Release/x86
- Run
Libretro
- Open the solution in VS2017
- Compile as Libretro/x64 or Libretro/x86
- Use the "mesen_libretro.dll" file in bin/(x64 or x86)/Libretro/mesen_libretro.dll
Linux
Standalone
To compile Mesen under Linux you will need a recent version of clang/gcc. This is because Mesen requires a C++14 compiler, along with support for the filesystem API (C++17). Additionally, Mesen has the following dependencies:
- Mono 4.6.2+ (package: mono-devel)
- SDL2 (package: libsdl2-dev)
Mono 4.6.2 or higher is recommended because some older versions (e.g 4.2.2) tend to have both stability and performance issues.
The makefile contains some more information at the top. Running "make" will build the x64 version by default, and then "make run" should start the emulator. LTO is supported under clang, which gives a large performance boost (25-30%+), so turning it on is highly recommended (see makefile for details).
Libretro
To compile the libretro core you will need a recent version of clang/gcc. This is because Mesen requires a C++14 compiler, along with support for the filesystem API (C++17).
Running "make libretro" will build the core and put it in "bin/mesen_libretro.(x64 or x86).so". LTO is supported under clang, which gives a large performance boost (25-30%+), so turning it on is highly recommended (see makefile for details).
Note: There is also another makefile in the Libretro folder - this is used by the RetroArch's buildbot to build the core. You can also try using this makefile if you are having issues with the one in the root folder.
License
Mesen is available under the GPL V3 license. Full text here: http://www.gnu.org/licenses/gpl-3.0.en.html
Copyright (C) 2014-2018 M. Bibaud
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.