Skip to content

About

Singer-facing companion mobile app for KHost (MAUI Blazor Hybrid, iOS/Android)

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

🎤 KHost Cue

You're on cue. — the singer & patron companion app for KHost, open-source karaoke host software.

Platform .NET UI License Docs

KHost Cue is a cross-platform mobile app for iOS and Android that keeps a personal karaoke wishlist in your pocket. Add songs you'd love to sing, line up a set for the night, rate how each performance went, and look up lyrics on the spot — with your list stored on your device.

📸 Screenshots

Guided tour — a first-run walkthrough spotlights each key control one step at a time My Songs — the wishlist as sortable, swipeable cards with album-art covers, a pinned search box, and a floating + button Tonight — the on-deck set list on its own tab: drag to reorder and check each song off as you sing it
Song detail — the album cover behind the title, per-performance ratings, enjoyment, performance history, and quick links to YouTube, Spotify, and KaraFun Lyrics — looked up in-app from LRCLIB Venue detail — each place you sing builds its own history (performances, average, go-to songs), with a one-tap KaraFun catalog and Active / Favorite toggles
Venue switcher — tap the header chip to jump between your venues, set the active one, or mark yourself as not at a venue Who's singing? — tap the header avatar to switch between everyone sharing the device; each singer keeps their own songs and the app re-tints to their color
Surprise me — tap the 🎲 and it picks a song for you, with Add to Tonight, Open song and Reroll right there Performance history — every time you sang a song, each with its own rating and note; swipe a row to remove it or press and hold a date to change it Spelling check — a ⚠ beside a song's name unfolds the catalogue's own spelling: “Did you mean Bohemian Rhapsody — Queen?”, with Use this or Not a typo
Settings — feature toggles grouped by what they affect, in collapsible sections Settings dials — past the on/off switches sit the app's tunables: undo window, which tab opens on launch, music catalogue region and import lookup speed Import & Export — move a singer's profile between devices, export/import venues, or pull songs from a Spotify or YouTube Music playlist

✨ Features

  • Tonight set list — build an on-deck set for the venue on its own tab: add songs, drag to reorder, and check each one off as you sing it, with live “X of Y done” progress. Tap a row to peek at the song's details. It's kept separate from your wishlist, so a song you sang earlier today stays unchecked until you check it off here. Your place in the list is kept as you switch tabs and come back.
  • Multiple singers, one device — share the app with the whole table: each singer keeps their own My Songs and Tonight set, venues are shared, and the whole app re-tints to the active singer's color. Switch with a tap on the header avatar — no login, no accounts.
  • Venues — keep the places you sing, switch the active one from a header chip (or let it auto-detect the nearest as you move — a venue you pick yourself stays put across restarts until you hand it back to auto-detect), and every performance you log is tagged there — so each venue builds its own history and go-to songs. Add one by hand or by scanning its KaraFun QR code; the active venue opens its KaraFun catalog in one tap — or shows it as a QR code for someone else to scan and browse the songbook on their own phone.
  • My Songs — a personal wishlist of songs to sing, as swipeable cards. Add with the floating +, search titles and artists from a box that stays pinned as you scroll, filter by genre, tags, year or rating, and sort your way — by song, artist, ratings, when you added a song, or when you last sang it. Everything stays put as you switch tabs and come back. One tap on a card queues a song for tonight.
  • Ratings & history — rate every performance (a "how it went" score) plus a separate enjoyment rating, jot per-performance notes, and keep a running performance history for each song. Logging defaults to right now, but the date and time are editable, so a sing you forgot at the time still lands on the night it happened. History opens in its own sheet from the song's details (on My Songs or Tonight), where a swipe removes an entry and a press-and-hold changes its date. A song's shown star is confidence-weighted: it blends the song's own record with your list's overall average, so a single lucky 5 doesn't outrank a solid ten-performance streak — and the more you sing something, the more its star trusts its own history. Optionally weight recent performances more (Settings → Singing & ratings) so your current form leads.
  • Lyrics — look a song's lyrics up in-app from LRCLIB (no account needed) and cache them on-device so they open instantly next time.
  • Surprise me — can't decide what to sing? Tap the 🎲 and it picks one for you, with Reroll right there if you want another. Press and hold it to choose how it picks: skip anything you've sung today, lean toward the songs you sing best (by that confidence-weighted star), stick to favourites or to songs you've never sung, and whether to draw from your filters or the whole list.
  • Quick links — jump straight to any song on YouTube or Spotify, or search your venue on KaraFun. KaraFun search is per-venue, so set your venue once (Settings → KaraFun, or the first time you tap the button) and it remembers the venue ID — paste a link from your venue's KaraFun page, type the ID, or (on iOS/Android) scan the venue's QR code.
  • Favorites — star the songs you love; they float to the top of the list.
  • Tags — add your own free-form labels to a song — duet, closer, needs practice — shown as chips on the card and detail sheet. Reuse suggestions keep them tidy, and you can filter your list by tag (match any or all of the tags you pick). Switch tags off entirely in Settings → Show song tags.
  • Import & export — export a singer's whole profile (songs and performance history) to a file for backup or to move them to another device, export/import your venue list separately, or pull songs straight in from a public Spotify or YouTube Music playlist link.
  • Auto-fill — looks up a song's release year and genre automatically (via the iTunes Search API) so you don't have to type them.
  • Spelling check — if the lookup finds no exact match but something one slip away, a ⚠ appears next to the song's name. Tap it and it asks "Did you mean Bohemian Rhapsody — Queen?"; take the correction with one tap and the year, genre and cover fill in behind it, or wave it off and it never asks again.
  • Album art — each song's cover is used as its card background — and behind the title on the song's detail sheet — with a dark fade behind the text for legibility. Covers are looked up from iTunes, with Deezer as a fallback for songs iTunes can't find (e.g. album deep cuts), and cached on-device; clear them from the Danger zone, or switch the whole thing off in Settings → Show album art on cards.
  • Update alerts — tells you when a newer version is available (from the app's GitHub Releases) with a one-tap link to grab it.
  • Guided tour — a first-run walkthrough spotlights every feature one step at a time, chapter by chapter, with real sample data to point at. Skip any card or the whole thing; replay it anytime from Settings.
  • Made to feel at home — mobile-first layout, light & dark themes, haptic feedback, and a 12- or 24-hour clock. Settings is grouped into collapsible sections where every extra behavior can be switched off — and past the on/off switches it holds the app's dials: how long an undo stays open, which tab opens on launch, how near a venue counts as here (and whether distances read in feet or metres), how far back a venue's history runs, how much your recent form sways a song's star, which music catalogue region to search, and how fast an import may look songs up. Every default matches how the app already behaved, so there's nothing to set up.

🚀 Getting started

Grab the latest KHostCue-vX.Y.Z.apk from Releases and sideload it on Android (you may need to allow installs from your browser or file manager). The app checks Releases itself and shows a banner when a newer version is out. On iOS, build from source for now.

Building from source or contributing? See DEVELOPMENT.md for prerequisites, build & run commands, testing, project layout, and design notes.

📖 Documentation

The KHost Cue wiki documents every screen, gesture and setting — written against the app running on a device, so the labels it quotes are the ones you'll see.

The wiki lives in its own repo (KHost.Mobile.wiki.git) — clone it, edit the markdown, push. DEVELOPMENT.md stays canonical for build commands and design rationale; the wiki's contributor pages point back at it.

🤝 Contributing

Issues and pull requests are welcome. Please keep changes focused and describe the behavior you're changing. See DEVELOPMENT.md for how to build and test, and AGENTS.md for coding conventions.

📄 License

KHost Cue is licensed under the PolyForm Shield License 1.0.0 — the same license as KHost.

You may use, modify, and self-host it for any purpose, including commercial use (for example, running it for your own karaoke events). You may not use it to provide a competing product or service — such as a hosted/managed offering (SaaS) or a rebranded redistribution — without a separate license. Commercial, SaaS, and OEM licenses are available; contact Michael Riddle riddlemd@gmail.com.

Third-party components bundled in the app are listed, with their licenses, in THIRD-PARTY-NOTICES.md (all MIT / Apache-2.0).

About

Singer-facing companion mobile app for KHost (MAUI Blazor Hybrid, iOS/Android)

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages