Schplee
5 years ago
committed by
GitHub
GitHub
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 57 additions and 20 deletions
-
77README.md
@ -1,43 +1,80 @@ |
|||
yuzu emulator |
|||
============= |
|||
[](https://travis-ci.com/yuzu-emu/yuzu) |
|||
[](https://dev.azure.com/yuzu-emu/yuzu/) |
|||
[](https://discord.com/invite/u77vRWY) |
|||
<h1 align="center"> |
|||
<br> |
|||
<a href="https://yuzu-emu.org/"><img src="https://raw.githubusercontent.com/yuzu-emu/yuzu-assets/master/icons/icon.png" alt="yuzu" width="200"></a> |
|||
<br> |
|||
<b>yuzu<b> |
|||
<br> |
|||
</h1> |
|||
|
|||
yuzu is an experimental open-source emulator for the Nintendo Switch from the creators of [Citra](https://citra-emu.org/). |
|||
<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</a>. |
|||
<br> |
|||
It is written in C++ with portability in mind, and we actively maintain builds for Windows and Linux. |
|||
</h4> |
|||
|
|||
It is written in C++ with portability in mind, with builds actively maintained for Windows and Linux. The emulator is capable of running several commercial games. |
|||
<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" |
|||
alt="Azure Mainline CI Build Status"> |
|||
</a> |
|||
<a href="https://discord.com/invite/u77vRWY"> |
|||
<img src="https://img.shields.io/discord/398318088170242053?color=%237289DA&label=yuzu&logo=discord&logoColor=white" |
|||
alt="Discord"> |
|||
</a> |
|||
</p> |
|||
|
|||
yuzu only emulates a subset of Switch hardware and therefore most commercial games **do not** run at full speed or are not fully functional. |
|||
<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> |
|||
|
|||
Do you want to check which games are compatible and which ones are not? Please visit our [Compatibility page](https://yuzu-emu.org/game/)! |
|||
## Compatibility |
|||
|
|||
yuzu is licensed under the GPLv2 (or any later version). Refer to the license.txt file included. |
|||
The emulator is capable of running most commercial games at full speed, provided you meet the [necessary hardware requirements](https://yuzu-emu.org/help/quickstart/#hardware-requirements). |
|||
|
|||
Check out our [website](https://yuzu-emu.org/)! |
|||
For a full list of games yuzu support, please visit our [Compatibility page](https://yuzu-emu.org/game/) |
|||
|
|||
For development discussion, please join us on [Discord](https://discord.com/invite/u77vRWY). |
|||
Check out our [website](https://yuzu-emu.org/) for the latest news on exciting features, monthly progress reports, and more! |
|||
|
|||
### Development |
|||
## Development |
|||
|
|||
Most of the development happens on GitHub. It's also where [our central repository](https://github.com/yuzu-emu/yuzu) is hosted. |
|||
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](https://discord.com/invite/u77vRWY). |
|||
|
|||
If you want to contribute please take a look at the [Contributor's Guide](https://github.com/yuzu-emu/yuzu/wiki/Contributing) and [Developer Information](https://github.com/yuzu-emu/yuzu/wiki/Developer-Information). You should also contact any of the developers on Discord in order to know about the current state of the emulator. |
|||
If you want to contribute, please take a look at the [Contributor's Guide](https://github.com/yuzu-emu/yuzu/wiki/Contributing) and [Developer Information](https://github.com/yuzu-emu/yuzu/wiki/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, please check out the [yuzu project on transifex](https://www.transifex.com/yuzu-emulator/yuzu). We centralize translation work there, and periodically upstream translations. |
|||
If you want to contribute to the user interface translation project, please check out the [yuzu project on transifex](https://www.transifex.com/yuzu-emulator/yuzu). We centralize translation work there, and periodically upstream translations. |
|||
|
|||
### Building |
|||
## Building |
|||
|
|||
* __Windows__: [Windows Build](https://github.com/yuzu-emu/yuzu/wiki/Building-For-Windows) |
|||
* __Linux__: [Linux Build](https://github.com/yuzu-emu/yuzu/wiki/Building-For-Linux) |
|||
|
|||
## Download |
|||
|
|||
### Support |
|||
We happily accept monetary donations, or donated games and hardware. Please see our [donations page](https://yuzu-emu.org/donate/) for more information on how you can contribute to yuzu. Any donations received will go towards things like: |
|||
You can download the latest releases automatically via the installer on our [downloads](https://yuzu-emu.org/downloads/) page. |
|||
|
|||
|
|||
## Support |
|||
|
|||
If you find enjoy the project and want to support us financially, check out our Patreon! |
|||
|
|||
<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.) |
|||
|
|||
We also more than gladly accept used Switch consoles, preferably ones with firmware 3.0.0 or lower! If you would like to give yours away, don't hesitate to join our [Discord](https://discord.gg/VXqngT3) and talk to bunnei. You may also contact: donations@yuzu-emu.org. |
|||
If you wish to support us a different way, please join our [Discord](https://discord.gg/u77vRWY) and talk to bunnei. You may also contact: donations@yuzu-emu.org. |
|||
|
|||
## License |
|||
|
|||
yuzu is licensed under the GPLv2 (or any later version). Refer to the [license.txt](https://github.com/yuzu-emu/yuzu/blob/master/license.txt) file. |
|||
Write
Preview
Loading…
Cancel
Save
Reference in new issue