diff options
| -rw-r--r-- | README.md | 77 |
1 files changed, 57 insertions, 20 deletions
| @@ -1,43 +1,80 @@ | |||
| 1 | yuzu emulator | 1 | <h1 align="center"> |
| 2 | ============= | 2 | <br> |
| 3 | [](https://travis-ci.com/yuzu-emu/yuzu) | 3 | <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> |
| 4 | [](https://dev.azure.com/yuzu-emu/yuzu/) | 4 | <br> |
| 5 | [](https://discord.com/invite/u77vRWY) | 5 | <b>yuzu<b> |
| 6 | <br> | ||
| 7 | </h1> | ||
| 6 | 8 | ||
| 7 | yuzu is an experimental open-source emulator for the Nintendo Switch from the creators of [Citra](https://citra-emu.org/). | 9 | <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>. |
| 10 | <br> | ||
| 11 | It is written in C++ with portability in mind, and we actively maintain builds for Windows and Linux. | ||
| 12 | </h4> | ||
| 8 | 13 | ||
| 9 | 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. | 14 | <p align="center"> |
| 15 | <a href="https://dev.azure.com/yuzu-emu/yuzu/"> | ||
| 16 | <img src="https://dev.azure.com/yuzu-emu/yuzu/_apis/build/status/yuzu%20mainline?branchName=master" | ||
| 17 | alt="Azure Mainline CI Build Status"> | ||
| 18 | </a> | ||
| 19 | <a href="https://discord.com/invite/u77vRWY"> | ||
| 20 | <img src="https://img.shields.io/discord/398318088170242053?color=%237289DA&label=yuzu&logo=discord&logoColor=white" | ||
| 21 | alt="Discord"> | ||
| 22 | </a> | ||
| 23 | </p> | ||
| 10 | 24 | ||
| 11 | yuzu only emulates a subset of Switch hardware and therefore most commercial games **do not** run at full speed or are not fully functional. | 25 | <p align="center"> |
| 26 | <a href="#compatibility">Compatibility</a> | | ||
| 27 | <a href="#development">Development</a> | | ||
| 28 | <a href="#building">Building</a> | | ||
| 29 | <a href="#download">Download</a> | | ||
| 30 | <a href="#support">Support</a> | | ||
| 31 | <a href="#license">License</a> | ||
| 32 | </p> | ||
| 12 | 33 | ||
| 13 | Do you want to check which games are compatible and which ones are not? Please visit our [Compatibility page](https://yuzu-emu.org/game/)! | 34 | ## Compatibility |
| 14 | 35 | ||
| 15 | yuzu is licensed under the GPLv2 (or any later version). Refer to the license.txt file included. | 36 | 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). |
| 16 | 37 | ||
| 17 | Check out our [website](https://yuzu-emu.org/)! | 38 | For a full list of games yuzu support, please visit our [Compatibility page](https://yuzu-emu.org/game/) |
| 18 | 39 | ||
| 19 | For development discussion, please join us on [Discord](https://discord.com/invite/u77vRWY). | 40 | Check out our [website](https://yuzu-emu.org/) for the latest news on exciting features, monthly progress reports, and more! |
| 20 | 41 | ||
| 21 | ### Development | 42 | ## Development |
| 22 | 43 | ||
| 23 | Most of the development happens on GitHub. It's also where [our central repository](https://github.com/yuzu-emu/yuzu) is hosted. | 44 | 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). |
| 24 | 45 | ||
| 25 | 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. | 46 | 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). |
| 47 | You can also contact any of the developers on Discord in order to know about the current state of the emulator. | ||
| 26 | 48 | ||
| 27 | 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. | 49 | 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. |
| 28 | 50 | ||
| 29 | ### Building | 51 | ## Building |
| 30 | 52 | ||
| 31 | * __Windows__: [Windows Build](https://github.com/yuzu-emu/yuzu/wiki/Building-For-Windows) | 53 | * __Windows__: [Windows Build](https://github.com/yuzu-emu/yuzu/wiki/Building-For-Windows) |
| 32 | * __Linux__: [Linux Build](https://github.com/yuzu-emu/yuzu/wiki/Building-For-Linux) | 54 | * __Linux__: [Linux Build](https://github.com/yuzu-emu/yuzu/wiki/Building-For-Linux) |
| 33 | 55 | ||
| 56 | ## Download | ||
| 34 | 57 | ||
| 35 | ### Support | 58 | You can download the latest releases automatically via the installer on our [downloads](https://yuzu-emu.org/downloads/) page. |
| 36 | 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: | 59 | |
| 60 | |||
| 61 | ## Support | ||
| 62 | |||
| 63 | If you find enjoy the project and want to support us financially, check out our Patreon! | ||
| 64 | |||
| 65 | <a href="https://www.patreon.com/yuzuteam"> | ||
| 66 | <img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width="160"> | ||
| 67 | </a> | ||
| 68 | |||
| 69 | Any donations received will go towards things like: | ||
| 37 | * Switch consoles to explore and reverse-engineer the hardware | 70 | * Switch consoles to explore and reverse-engineer the hardware |
| 38 | * Switch games for testing, reverse-engineering, and implementing new features | 71 | * Switch games for testing, reverse-engineering, and implementing new features |
| 39 | * Web hosting and infrastructure setup | 72 | * Web hosting and infrastructure setup |
| 40 | * Software licenses (e.g. Visual Studio, IDA Pro, etc.) | 73 | * Software licenses (e.g. Visual Studio, IDA Pro, etc.) |
| 41 | * Additional hardware (e.g. GPUs as-needed to improve rendering support, other peripherals to add support for, etc.) | 74 | * Additional hardware (e.g. GPUs as-needed to improve rendering support, other peripherals to add support for, etc.) |
| 42 | 75 | ||
| 43 | 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. | 76 | 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. |
| 77 | |||
| 78 | ## License | ||
| 79 | |||
| 80 | 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. | ||