yuzu/README.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

87 lines
4 KiB
Markdown
Raw Normal View History

2025-08-17 12:33:42 +02:00
<!--
SPDX-FileCopyrightText: 2018 yuzu Emulator Project
SPDX-License-Identifier: GPL-2.0-or-later
-->
<h1 align="center">
<br>
2025-08-17 10:47:49 +00:00
<a href="https://yuzu-emu.org/"><img src="https://mrrp.sx7n8.tech/sun/yuzu/raw/branch/main/assets/icon.png" alt="yuzu" width="200"></a>
2025-08-17 12:33:42 +02:00
<br>
<b>yuzu</b>
<br>
</h1>
<h4 align="center"><b>yuzu</b> is the world's most popular, open-source, Nintendo Switch emulator — started by the creators of <a href="https://citra-emu.org" target="_blank">Citra ***(dead)***</a>.
2025-08-17 12:33:42 +02:00
<br>
It is written in C++ with portability in mind, and we actively maintain builds for Windows, Linux and Android.
</h4>
<p align="center">
<a href="https://dev.azure.com/yuzu-emu/yuzu/">
<img src="https://dev.azure.com/yuzu-emu/yuzu/_apis/build/status/yuzu%20mainline?branchName=master"
2025-08-17 10:59:02 +00:00
alt="Azure Mainline CI Build Status ***(broken)***">
2025-08-17 12:33:42 +02:00
</a>
<a href="https://discord.com/invite/u77vRWY">
<img src="https://img.shields.io/discord/398318088170242053?color=5865F2&label=yuzu&logo=discord&logoColor=white"
2025-08-17 10:59:02 +00:00
alt="Discord ***(broken)***">
2025-08-17 12:33:42 +02:00
</a>
</p>
<p align="center">
<a href="#compatibility">Compatibility</a> |
<a href="#development">Development</a> |
<a href="#building">Building</a> |
<a href="#download">Download</a> |
<a href="#support">Support</a> |
<a href="#license">License</a>
</p>
## Compatibility
2025-08-17 10:59:02 +00:00
The emulator is capable of running most commercial games at full speed, provided you meet the [necessary hardware requirements ***(broken)***](https://yuzu-emu.org/help/quickstart/#hardware-requirements).
2025-08-17 12:33:42 +02:00
2025-08-17 10:59:02 +00:00
For a full list of games yuzu supports, please visit our [Compatibility page ***(broken)***](https://yuzu-emu.org/game/).
2025-08-17 12:33:42 +02:00
2025-08-17 10:59:02 +00:00
Check out our [website ***(broken)***](https://yuzu-emu.org/) for the latest news on exciting features, monthly progress reports, and more!
2025-08-17 12:33:42 +02:00
## Development
2025-08-17 10:59:02 +00:00
Most of the development happens on GitHub. It's also where [our central repository](https://github.com/yuzu-emu/yuzu) is hosted. For development discussion, please join us on [Discord ***(broken)***](https://discord.com/invite/u77vRWY).
2025-08-17 12:33:42 +02:00
2025-08-17 10:59:02 +00:00
If you want to contribute, please take a look at the [Contributor's Guide ***(broken)***](https://github.com/yuzu-emu/yuzu/wiki/Contributing) and [Developer Information ***(broken)***](https://github.com/yuzu-emu/yuzu/wiki/Developer-Information).
2025-08-17 12:33:42 +02:00
You can also contact any of the developers on Discord in order to know about the current state of the emulator.
2025-08-17 10:59:02 +00:00
If you want to contribute to the user interface translation project, please check out the [yuzu project on transifex ***(broken)***](https://www.transifex.com/yuzu-emulator/yuzu). We centralize translation work there, and periodically upstream translations.
2025-08-17 12:33:42 +02:00
## Building
2025-08-17 10:59:02 +00:00
* __Windows__: [Windows Build ***(broken)***](https://github.com/yuzu-emu/yuzu/wiki/Building-For-Windows)
* __Linux__: [Linux Build ***(broken)***](https://github.com/yuzu-emu/yuzu/wiki/Building-For-Linux)
2025-08-17 12:33:42 +02:00
## Download
2025-08-17 10:59:02 +00:00
You can download the latest releases automatically via the installer on our [downloads ***(broken)***](https://yuzu-emu.org/downloads/) page.
2025-08-17 12:33:42 +02:00
## Support
If you enjoy the project and want to support us financially, check out our Patreon!
***(dead)***
2025-08-17 12:33:42 +02:00
<a href="https://www.patreon.com/yuzuteam">
<img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width="160">
</a>
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 ***(broken)***](https://discord.gg/u77vRWY) and talk to bunnei. You may also contact: donations@yuzu-emu.org ***(broken)***.
2025-08-17 12:33:42 +02:00
## License
yuzu is licensed under the GPLv3 (or any later version). Refer to the [LICENSE.txt](https://mrrp.sx7n8.tech/sun/yuzu/src/branch/main/LICENSE.txt) file.