Skip to main content

Build and run

Caller Karaoke is a Rust workspace with five crates: core (domain and timing), music (ABC, arrangement, synthesis), sources (ContraDB and ABC Session Tunes), app (the shared eframe/egui application), and web (the WASM entry point and Trunk page).

Requirements​

  • A recent stable Rust toolchain. The workspace declares Rust 1.95 as its minimum.
  • Windows or Linux for the desktop build.
  • On Linux: ALSA, X11/Wayland, OpenGL, GTK file dialogs, OpenSSL, and Speech Dispatcher. A typical Debian/Ubuntu install is:
  1. Install the native build dependencies.

    sudo apt-get install libasound2-dev libxkbcommon-dev libssl-dev libx11-dev libxcursor-dev libxi-dev libxrandr-dev libgl1-mesa-dev libgtk-3-dev libspeechd-dev speech-dispatcher

Windows needs no extra system packages for the default build; the release build statically links the MSVC runtime. The app uses the system audio device and the installed Windows voices.

Run a development build​

  1. Clone the repository.

    git clone https://github.com/nicholasgower/Caller-karaoke.git
  2. Enter the workspace.

    cd Caller-karaoke
  3. Build and launch the desktop app.

    cargo run -p caller-app

The first build compiles the UI, audio, and synthesis crates and takes a few minutes. Later builds are incremental.

Build a release binary​

  1. Build with optimizations.

    cargo build --release -p caller-app
  2. Run the release binary on Linux. On Windows use target\release\caller-karaoke.exe.

    target/release/caller-karaoke

First launch​

The app opens on the Session tab with Another Last Dance and Sandy Boys already loaded. The prompt says READY and the line above it says Press Play to prepare the music with these settings. The arrangement is prepared in the background while the session is idle; the first Play installs the prepared loop.

The app stores preferences and the source cache in the standard per-user configuration and cache directories. Searches and detail pages are fetched on demand; the bundled defaults need no network.

Build the web app​

rustup target add wasm32-unknown-unknown
cargo install trunk --locked
cd crates/web && trunk build --release

The bundle is written to dist/web. It must be served over HTTP. See Run in the browser.

Build the Android APK​

Android requires the SDK/NDK, cargo-apk, and the arm64/armv7 targets:

rustup target add --toolchain 1.100.0 \
aarch64-linux-android armv7-linux-androideabi
python packaging/android/build-apk.py

The script wraps cargo apk, adds the rs.tts.Bridge class used by the Android TTS backend, aligns the archive, and signs it. The output is target/release/apk/caller-karaoke.apk.

See Install on Android for the device-testing status and limitations.

Run the tests​

  1. Run the core, music, sources, app, and web tests.

    cargo test --workspace
  2. Check formatting.

    cargo fmt --all --check
  3. Check lints.

    cargo clippy --workspace --all-targets -- -D warnings

Packaging status​

Releases are cut by hand from main with node scripts/release.mjs, which starts the release workflow; once every build passes it tags v<version> and attaches a Windows installer and portable ZIP, a Linux .deb and AppImage, a web ZIP, and an Android APK to that release. Feature work merges into dev first. Builds are not code-signed yet. Flatpak remains a source-tree packaging path. Use the download page for the current release.

Do not follow a third-party install guide for 0.1.0; use this repository's release artifacts or build from source.

Next: Your first session.