chrissotraidis / bluewake

# BlueWake
 The Legend of Zelda: The Wind Waker, running natively on iPhone, iPad, Mac, Windows and Linux. 
 A static recompilation of the GameCube original, with touch controls, controller support and mods.
> [!IMPORTANT]
> **Bring your own disc.** BlueWake needs your own legally obtained copy of *The Wind Waker* for
> GameCube, USA version (`GZLE01`, revision 0). This repository contains no disc image, game assets
> or saves.
## Get BlueWake
| You play on | What to do |
| --- | --- |
| **Windows** 10 or 11 | Download the ready-made build and choose your disc image |
| **iPhone or iPad** | Build your own app on an Apple Silicon Mac, then install it |
| **Mac** (Apple silicon) | Build your own app from this repository |
| **Apple TV** | Follow the tvOS build guide (experimental) |
| **Linux** (x86-64) | Build the native version; a ready-made download is not published yet |
| **Android** (arm64) | Build your own APK on a Windows PC (experimental) |
On Mac, iPhone, iPad, Linux and Android, the app you build contains code translated from your disc. **It is yours
alone: never share or upload it.**
**Questions or bugs?** Ask on Discord or
open an issue.
## Coming from Wind Waker Recomp?
Wind Waker Recomp has moved here. Its creator, Elliott, now
maintains BlueWake together with Chris, and his work is part of BlueWake with his authorship kept.
- **Windows:** BlueWake 0.8.0, on the latest release,
 is built from BlueWake itself and replaces Wind Waker Recomp 0.4.0. Smooth
 Motion is off by default (press **F10** to turn it on), and 0.4.0's experimental 60 FPS game logic
 is gone.
- **Saves carry over:** both use `%APPDATA%\BlueWake`. Back that folder up before switching.
- **Bugs and requests** go to BlueWake's issues.
 Say which build you use and attach your session log.
How the move happened and what's left of it: migration status.
## Install
### Windows
1. Download `BlueWake-v0.8.0-windows-x64.zip` from the
 Releases page.
2. Unpack the whole ZIP and run `BlueWake.exe`.
3. On first launch, choose your disc image (`.iso` or `.gcm`). A Dolphin `.rvz` must first be
 converted to ISO in Dolphin: right-click the game and choose **Convert File**.
You need a CPU with AVX2 (Intel Haswell from 2013, AMD Ryzen, or newer) and a Direct3D 12 GPU; since 0.8.0 an older
GPU gets Direct3D 11 instead of a black screen (not yet checked on such a PC). If nothing happens when you open it, see the FAQ below. To build it yourself from your disc instead, see
BlueWake on Windows.
### Linux
The native x86-64 Linux source build is available now; a ready-made AppImage has
not been published yet. Build it from your disc, optionally package the
AppImage, and open its graphical setup with `--setup`. See
BlueWake on Linux for the commands, dependencies and AppImage
instructions.
### iPhone and iPad
You need:
- a Mac with Apple silicon, Xcode (with the iOS platform installed), and at least 25 GB of free space
- your `GZLE01` revision 0 disc image
- an A13 or newer iPhone or iPad on