Find your next open-source project

Search by name, purpose, or keyword — or paste a GitHub repository URL

sostenesfreitas/ocarina-recomp

Games

Recompiles a user's own copy of Ocarina of Time into a native Windows Vulkan build.

131
6
C
GPL-3.0
new today

Project overview

Ocarina Recomp is an experimental project that translates The Legend of Zelda: Ocarina of Time from its original console code into C and compiles it as a native Windows program, using Vulkan for rendering rather than running a general-purpose emulator. The pipeline works on the user's own game copy: recomp/gen.py translates ARM64 game code to C, tools/build_game.py builds that C together with a runtime layer, runtime/ maps NVN 2 graphics calls to Vulkan, and Ampere shaders are lowered to Maxwell and translated to SPIR-V via a patched Ryujinx how it works.

The repository contains no game, keys or prebuilt game executable, and does not explain how to obtain them repository note. It targets Windows users with compatible hardware who want to build and test the project, not people looking for a ready-to-play download.

Current status

Development is early and experimental. Testing has been limited to one machine (Ryzen 9 9950X3D, RTX 5090) around the opening area. Kokiri Village visuals, sound, controller input, saves and videos are reported working, with roughly 59 fps standing still and 51–55 fps walking on that GPU. Stutter when entering new areas remains, ocarina playing was patched but not tested in-game, and Hyrule Field and the rest of the game are untested. AMD and Intel GPUs have never been tested status table.

Getting started

The easiest route is the installer. Download Instalar-Ocarina.exe and run it; because it is unsigned, Windows may warn, and the README instructs choosing "More information" then "Run anyway". In the window, select your game's .nup file or a folder containing exefs and romfs, then click Install, accepting any request to install tools. If you prefer to inspect the scripts first, the executable only launches Instalar-Ocarina.ps1, and the launcher source is short launcher.c; releases include a SHA-256.

The script route installs tools first, then runs:

git clone https://github.com/sostenesfreitas/ocarina-recomp C:\OcarinaRecomp
cd C:\OcarinaRecomp
powershell -ExecutionPolicy Bypass -File .\verificar.ps1 -Jogo "C:\caminho\seu-jogo.nup"
powershell -ExecutionPolicy Bypass -File .\compilar.ps1 -Simular -Jogo "C:\caminho\seu-jogo.nup"
powershell -ExecutionPolicy Bypass -File .\compilar.ps1 -Jogo "C:\caminho\seu-jogo.nup"

verificar.ps1 only reports missing prerequisites; -Simular prints commands without executing them; the final command runs the build and asks before each step, resuming if interrupted script steps. A fully manual route is documented in the build guide. The build reportedly takes 30 minutes to 2 hours.

After building, launch the generated ocarina.exe; F1 or Esc opens options, F11 toggles fullscreen and F10 shows fps, with the full list in controls. On first launch vegetation may take a few minutes to appear while shaders compile.

Requirements and constraints

  • Windows 10/11 64-bit with an AVX2-capable CPU.
  • A GPU supporting Vulkan 1.3 and mesh shaders with an up-to-date driver; NVIDIA is recommended.
  • 16 GB RAM recommended; less has not been tested.
  • 60 GB free plus about 15 GB on C: if tools are not installed yet, and internet access during installation.
  • Your own game copy at version 1.1.1; other versions do not work requirements.

The installer and scripts write only inside the project folder and never modify the game file, but installing tools may require administrator rights. Generated output (ocarina.exe, generated code, shader cache and saves) derives from your game and should not be shared what the install does. Uninstalling means deleting the project folder; separately installed tools are removed through Windows settings. The project is under GPL-3.0 with third-party components keeping their own licenses license.

HotRepo's take

The project appeared on HotRepo's new-project board with 131 stars gained in a roughly 2.4-hour window from 2026-11-06 to 2026-11-07, reaching 132 stars and 6 forks overall. That is a single snapshot with no recorded daily rank, so it supports the fact of early attention but not a trend. The technical claim is notable because the build depends on the user's own game file and only one GPU configuration has been tested; the README itself scopes working features to the opening area, which is the relevant benchmark for anyone evaluating it.

Written by AI from the project's README, updated . The project's own docs are the source of truth.