forked from suyu/suyu
2b514275ad
* Update README.md * Adress feedback * Add link to our compatability page * Address feedback Co-Authored-By: Morph <39850852+Morph1984@users.noreply.github.com> * Fix spelling Co-Authored-By: Morph <39850852+Morph1984@users.noreply.github.com> * Small fix * Removed the mention of a specific game * fix
42 lines
2.8 KiB
Markdown
42 lines
2.8 KiB
Markdown
yuzu emulator
|
|
=============
|
|
[](https://travis-ci.org/yuzu-emu/yuzu)
|
|
[](https://ci.appveyor.com/project/bunnei/yuzu)
|
|
[](https://dev.azure.com/yuzu-emu/yuzu/)
|
|
|
|
yuzu is an experimental open-source emulator for the Nintendo Switch from the creators of [Citra](https://citra-emu.org/).
|
|
|
|
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.
|
|
|
|
yuzu only emulates a subset of Switch hardware and therefore most commercial games **do not** run at full speed or are not fully functional.
|
|
|
|
Do you want to check which games are compatible and which ones are not? Please visit our [Compatibility page](https://yuzu-emu.org/game/)!
|
|
|
|
yuzu is licensed under the GPLv2 (or any later version). Refer to the license.txt file included.
|
|
|
|
Check out our [website](https://yuzu-emu.org/)!
|
|
|
|
For development discussion, please join us on [Discord](https://discord.gg/XQV6dn9).
|
|
|
|
### Development
|
|
|
|
Most of the development happens on GitHub. It's also where [our central repository](https://github.com/yuzu-emu/yuzu) is hosted.
|
|
|
|
If you want to contribute please take a look at the [Contributor's Guide](CONTRIBUTING.md) and [Developer Information](https://github.com/yuzu-emu/yuzu/wiki/Developer-Information). You should as well contact any of the developers on Discord in order to know about the current state of the emulator.
|
|
|
|
### 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)
|
|
* __macOS__: [macOS Build](https://github.com/yuzu-emu/yuzu/wiki/Building-for-macOS)
|
|
|
|
|
|
### 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:
|
|
* 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.
|