8000
Skip to content

ibidathoillah/Okaerii

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Okaerii 🍵

Your personal ambient soundscape companion. Create focus, relaxation, or sleep environments right from your menu bar.

Latest Release   Download for macOS

Welcome Screen

Main Menu    Create Scene

Okaerii (おかえり) is a minimalist, open-source macOS menu bar application designed to help you stay focused, relax, or drift off to sleep with high-quality ambient audio. It lives quietly in your menu bar, ready to transform your environment with a single click.

Features

  • High-Fidelity Audio: We prioritize audio quality above all else. Okaerii bundles studio-grade, uncompressed soundscapes (Rain, Thunder, Waves, etc.) to ensure a rich, immersive experience without the digital artifacts found in streaming apps.
  • 100% Offline & Private: All high-quality assets are stored locally. No internet connection required, no buffering, no tracking, and no monthly subscriptions.
  • Menu Bar Native: Runs entirely in the background with a lightweight system footprint. Accessible via a simple 🍵 icon.
  • Curated Scenes: Instantly switch between handcrafted environments like "Deep Work", "Midnight Rain", and "Forest Zen".
  • Custom Mixes: Create your own perfect atmosphere by mixing layers and adjusting individual volumes to your taste.
  • Gapless Looping: Our custom audio engine ensures seamless, infinite playback without jarring interruptions.
  • Minimalist UI: A clean, distraction-free interface built with SwiftUI.

Installation

Download Official Release

  1. Download the latest Okaerii.dmg from GitHub Releases.
  2. Open the DMG and drag Okaerii.app to your Applications folder.

Important

macOS Gatekeeper Note: Since this is an open-source app not signed by an Apple Developer certificate, you may see a message saying "Okaerii is damaged" or "cannot be opened". To fix this, run the following command in your Terminal:

xattr -cr /Applications/Okaerii.app

From Source

You can run Okaerii directly using Swift Package Manager:

git clone https://github.com/ibidathoillah/Okaerii.git
cd Okaerii
swift run

Building the App

To create a standalone .app and .dmg installer locally:

./scripts/build_installer.sh

Automation (One-Click Release)

To automate the entire Build -> Commit -> Tag -> Push -> GitHub Release flow:

chmod +x scripts/release.sh
./scripts/release.sh

This will guide you through the versioning and release process using the gh CLI and our CI/CD pipeline.

Development

Okaerii is built using:

  • Swift 5.9+
  • SwiftUI for the user interface
  • AppKit for window management and menu bar integration
  • AVFoundation for high-performance audio mixing

Requirements

  • macOS 14.0 (Sonoma) or later
  • Xcode 15+ (for development)

Xcode Setup

  1. Ensure you have XcodeGen installed (brew install xcodegen).
  2. Run xcodegen generate in the project root.
  3. Open Okaerii.xcodeproj.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Author

Made with 🍵 by Ibid Athoillah.

About

🍵 Your personal ambient soundscape companion for macOS. Focus, relax, and sleep with high-quality audio scenes.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

0