Documentation
QUP Karaoke Engine Documentation

QUP installs with everything it needs, including its own Java runtime: you do not need to install Java. The one exception is the Linux portable zip, which needs Java 25. The Quick Start Guide covers installing on Windows, macOS and Linux.
A new install opens with each part of QUP in its own window, as above. The windows snap to each other and to the edges of the screen, and QUP remembers where you put them. To put everything in one window, right-click any window's title bar and choose Dock (choose Undock to split them again). Windows → Reset layout in the same menu puts every window back where it started.
For Developers
- Plugin API — Build your own plugin: lifecycle, PluginContext, new playable formats, audio taps and DSP
- Skins — Make your own skin: the pack format, parts and layers, colour tokens, meter and knob gradients, and testing
Getting Started
- Quick Start Guide — Import media and queue your first singer in under five minutes
- Updating QUP — The update notice, Update now, Update when I close QUP, and what happens while an update installs
DJ Mode
- DJ Mode — Switching in, two decks, beatgrids and SYNC, scratch, the crossfader, video decks, and Auto DJ
Bar Terminal
- Bar Terminal — The bartender's screen on Windows or Android: install and set up, hand out cards, load credit, the bartender PIN, the night's takings, closing time
Kiosk
- QUP Kiosk for Android — Turn a tablet into the singers' kiosk: sign in with a card or a name, find songs, queue them
- QUP Kiosk for Windows and Linux — Turn a touchscreen PC into the singers' kiosk: install it, connect it with the kiosk code, and what singers see
Cheer
- QUP Cheer — The room joins in from their phones: reactions, chat, stickers, shout-outs and Roast me; prices and credit packs, house credits, moderation, and where it all appears on the singer screen
Main Interface
- Main Interface Overview — QUP's windows, docking them into one window, saved layouts, the right-click menu and the main hotkeys
- Quick Access Menu — The right-click menu on every window: Dock, New Session, Preferences, Singer Database, About, Help, Report a problem, Exit
- About Dialog — Version info, license and Import license key, EULA, error log, OBS status, accounting
- Queuing Songs — Double-click for Singer Entry, right-click Enqueue Song, or drag onto the Playlist
- Playlist — The song queue: columns, drag-and-drop reordering, search, right-click options, Open kcombo
- Filler Playlist — The Filler tab: background music between singers, how to fill it, and the crossfader modes
- History — The History tab: every song sung this session, its columns and right-click options
- Rotation — The singer rotation table, its columns, reordering, right-click management
- Crossfader — The CROSSFADER and CUT sliders, Silence/No Karaoke/Manual modes
- Equalizer — Karaoke and Filler EQ windows, 10 bands, per-song presets (Add, MA), AGC levelling
Media Library
- Karaoke Media Library — Local Library → Karaoke: columns, searching, queuing, right-click options
- Filler Media Library — Local Library → Filler: browsing, enqueuing, playlists
- File Management — Optional plugin (Plugin Browser). Bulk rename, import/rename formats, manual edit with regex
- Karaoke Maker — Optional plugin (Plugin Browser). AI track creation, job queue, output settings
- SongShop — Optional plugin (Plugin Browser). Party Tyme catalog search and on-demand purchasing
- Mic Effects — Live microphone reverb and delay, BPM-synced echo, per-song presets (Plugins → Audio)
Preferences
- Startup Mode — Start QUP as Karaoke, DJ, Media Player or Simple Player
- Karaoke — Closing time and session restart, venue name, singer limits, rotation options, queue locks
- Network — HTTP/HTTPS servers for the singer pages, OSC messages for lighting desks and control surfaces
- Media — Media library folders, scanning, the filler/karaoke crossfade
- Database — Song name formatting (including custom patterns), backups, media and singer database tools
- Input/Outputs — Audio driver and devices, buffer size, video system, AGC levelling, guide vocal, mic inputs
- Cloud — QUP Cloud connection, venue registration and status, queuing from phones
- Hotkeys — The keyboard shortcuts, how to change one, global hotkeys and the media keys
- Kiosk — Party, Patron or Database mode, kiosk options, paid system, ID cards, registered kiosks
- Kiosk Security — Kiosk and bar codes, the certificate, pairing kiosks and bar terminals, bartender PIN, phone requests, display-name filter
- Scroller — The Up Next strip on the singer screen, the cloud QR code, the countdown timer and on-screen messages
- Lyrics — How LRC and MIDI lyrics look on the singer screen: layout, colours, sweep and effects
- Accessibility — Screen reader support on Linux; High Contrast and text size on Windows
- Skin & Layout — Colour skins, bitmap skin packs, list font size, where window layout lives now
- Bribes — Bribe cost rules, what a bribe may jump, the bribe simulator
- Song Purchases — Let singers buy a song the venue doesn't have from the kiosk, paid from their credits
- Simulation — Night simulation, session playback and logs
- Karaoke Maker — Optional plugin (Plugin Browser). Tool paths, hardware acceleration, YouTube cookies, AI models
- LRC Lyrics — MP3+LRC karaoke: .lrc lyrics on the singer screen, CDG preference, text encoding
- Music Video Backgrounds — Optional plugin (Plugin Browser). A matching music video, dimmed, behind CDG lyrics
- OBS Recording — Automatic per-singer recording through OBS Studio, scene switching, lower third
- SongShop — Optional plugin (Plugin Browser). Party Tyme login, saved card, download folder, lock
- Discord Party — Run your Discord karaoke room: auto-mute, on-stage role, missing-singer paging
- MIDI Karaoke — Optional plugin (Plugin Browser). .mid/.kar playback, SoundFont banks, per-song instrument mixer
- AutoFiller — Optional plugin (Plugin Browser). Automatic queue top-up from your filler library, genres or playlists
- Genre Tagger — Optional plugin (Plugin Browser). Fill in missing genres across your library, offline BPM detection
- Internet Radio — Thousands of stations as background music
- MilkDrop (projectM) — Music-reactive MilkDrop visuals behind the lyrics: preset packs, cycling, playlists
- Metadata Editor — Fix artist, title, album, genre and year on individual songs
- Audio Visualizer — A music-reactive background behind the lyrics that keeps the words readable
- Plugin Manager — Turn plugins on and off, the background visualization, the Plugin Browser, Safe Mode, where plugin data lives
Updated on version 2.37.3, November 13, 2026