suyu-v0.0.4 README

The project's README from github.com/suyu-emu/suyu-v0.0.4. As one markdown file: README.md.

suyu


suyu
suyu

Nintendo Switch emulator and native recompiler — based on Eden, which itself descends from yuzu.

Status | Building | License


This is the final public release of suyu — v0.04. This repository is a public archive.

No further development or downloads are planned. The codebase is preserved here under GPL-3.0 for historical reference and community use.

Note: a small number of fixes were later pulled in from a community continuation of this codebase, after users reported that installed updates/DLC, service handler registration, and RomFS registration were all broken in the archived build. Those fixes are folded in here as bug fixes to suyu itself; this remains the same final v0.04 release, not new development.

About

suyu is a Nintendo Switch emulator and AArch64 native recompiler written in C++. It can run decrypted Switch titles using either:

Based on Eden, with suyu's own improvements to UI, recompiler, and platform support.

Status

Final version: v0.04. Automated builds are published to the releases page by GitHub Actions (Windows, Linux, Android).

Platforms: Windows, Linux, Android. macOS/iOS not included in this release.

suyu is a GPLv3 program, which allows fully free redistribution of its source code and releases liability of its authors for how this software is used as stated in Section 15 and 16.

The suyu Emulator program does not circumvent Nintendo's technological protection measures (TPMs) as the user is required to provide both the Nintendo Switch software & the encryption keys for these games, and the suyu Emulator uses a mode of the Advanced Encryption Standard (AES), an open encryption standard established by the US NIST, along with the encryption keys that the user themselves must lawfully acquire, to decrypt the software. As the standard is public and available to use by all, it does not constitute as the Digital Market Copyright Act's (DMCA) definition of "circumventing a technological measure" as defined in Section 1201(a)(3).

The suyu Emulator also falls under the exemptions stated in Section 1201(f) of the DMCA as this software was created for the purposes of reverse engineering the Nintendo Switch software (known as Horizon OS) to create interoperability with Nintendo Switch games and software with the Windows, macOS, and GNU/Linux operating systems.

Any aggressive DMCA claims or takedown notices against projects that explicitly disclaim piracy support, require user-provided keys, and limit functionality to interoperability (such as suyu) could constitute overreach or misuse of the DMCA.

As derived from §512(f), if Nintendo (or an affiliated entity) knowingly materially misrepresents that a project like suyu is infringing (or circumvents TPMs) when it does not, especially if they fail to consider fair use, interoperability exemptions under §1201(f), or the fact that the emulator requires user-provided keys and does not itself contain proprietary Nintendo code, they can be made liable for any Damages against suyu.

Building

Dependencies

Windows

cmake -B build -DCMAKE_BUILD_TYPE=Release -DENABLE_QT=ON -DYUZU_USE_BUNDLED_QT=OFF -GNinja
cmake --build build --target suyu suyu-cmd

Linux

sudo apt-get install ninja-build qt6-base-dev libqt6svg6-dev libusb-1.0-0-dev libssl-dev
cmake -B build -DCMAKE_BUILD_TYPE=Release -DENABLE_QT=ON -DYUZU_USE_BUNDLED_QT=OFF -GNinja
cmake --build build --target suyu suyu-cmd

Android

cd src/android && ./gradlew assembleMainlineRelease

License

GPL-3.0-or-later. See LICENSE.txt.

suyu-v0.0.4 (suyu-emu/suyu-v0.0.4)

Searching Database…

280 ·GitHub
archived
这是什么?suyu 是一款任天堂 Switch 模拟器和 AArch64 原生重编译器,用 C++ 编写,保留在最终公开发布版 v0.04。
它到底是怎么运行 Switch 游戏的?有两种方式:HLE 模拟模式通过 suyu 核心(GPU、CPU、音频、系统服务)运行游戏;重编译模式则把游戏的 AArch64 代码静态预编译为原生的 x86-64 可执行文件,它们使用同一套 HLE 后端。
我怎么把它跑起来?从 GitHub Releases 页面下载 Windows、Linux 或 Android 的预编译包即可。如果想从源码构建,需要 CMake 3.15+、Ninja、Qt 6.4+、Vulkan SDK、libusb 和 OpenSSL。
我得自己有游戏才能用吗?是的——它只能运行已解密的 Switch 游戏,游戏和对应的加密密钥都必须由你自己提供;模拟器两者都不附带,这也是其法律声明的核心内容。
suyu 还在继续开发吗?没有。v0.04 是最终公开发布版,仓库已作为公开存档归档——不会再有后续开发或下载;代码以 GPL-3.0 许可证保留,供历史参考和社区使用。
它能在哪些平台上运行?Windows、Linux 和 Android——这三个平台的自动构建都发布在 Releases 页面上。此版本不包含 macOS 和 iOS。
它是怎么渲染 Switch 游戏画面的?在 HLE 模式下,Switch 的 GPU 与 CPU、音频和系统服务一起由 suyu 核心进行模拟;构建依赖 Vulkan SDK,所以渲染走的是 Vulkan。
有哪些社区修复被合并进了这个最终版本?用户反馈在存档版本中,已安装的更新/DLC、服务处理程序注册以及 RomFS 注册都无法正常工作。这些问题的修复已作为 bug 修复合并进 suyu 本身,但发布版本仍是最终的 v0.04——并不算新开发。
suyu 和 Eden 或其他 Switch 模拟器有什么关系?它基于 Eden 开发,并在界面、重编译器和平台支持方面加入了 suyu 自己的改进。
为什么 README 里花了那么多篇幅讲 DMCA?它论证 suyu 并没有规避任天堂的技术保护措施:用户自行提供游戏和密钥,解密依赖公开的 AES 标准,项目主张适用 DMCA 第 1201(f) 条的互操作性豁免。它还警告说,明知故犯地把这类项目错误指控为侵权,指控方可能要依第 512(f) 条承担责任。
Creator
suyu-emu
Size
350 MB
Stars
280
Updated
CommitSep 13
Age
1mo
Commits · 90 Days