Files
breeze/README.md
T

3.4 KiB
Raw Blame History

Inner Breeze

Inner Breeze is a free, open-source practice app for breathing, meditation, and habit tracking.

Features

  • Guided practice sessions with visual and audio cues
  • Mind, Yoga, and Fitness organization for habits and practice views
  • Configurable breathing sessions and meditation timers
  • Habit tracking with session history
  • Local SQLite storage with import/export support
  • Theme customization with light and dark variants
  • Touch-optimized UI for desktop and mobile

Building

inbe uses raylib and requires a Nix development environment.

Prerequisites

  • Nix with flakes enabled
  • For Android builds: Java 17+ JDK

Native Build

# Enter the development shell
nix develop

# Build for your current platform
make native

# Run
make run

Cross-Platform Builds

# Android debug APK
make android-debug

# Android release APK
make android-release PASSWORD=your-keystore-password

Release Automation

GitHub Actions builds release artifacts for web, Linux, Windows, Android, and the Chrome extension. When a new version tag is created by the release workflow, the web, Android, Windows, and Linux builds are also published to itch.io.

Required repository secrets:

  • ITCH_API_KEY - itch.io Butler API key for publishing waozi/inbe:html5, waozi/inbe:android, waozi/inbe:windows, and waozi/inbe:linux

Android Emulator Testing

For automated testing with camera notch (cutout) support:

# Enter the development shell and run everything automatically
nix develop
./scripts/emulator.sh    # Creates and launches the test AVD
make android-install     # Builds, installs, and launches the app

This single script handles:

  • AVD creation (if missing)
  • Emulator launch
  • APK build
  • App installation and launch

The AVD is configured with:

  • Device: Pixel 6 (punch-hole camera style)
  • Display: 1080×2400 @ 420dpi
  • RAM: 4GB with hardware acceleration
  • Cutout: Punch-hole camera for testing window insets

Platform-Specific Notes

  • Linux: Requires SDL2 runtime libraries
  • Windows: Standalone executable, no dependencies
  • Android: Requires Android NDK in the development shell
  • Web: Requires Emscripten toolchain

Project Structure

  • src/ - Inbe application code
  • vendor/ - external third-party dependencies
  • vendor/flint/ - git submodule for first-party UI/runtime support code used directly by Inbe
  • wasm4/ - Standalone WASM-4 version
  • assets/ - Images and sounds
  • droid/ - Android build configuration

Flint submodule workflow

vendor/flint is a source submodule (not a one-off copied sync). To update Inbe after a Flint change:

  1. Push changes in the Flint repo.
  2. In Inbe, update the submodule pointer:
    • git submodule update --init --recursive vendor/flint
    • git -C vendor/flint pull
  3. Commit Inbe with the updated vendor/flint submodule reference.

When updating other projects that vendor Flint as a submodule, this keeps UI behavior and API docs aligned.

Sync model

Inbe is offline-first. User-owned app data moves through the storage sync chain; social data is server-authorized. Friends, requests, and leaderboard snapshots are cached locally for fast/offline UI, but Lyra owns the authoritative social state and refreshes those caches through authenticated sync.

License

MIT - see LICENSE