Nintendo Switch emulator (unofficial mirror fork)

c-plus-plus cpp emulation emulator switch

Go to file

ascpixi 34d8dd557b Merge pull request #13 from paypay-a/master Added macOS Build instructions		2024-03-06 03:10:42 +01:00
.ci	Update code references to `yuzu-emu`	2024-03-05 01:25:36 +01:00
.github	Delete .github/workflows/cmake-multi-platform.yml	2024-03-05 11:06:54 -06:00
.reuse	android: Provide debug.keystore for debug and relWithDebInfo builds	2024-01-21 22:08:07 -05:00
CMakeModules	Update code references to `yuzu-emu`	2024-03-05 01:25:36 +01:00
LICENSES	general: fix trailing whitespace	2024-01-08 09:34:32 -05:00
dist	Remove trailing whitespaces	2024-03-01 14:19:02 +08:00
externals	Merge pull request #12981 from lat9nq/tzdb-asan-custom	2024-02-10 22:42:47 -05:00
hooks	chore: make yuzu REUSE compliant	2022-07-27 12:53:49 +02:00
src	Update code references to `yuzu-emu`	2024-03-05 01:25:36 +01:00
tools	tools: Add reset submodules script	2024-02-25 17:17:01 +00:00
.codespellrc	core: refactor emulated cpu core activation	2023-12-04 10:37:16 -05:00
.git-blame-ignore-revs	Skip git blame	2023-11-04 18:26:49 +00:00
.gitattributes	chore: make yuzu REUSE compliant	2022-07-27 12:53:49 +02:00
.gitignore	android: Initialize defaults for each orientations	2023-06-14 16:35:58 -04:00
.gitmodules	Fork missing merryhime/dynarmic repository	2024-03-04 23:45:17 +00:00
CMakeLists.txt	Update code references to `yuzu-emu`	2024-03-05 01:25:36 +01:00
CONTRIBUTING.md	Update code references to `yuzu-emu`	2024-03-05 01:25:36 +01:00
Doxyfile	chore: make yuzu REUSE compliant	2022-07-27 12:53:49 +02:00
LICENSE.txt	chore: make yuzu REUSE compliant	2022-07-27 12:53:49 +02:00
README.md	Update README.md	2024-03-05 20:07:47 -06:00
vcpkg.json	android: add oboe audio sink	2023-12-17 01:42:59 -05:00

README.md

yuzu

yuzu is the world's most popular, open-source, Nintendo Switch emulator — started by the creators of Citra.
It is written in C++ with portability in mind, and we actively maintain builds for Windows, Linux and Android.

[!NOTE] This is an unofficial mirror fork of the original repository.

Compatibility

The emulator is capable of running most commercial games at full speed, provided you meet the necessary hardware requirements.

For a full list of games yuzu supports, please visit our Compatibility page.

Check out our website for the latest news on exciting features, monthly progress reports, and more!

Development

Most of the development happens on GitHub. It's also where our central repository is hosted. For development discussion, please join us on Discord.

If you want to contribute, please take a look at the Contributor's Guide and Developer Information. You can also contact any of the developers on Discord in order to know about the current state of the emulator.

If you want to contribute to the user interface translation project, please check out the yuzu project on transifex. We centralize translation work there, and periodically upstream translations.

Building

Windows: Windows Build
Linux: Linux Build
MacOS: MacOS Build
Android: Android Build

Download

You can download the latest releases automatically via the installer on our downloads page.

Support

If you enjoy the project and want to support us financially, check out our Patreon!

Any donations received will go towards things like:

Switch consoles to explore and reverse-engineer the hardware
Switch games for testing, reverse-engineering, and implementing new features
Web hosting and infrastructure setup
Software licenses (e.g. Visual Studio, IDA Pro, etc.)
Additional hardware (e.g. GPUs as-needed to improve rendering support, other peripherals to add support for, etc.)

If you wish to support us a different way, please join our Discord and talk to bunnei. You may also contact: donations@yuzu-emu.org.

License

yuzu is licensed under the GPLv3 (or any later version). Refer to the LICENSE.txt file.