totk-mobile README

项目的 README,来自 github.com/OJZen/totk-mobile。合并为一个 markdown 文件:README.md。

Zelda-Mobile

English | 简体中文

Zelda-Mobile runs the Nintendo Switch release of The Legend of Zelda: Tears of the Kingdom v1.4.3 natively on Apple silicon Macs and iPads, with an early iPhone build. The game's ARM64 code executes directly on the Apple CPU, system services are reimplemented by the host, and NVN graphics commands are translated to Metal. The Mac and iOS front ends share one core.

[!IMPORTANT] This project is not affiliated with, authorized or endorsed by Nintendo. The repository contains source code only: no game files, updates, keys, saves, game shaders or any other game-derived data, and no instructions for obtaining them. Use only a game and keys that you own and dumped from your own console.

Status

The project is under active development. You can load a save and play, but a full playthrough has not been validated.

Platform Working Known limits
Apple silicon Mac Loading saves and playing scenes, keyboard and Xbox controller (with rumble), audio, cutscenes, 30 / 60 / 90 FPS targets The first visit to a new area or camera angle may stutter while shaders compile; not every area holds 60 FPS
iPad (M1 or newer) Development-signed install, resource import, loading saves, touch controller, camera, audio Well below 60 FPS at the original resolution; the first shader preparation takes a long time; hardware controllers are not fully validated
iPhone 15 Pro Development-signed install, resource import, verified offline shader libraries, warm launch to the title screen Gameplay, frame rate, memory and thermals have not been measured; no other iPhone has been tried, and chips without BC texture support (before A17 Pro) are untested

Only v1.4.3 is supported. The preparation scripts verify module fingerprints and refuse other versions.

Requirements

Quick start (Mac)

See Building and running for the full steps and troubleshooting. In short:

git clone https://github.com/OJZen/totk-mobile.git
cd totk-mobile
brew install cmake pkg-config opus libvpx [email protected]
mkdir -p local/games local/keys
# Put the base game and the v1.4.3 update in local/games/ and prod.keys in local/keys/, then:
./script/prepare.sh
./script/prepare_resources.sh local/keys/prod.keys
./script/prepare_shaders.sh
./script/build_and_run.sh --load-only
./launch.command

After that, start the game by double-clicking launch.command (or running it in a terminal). quick-load.command additionally walks the in-game menu and loads the first entry of the save list.

The first launch prepares tens of thousands of shaders. This can take several minutes or longer; the startup screen shows each stage and its progress. Later launches reuse the cache.

Controls

Action Keyboard
Move / camera W A S D / I J K L
A / B / X / Y X (confirm) / Z (back) / R / F
L / R, ZL / ZR Q / E, Shift / Space
Inventory (+) / map (−) Return / Tab
Control panel / performance overlay / full screen ⌘, / ⌘P / ⌃⌘F

Xbox controllers connect automatically over Bluetooth or USB. Frame rate, resolution, MetalFX, sound and rumble are set in the control panel (⌘,). See Controls and settings.

Saves

Saves live in work/save/ inside the project and use the same format as the console. See Saves for importing and backing up. Do not modify this directory while the game is running.

FAQ

Startup takes a long time. The first shader preparation is slow; the startup screen shows the current stage and its progress, and during play the performance overlay (⌘P) shows shader activity. The log is work/logs/native-probe.log.

A preparation script reports a module or version mismatch. Make sure the update is v1.4.3 and that local/games/ holds exactly one base game and one update.

The game stutters. The first time a scene is seen, its pipelines are compiled on the spot and then cached. For sustained low frame rates, compare against the 1080 or 720 resolution setting in the control panel.

Does it run on Intel Macs? No. The game code runs natively as ARM64 and needs Apple silicon.

For developers

License

The original code in this repository is licensed under the Apache License 2.0. Reused third-party components keep their own licenses; see Third-party notices.

Credits

Zelda-Mobile was built with d2r-mobile as its reference project: the loader, the ARM64 module rewriter and the NVN → Metal backend follow its design, and the files this project builds on are included in core/ under its MIT license. It also draws on public work from Ryujinx, libnx, Switchbrew, SPIRV-Cross, hactool and others. See Third-party notices for details.

"The Legend of Zelda", "Tears of the Kingdom" and "Nintendo Switch" are trademarks of Nintendo.

totk-mobile (OJZen/totk-mobile)

正在搜索数据库…

这是什么?这是任天堂 Switch 游戏《塞尔达传说 王国之泪》(v1.4.3)的一个实验性原生移植版本,可直接在搭载 Apple 芯片的 Mac 和 iPad 上运行,另有一个早期的 iPhone 版本正在开发中。
这是模拟器吗?还是直接运行游戏的原始代码?这不是传统的模拟器:游戏的 ARM64 机器码直接在 Apple 处理器上执行,系统服务由宿主系统重新实现,主机的 NVN 图形调用则被转换为 Metal。
我该如何在 Mac 上运行它?在已安装 Xcode、命令行工具和 Homebrew 的 Apple 芯片 Mac 上,先构建项目,然后双击 launch.command(或在终端中运行)即可;quick-load.command 还会自动为你加载第一个存档槽。
要用它真正玩游戏,我需要准备什么?你必须自备从自己的主机中转储的《王国之泪》本体游戏和 v1.4.3 更新包(.nsz),以及配套的 prod.keys;本仓库特意不附带任何游戏文件、更新包、密钥或存档。
它能在 Intel 芯片的 Mac 上运行吗?还有其他不完善的地方吗?不能,它需要 Apple 芯片,因为游戏代码以 ARM64 原生方式运行。即使在受支持的硬件上,首次进入新区域时也可能因着色器编译而卡顿,而且完整通关尚未经过验证。
它在 iPhone 和 iPad 上的运行效果与 Mac 相比如何?Mac 是功能最完整的版本,可以游玩场景,并支持手柄和音频;iPad(M1 及以上)可以运行,但帧率仍远低于 60 FPS;iPhone 15 Pro 版本目前只能在热启动后进入标题画面,游戏体验和性能尚未进行测量。
整个代码库是否采用同一种许可证?项目自身的代码采用 Apache License 2.0,但它所依赖的第三方组件仍保留各自独立的许可证。
为什么仓库不直接附带游戏文件?游戏归任天堂所有,因此本项目只发布自己的逆向工程代码;玩家需要从自己的主机中转储自己购买的游戏副本和密钥。
作者这个项目参考了什么?它以 d2r-mobile 作为加载器、ARM64 模块重写器和 NVN 到 Metal 后端的参考设计,同时也借鉴了 Ryujinx、libnx、Switchbrew、SPIRV-Cross 和 hactool 等公开项目的成果。
我需要预留多少磁盘空间?大约需要 60GB 的可用空间:解压后的 RomFS 本身约 16GB,而着色器缓存和构建产物还会额外占用大量空间。
在 Mac 上如何操控游戏?WASD 或 IJKL 用于移动视角,X/Z/R/F 对应 A/B/X/Y,Q/E 和 Shift/Space 对应肩部扳机键;Xbox 手柄可通过蓝牙或 USB 自动连接,并支持震动反馈。
作者
OJZen
大小
1.5 MB
星标
223
更新
提交Oct 21
时长
1个月
提交 · 90 天