NX2navi README

The project's README from github.com/tangerineturtle1/NX2navi. As one markdown file: README.md.

Triforce

NX2navi

[!IMPORTANT] NX2navi is no longer the current project. NX2navi and Triforce have merged and go on as Triforce. Get Triforce from https://triforceproject.com. Its source is at https://git.triforceproject.com/triforce/source.

This repository and its releases are kept as they are. Release 0.12.0 turns an installed NX2navi launcher into a window that starts Triforce Setup; Play NX2navi there still starts the game you have built, and your game, saves and settings stay where they are. Triforce's Convert saves page brings your NX2navi saves over.

Join the official Triforce update discord server: https://discord.com/invite/uf6gSrsPpq

NX2navi is a static recompilation of The Legend of Zelda: Ocarina of Time for Nintendo Switch 2 (game version 1.1.1) into a native x86-64 application for Windows, with a Vulkan renderer (docs/architecture.md).

[!IMPORTANT] No game files are included. You need your own legally obtained copy of the game, dumped from your own console. Instructions for obtaining those files will not be provided.

The game is built from your files on your machine, so the result contains the game. It is for your own use. Do not share it.

Status

New work goes into Triforce, not here (see the top of this page). What follows describes NX2navi as it was at the handover.

Playable. Kokiri Forest, Kakariko Village, Death Mountain Trail and its crater, the Temple of Time and the Great Fairy fountains play at 60 fps and above on current GPUs, from the title screen and from saves. Visual bugs and occasional crashes are still expected (Known issues).

Report problems as issues, following CONTRIBUTING.md.

Features

Installing

New here: get Triforce from https://triforceproject.com instead. Release 0.12.0 carries no setup, and a launcher installed from an earlier release updates itself into the window that starts Triforce Setup. The rest of this section describes NX2navi's own setup before 0.12.0.

Download NX2navi-Setup-<version>.exe from the releases and start it next to your .nup dump. It is the only file you need. The launcher it installs finds the dump, downloads the build tools, builds the game on your PC (20 to 45 minutes, once) and starts it; afterwards it keeps the port up to date and rebuilds only what changed (docs/launcher.md). docs/README-BuildKit.md describes the same build by hand, docs/building.md building from source. Settings are in the in-game menu and in nx2navi.ini (nx2navi.ini.example lists every key). Controls: docs/controls.md.

Requirements: Windows 10 or later; an x86-64 CPU with SSE4.2 (AVX2/FMA machines get a faster build); 16 GB of RAM; about 34 GB free for the game and 1.5 GB for the launcher and its tools; a GPU with Vulkan 1.3, VK_EXT_external_memory_host and VK_EXT_mesh_shader. The setup is not signed, so SmartScreen warns on its first start.

Known issues

License

The source is public to read. Its additions and changes are all rights reserved (LICENSE-ADDITIONS): no part of them may be copied or published without written permission. The base import stays under its MIT License, and third-party code keeps its own license (THIRD_PARTY_NOTICES.md). No license grants anything for Nintendo's game.

NX2navi is an independent, non-commercial fan project, not affiliated with or endorsed by Nintendo. The Legend of Zelda, Ocarina of Time and Nintendo Switch are trademarks of Nintendo.

Building from source

docs/building.md lists the toolchain and the steps. tools/make_game.py also builds the game natively on Linux (docs/README-BuildKit.md, "Linux"); the launcher and the setup are Windows only. Everything the build writes stays under build\ and generated\, which git ignores, as it does the runtime's shaders the build compiles (runtime\*_spv.h; the repository holds their source only); run tools/check_content.py before a commit.

NX2navi (tangerineturtle1/NX2navi)

Searching Database…

4.3K ·GitHub
What is this?A native Windows PC version of The Legend of Zelda: Ocarina of Time, statically recompiled from the Nintendo Switch 2 release (game version 1.1.1). No game files are included, so the game is built on your own PC from your own dump.
Is this an emulator?No. It runs as native x86-64 code rather than emulating the console, packaged as a Windows application with a Vulkan renderer.
How do I get it running?Download the setup .exe from the releases page and run it next to your .nup dump. The launcher finds the dump, downloads the build tools, builds the game once on your PC (10 to 25 minutes) and starts it. Later it rebuilds only what changed.
What does my PC need?Windows 10 or later, an x86-64 CPU with SSE4.2, 16 GB of RAM, about 30 GB free for the game plus 1.5 GB for the launcher and its tools, and a GPU with Vulkan 1.3.
How stable is it right now?Not fully. It is in early development: only some areas such as Kokiri Forest and the Temple of Time reach 60 fps, and visual bugs, occasional crashes and a rare particle crash are expected. The first start after an install or update, and the first visit to an area, can pause while the driver builds shaders.
Can I run it on Mac or Linux?No, it targets Windows 10 or later only. The setup is also unsigned, so SmartScreen will warn you on its first start.
Does it need a powerful graphics card?It needs a GPU with Vulkan 1.3 and two extensions. NVIDIA DLSS requires an RTX card, while AMD FSR 3.1 upscaling and frame generation work on any GPU.
Does it support widescreen and high frame rates?Yes. It supports native 21:9 and 32:9 with the HUD kept 16:9, runs at 60 fps by default with a 30 to 240 fps limit, the display's refresh rate or unlimited, and offers resolutions up to 5K or the window's own size.
Does it work with a gamepad?Yes. Keyboard, mouse and gamepads are supported with remapping, Nintendo or Xbox button layouts, rumble and gyro, and the game follows whichever connected gamepad you press.
Is HDR supported?Yes, on HDR displays it offers the game's own native HDR or an enhanced HDR made from the game's SDR picture.
Why does the first start take a while?The build runs once on your PC (10 to 25 minutes). Later, the first start after an install or update can pause briefly while the graphics driver builds shaders it has not seen before.
Size
12.9 MB
Stars
4.3K
Age
11d
Commits · 90 Days