Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4,035 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ocarina Wallpaper

Ocarina Wallpaper is a native animated-wallpaper workbench powered by the Ocarina of Time scene renderer. Pick any retail map, choose a camera and clock policy, and attach the live scene to the desktop with its authored lighting, weather, water, particles, actors, room streaming, and environmental audio.

It is a standalone community project based on Ship of Harkinian and the OoT decompilation project. It is not affiliated with or endorsed by Nintendo or Harbour Masters.

Download

Download the package for your machine from GitHub Releases.

Platform x86_64 AArch64 / Apple silicon
Windows oot-wallpaper-windows-x86_64.zip oot-wallpaper-windows-aarch64.zip
macOS oot-wallpaper-macos-x86_64.dmg oot-wallpaper-macos-aarch64.dmg
Linux oot-wallpaper-linux-x86_64.AppImage oot-wallpaper-linux-aarch64.AppImage

Every release also provides SHA256SUMS. Builds are currently unsigned and not notarized.

The downloads contain the application, its open project archive soh.o2r, extractor descriptions, and required runtime libraries. They do not contain a ROM, oot.o2r, oot-mq.o2r, or other Nintendo-extracted game assets.

First run

You need a supported, legally acquired dump of Ocarina of Time. The original ROM is not modified. The app extracts a local oot.o2r or oot-mq.o2r; do not upload or share that generated archive.

Windows

  1. Extract the zip to a writable local folder. Do not run it inside the zip, a temporary folder, OneDrive, or Program Files.
  2. Launch oot-wallpaper.exe and select your supported ROM when asked.
  3. If SmartScreen appears, inspect the publisher/source, then use More info → Run anyway only if you trust this release.

Wallpaper attachment uses the Windows Explorer WorkerW desktop host.

macOS

  1. Choose the Apple-silicon package for M-series Macs or x86_64 for Intel Macs. Release builds require macOS 15 or newer.
  2. Open the DMG, copy Ocarina Wallpaper.app to Applications, and launch it.
  3. Select your supported ROM when asked. App data is stored in ~/Library/Application Support/oot-wallpaper/.

Because the current build is not notarized, the first launch may require right-clicking the app and choosing Open, or allowing it once in System Settings → Privacy & Security. Do not disable Gatekeeper globally.

Linux

mkdir -p ~/Applications/oot-wallpaper
mv oot-wallpaper-linux-*.AppImage ~/Applications/oot-wallpaper/
cd ~/Applications/oot-wallpaper
chmod +x oot-wallpaper-linux-*.AppImage
./oot-wallpaper-linux-*.AppImage

Select a supported ROM when asked. Keep the AppImage in a stable, writable folder so its generated archive and configuration remain available.

Desktop attachment requires an X11 session and an EWMH-aware window manager. Under native Wayland the app runs as a normal preview window; XWayland support depends on the compositor.

Use

  1. Search or browse the complete retail map catalogue.
  2. Select a map and choose Preview scene.
  3. Configure the display, placement, time, camera, sound, and frame rate.
  4. Choose Set as wallpaper.
  5. Press Ctrl+Shift+F12 to restore the workbench.

The renderer can fill a display or use a custom frame. Choose Move / resize renderer, drag or resize the native window, then choose Use current window frame before attaching it.

Free camera

Select Free camera, then choose Control free camera or press F2.

Input Action
W/A/S/D Move forward/left/back/right
Mouse Look
Q / E Move down / up
Shift Speed boost
Esc or F2 Release the camera

Authored horizontal and vertical passages stream adjacent dungeon/interior rooms while flying. Arbitrary noclip through solid walls away from a room portal may still expose out-of-bounds geometry.

Frame rate and power

The workbench supports 20–360 FPS. Twenty FPS is native rendering; 60 FPS is the dedicated wallpaper default. Higher frame rates use more CPU and GPU, increase heat, and can drain laptop battery much faster. Use 20–30 FPS when efficiency matters. Match-refresh and VSync can cap the effective rate to the display.

What wallpaper mode changes

  • Link, Navi, the game HUD, gameplay input, and the inherited SoH Escape menu are removed from the wallpaper experience.
  • Link and Navi sounds are filtered while NPC and environmental effects remain.
  • Audio can use the full scene, nature/effects only, or mute.
  • Time can follow local time, stay fixed, or run at a custom scale.
  • Fixed, orbit, dolly, spline, and mouse-driven free cameras are available.

Technical architecture, room-streaming behavior, and local build details are in WALLPAPER.md.

Build from source

Clone recursively and provide your own supported ROM only when generating the local game archive:

git clone --recursive https://github.com/Cycl0o0/oot-wallpaper.git
cd oot-wallpaper
cmake -S . -B build/wallpaper -GNinja \
  -DCMAKE_BUILD_TYPE=Release \
  -DOOT_WALLPAPER_BUILD_TESTS=ON
cmake --build build/wallpaper --target ExtractAssets
cmake --build build/wallpaper --parallel
ctest --test-dir build/wallpaper --output-on-failure

See docs/BUILDING.md for platform dependencies. The output is oot-wallpaper or oot-wallpaper.exe.

Licensing and credits

Original Ocarina Wallpaper components and copyrightable project contributions are offered under AGPL-3.0-only to the extent of their contributors' rights. This does not relicense inherited Shipwright, OoT decompilation, dependency, or Nintendo material. See LICENSE, the full AGPL text, and NOTICE.md.

Foundations and credits:

Keep every upstream notice and dependency license intact. No permission to redistribute Nintendo game content is granted.

Releases

Packages

Contributors

Languages