A small script-based utility that upgrades an existing Aquaria installation to the Open Source Edition (OSE), which is compatible with modern macOS.

This tool is a companion to the Aquaria Open Source Edition repository.

• The official macOS release of Aquaria is a legacy 32-bit application that hasn't been updated in over a decade
• Since macOS 10.15 (Catalina), it can no longer be played on modern Macs
• This tool streamlines the building process for Aquaria OSE, which is fully compatible with the latest versions of macOS

Note: If you have an Intel Mac with macOS 10.14 or earlier, you can still run the official Aquaria app natively (available for purchase on GOG).

• Merges Open Source Edition files with an existing Aquaria installation
• Creates a clean standalone application without modifying the original installation
• Supports sourcing game data from macOS, Windows or Linux versions

• Original Aquaria game data from an official release, which must be sourced from a legal purchase
• Only required for manual steps: A compatible Aquaria binary (refer to the AquariaOSE repo for compilation instructions)

1. Download the latest updater app from the Releases page
2. Run the updater app and select your existing Aquaria installation when prompted
3. Navigate to your Applications folder to find AquariaOSE.app
4. Launch and enjoy!

If this fails, proceed with the Developer Guide below

• The following steps are for manually bundling the updater app and manually patching the game
• This allows you to select a custom-compiled binary and use OSE files from a specific branch

1. Open Terminal and navigate to the repository root

   cd /path/to/updater

2. Make the bundle script executable and run it

   chmod +x build_updater_app.zsh
   ./build_updater_app.zsh

3. The updater app will be created in build/

1. Launch the Aquaria Updater.app
2. Select your source installation (i.e. Aquaria.app)
3. Choose your preferred Aquaria OSE update branch (master or experimental)
4. Select your new compatible Aquaria binary (compiled from the AquariaOSE repo)
5. Find AquariaOSE.app in your Applications folder

├── build_updater_app.zsh    # Script to bundle and create the updater app (`Aquaria Updater.app`)
├── README.md
├── src/                     # Updater app files
│   ├── updater_runtime.zsh  # Core update logic
│   ├── updater.icns
│   └── updater.plist
└── assets/                  # AquariaOSE app metadata and icon
    ├── aquariaOSE.icns
    └── aquariaOSE.plist