torzu/README.md
2024-05-06 00:32:53 +02:00

4.1 KiB


torzu
torzu

torzu is a fork of yuzu, 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 I plan to actively maintain builds for Linux, Android and Windows.

Compatibility | Development | Building | Download | License

Compatibility

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

It runs most Nintendo Switch games released until the date of the Yuzu takedown.

Changes

Following are the changes made since forking from Yuzu:

  • Added option to optimize generated SPIR-V shaders via spirv-opt
  • Added option to synchronize CPU clock to render speed limit
  • Added option to launch home menu from Switch firmware
  • Fixed crash when switching away from null graphics per-game
  • Minor improvements and additions

Development

Most of the development happens on Dark Git. It's also where our central repository is hosted.

Currently, development is limited to external commits as I'm working on implementing a faster recompiler! This will increase emulation speed in CPU-bound scenarios.

If you want to contribute, please take a look at the Contributor's Guide and Developer Information.

To clone this git repository, you can use these commands given tor is installed and running:

git -c http.proxy=socks5h://127.0.0.1:9050 clone http://y2nlvhmmk5jnsvechppxnbyzmmv3vbl7dvzn6ltwcdbpgxixp3clkgqd.onion/torzu-emu/torzu.git
cd torzu
git submodule update --init --depth 1 --recursive

Alternatively, you can clone from the GitHub mirror repository:

git clone https://github.com/litucks/torzu.git --depth 1 --recursive

Note that above repository may be taken down any time. Do not rely on its existence in production.

This project incorporates several commits from the Suyu and Sudachi forks (but cleaned up due to the typically mediocre code/commit quality from both projects) as well as some custom changes, including lowered minimum boost library version requirements and faster fibers.

Building

(Only Linux builds are available for now. Next planned are Windows, then Android.)

Download

Precompiled build are available in the releases section.

License

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