Complete User Guide
Everything you need to know about Karaoke Your Way
Karaoke Your Way - Complete User Guide
đ€ Welcome to Karaoke Your Way
Karaoke Your Way is a comprehensive platform for managing professional karaoke events. Whether you're an event organizer, performer, or audience member, this guide will help you make the most of all available features.
đ Table of Contents
- Getting Started
- Event Organizer Guide
- Performer Guide
- Audience Guide
- AI Assist Tools
- Trivia Games
- Advanced Features
- Troubleshooting
đ Getting Started
Creating Your Account
- Visit the homepage and click "Get Started"
- Sign up with Google OAuth (recommended) or email
- Complete your profile setup
- Create or join an organization
Understanding Roles
- Event Organizer: Creates events, manages libraries, oversees the show
- Performer: Manages their performance queue, accesses song links
- Audience Member: Requests songs, votes, follows the live show
đ„ Event Organizer Guide
Creating Your First Event
Step 1: Set Up Your Organization
- Go to Dashboard â Settings
- Click "Create Organization" if you don't have one
- Add organization details and invite team members
Step 2: Create Song Libraries
-
Navigate to Libraries â Create New Library
-
Add library details:
- Name: Descriptive name (e.g., "80s Hits", "Pop Classics")
- Description: Brief description of the library
- Cover Image: Upload a library cover image (optional)
- Visibility: Libraries remain private to your organization; invite teammates to share access
-
Add Songs to Your Library:
- Manual Entry: Click "Add Song" and fill in details
- Bulk Import: Use Excel/CSV import for large libraries
- Song Details:
- Title, Artist, Album, Genre, Language
- Multiple song links (YouTube, Spotify, SoundCloud, Apple Music)
- Singer assignments and preferences
Step 3: Create Your Event
-
Go to Events â Create New Event
-
Fill in event details:
- Event Name: Clear, descriptive name
- Date & Time: When the event will take place
- Location: Venue or virtual location
- Description: Event details and instructions
- Live Stream URL: For remote audiences (optional)
-
Set Up Event Sections:
- Create sections (e.g., "Solo", "Duets", "Group")
- Set section order and timing
- After the event is created, open it and use the Import Songs panel to add music to each section
Adding Songs to Event Sections
Once your event exists, each section has its own snapshot library. Add music using the Import Songs panel on the event detail page:
- Click Import Songs in the right-hand panel (collapses when youâre not using it).
- Search across the entire catalog or filter by album, artist, singer, language, year range, or karaoke availability.
- Toggle Has Karaoke or Is Duet to target the exact tracks you need for the show.
- Preview paginated results, multi-select songs, and choose Add Selectedâduplicates are skipped automatically.
- Close the panel when finished; you can reopen it anytime to continue curating the section library.
Advanced Queue Management
Song-Level Queue System
The platform now supports individual song management within each section:
-
Access Queue Management:
- Go to your event â Select a section
- Click "Manage Queue" button
-
Queue Features:
- Drag & Drop Reordering: Click and drag songs to reorder
- Status Management: Mark songs as Pending, Current, Completed, or Skipped
- Visual Indicators: Color-coded status badges
- Pagination: Handles large queues (50+ songs) efficiently
-
Queue Workflow:
- Songs start as "Pending" (yellow badge)
- Mark as "Current" when performing (blue badge)
- Mark as "Completed" when finished (green badge)
- Songs disappear from performer view after completion
- Access "All Songs" section to replay completed songs
Library Image Management
-
Upload Library Images:
- Go to Library â Edit â Image Manager
- Upload cover images (max 2MB, JPG/PNG)
- Images are automatically resized and optimized
-
Reuse Images:
- Click "Reuse Image" to select from existing organization images
- Saves storage and maintains consistency
Running Your Event
Pre-Event Setup
-
Test All Systems:
- Verify song links work
- Test queue management
- Check live stream (if applicable)
-
Prepare Your Team:
- Ensure performers have access
- Share event link with audience
- Brief team on procedures
During the Event
-
Monitor Performance Queue:
- Watch for song requests
- Manage queue order as needed
- Update song statuses
-
Audience Engagement:
- Monitor song requests and votes
- Respond to audience feedback
- Keep the show flowing smoothly
Desktop Karaoke Player (Starter & Pro)
The desktop player lets you send karaoke and original tracks to native windows on external displays while keeping the web app as your control surface.
-
Install & Launch
- Download the installer from Dashboard â Downloads (Starter or Pro plan required)
- Launch the app; it opens two persistent windows labelled Original and Karaoke
- Arrange the windows on the correct displays, mute the original and unmute the karaoke window onceâthese preferences stick
- If your browser or operating system warns that the download âmight be unsafe,â review the checksum posted beside the installer and continueâthis alert appears because unsigned Electron apps have low reputation, not because the file is malicious
-
Connect from the Web App
- In PopNGo or Performer view, click Connect Desktop Player; the badge confirms the connection status
- The Play button sends both links, while quick-launch buttons route karaoke-only tracks
- The Performer view includes a Play original in Player toggle so you can decide whether the original video joins the mixer
-
During the Show
- Use End Performance to stop playback without closing or moving the desktop windows
- Switching songs reuses the same windows, preserving fullscreen positioning and mute states
- If the desktop player is offline, the system simply relies on normal browser popups/tabs for each song
-
Troubleshooting
- Ensure the desktop app and browser are on the same network
- The connection badge turns red if the local server canât be reachedârestart the desktop app if needed
- Autoplay is disabled by design; press play on the YouTube controls after arranging the windows the first time
- On macOS, right-click the app and choose Open the first time to bypass Gatekeeper; on Windows, select More info â Run anyway if SmartScreen highlights the installer
Local File Playback Support
Karaoke Your Way supports playing video files stored on your local computer, making it perfect for venues with their own video libraries.
Setting Up Local Files
-
Configure Base Path:
- Go to Dashboard â Settings â Preferences
- Find the Local Files Base Path field
- Enter the base directory where your video files are stored (e.g.,
C:\karaokeyourway\librariesor/home/user/karaoke/videos) - Click Save Preferences
-
Adding Local File Links to Songs:
- When adding or editing songs, you can use:
- Full paths:
C:\karaokeyourway\libraries\song.mp4 - Relative paths:
song.mp4(relative to your base path) - file:// URLs:
file:///C:/karaokeyourway/libraries/song.mp4
- Full paths:
- The system automatically resolves relative paths using your configured base path
- When adding or editing songs, you can use:
Using Local Files
-
With Desktop Player (Recommended):
- Connect the desktop player as described above
- Click play on any song with a local file link
- The desktop player will load and play the local video file
- Works seamlessly with both karaoke and original tracks
-
Browser Limitations:
- Browsers cannot directly open
file://URLs for security reasons - If the desktop player is not connected, you'll see a message explaining that local files require the desktop player
- Always use the desktop player for local file playback
- Browsers cannot directly open
-
Library Page Support:
- The library page now supports Electron player integration
- When viewing libraries, you can play local files directly if the desktop player is connected
- The connection status is shown with a badge indicator
Best Practices
- Organize Your Files: Keep video files in a consistent directory structure
- Use Relative Paths: Store just the filename (e.g.,
song.mp4) and set the base path in preferences - Test First: Verify local file playback works before your event
- File Formats: Supported formats include MP4, WebM, and other formats supported by your system's video player
- Network Drives: You can use UNC paths (e.g.,
\\server\share\video.mp4) for network-stored files
đ€ AI Assist Tools
Enabling the Co-Pilots
- Navigate to Dashboard â Settings â AI Assist (owner role required)
- Choose OpenAI (current supported provider) and paste your API key
- Optionally set a custom model (
gpt-4o-miniis the default) or base URL (for Azure OpenAI endpoints) - Click Enable AI planner â billing and usage stay entirely in your OpenAI account
Tip: If you remove your key, the AI buttons gracefully fall back to the manual workflows so shows continue uninterrupted.
AI Event Planner
- Available from Dashboard â Events â Plan with AI
- Chat about the venue, crowd size, languages, duet mix, or downtime blocks
- The assistant only uses songs from the libraries you select; it never invents titles
- When the outline looks good, click Create event to save sections, queues, and snapshot libraries
- Switch back to manual editing at any timeâAI output is simply a starting point
PopNGo Filter Copilot
- On the PopNGo page, click Ask AI to suggest filters, describe the vibe, and the assistant will:
- Recommend languages, duet mix, karaoke-only toggles, and featured libraries
- Prefill the filter form and reload the results instantly
- Perfect for last-minute jam sessions when you know the mood but donât want to tweak every dropdown
Best Practices & Safety
- Bring Your Own Key: We never proxy or log prompt content beyond the active request; disable AI Assist if you no longer want requests sent off platform
- Quota Awareness: If OpenAI returns an âinsufficient_quotaâ error, set a spending limit or switch modelsâKaraoke Your Way surfaces clear toasts/logs
- Library Grounding: Event Planner and PopNGo AI both respect the library selections you make, ensuring the recommendations are compliant with your catalog
- Manual Overrides: Any AI-applied filters or sections can be edited, cleared, or replaced just like standard workflows
đź Trivia Games
Bring high-energy breaks to your shows with trivia that pulls from the same PopNGo-ready metadata.
Who Can Use Trivia?
- Available on Starter and Pro plans (the Games nav link appears once you have an active organization).
- Trivia sessions are completely separate from live performances, so you can run them during intermissions without affecting queues or sections.
Launching a Game
- Go to Dashboard â Games.
- Click New Trivia Game. The host console opens instantly with default PopNGo-style filters.
- Customize filters with the compact icon buttons:
- Duets / Karaoke switches cycle through Any â Yes â No
- Languages, singers, genre inputs accept comma-separated lists
- Library pickers let you spotlight private or public libraries (with search and multi-select)
- Press Save Filters to persist them to the session, then tap Draft Question.
Host Console Controls
- Icon Bar: Draft (
Shuffle), Start (Play), Lock (Lock), Reveal (Eye), and Auto Cycle (Refresh) actions stay within thumb reach. - Auto Mode: Enable pacing to automatically lock answers after
Answer Lockseconds and reveal afterQuestion Duration. Saved values sync across browsers. - QR Block: Each game gets a shareable URL and QR. Copy the link for chats or print the code for signage.
- Leaderboard: Always-on scoreboard shows top players with point totals.
- History: When you end a game, the winnerâs name/score is appended to the organization history (we keep the last 10 winners; oldest entries drop off automatically).
Audience Experience
- Players scan the QR or visit
/games/trivia/<CODE>. - They enter a nickname (stored locally so reconnecting is instant) and tap answers on mobile-friendly buttons.
- The page locks their selection, shows reveal messages, and displays the top-five leaderboard for bragging rights.
Status Board
- Share
/games/trivia/<CODE>/statuson stage TVs or lobby displays. - Shows the current prompt, reveal text, and a rolling list of the top 10 playersâno login required.
Tips
- Draft a few questions before switching on Auto mode; the system auto-locks and auto-reveals based on the saved timers.
- Use the library filters to theme games (e.g., âBollywood Duets with Karaoke Linksâ) without touching your performance sets.
- Because trivia is disconnected from events, you can keep the host console open in one tab while still running your show elsewhere.
đ€ Performer Guide
Accessing Your Performance Interface
Joining an Event
-
Get Event Access:
- Receive event link from organizer
- Sign in with your account
- Navigate to the event
-
Performance Dashboard:
- View your assigned sections
- See current queue status
- Access song management tools
- Check the desktop player connection badge and toggle whether the original track should be routed to the player
Queue Management
Understanding the Queue
- Performance Queue: Shows songs in order, filtered by status
- All Songs: Complete library access for replays
- Status Indicators:
- đĄ Pending: Waiting to be performed
- đ” Current: Currently performing (shows "NOW")
- đą Completed: Finished performing
- â« Skipped: Skipped or removed
Managing Your Queue
-
Reorder Songs:
- Drag and drop songs to change order
- Use the queue management page for detailed control
- Changes save automatically
-
Status Management:
- Click "Play" to mark as Current
- Click "Complete" when finished
- Use "Skip" for songs you don't want to perform
-
Song Access:
- Click song links to send them to the connected desktop player (or a standard browser popup if no player is connected)
- Use the quick-launch icons to choose karaoke-only or original links; the Play original in Player toggle controls whether the original track is routed
- With the desktop player connected, the native windows stay put; without it, expect the browser to spawn a fresh popup/tab for each song
Desktop Player & Popup System
Desktop Player Workflow
- Dual Windows: The app opens dedicated Karaoke and Original windows that stay open across songs and performances
- Persistent Controls: Your mute/fullscreen selections stick; you only need to set them once per show
- Remote Commands: Play buttons in PopNGo/Performer view instantly retarget the desktop windowsâno alt-tabbing
- Original Track Toggle: Decide per performance whether the original track goes to the player via the on-screen toggle
Popup Fallback
- If the desktop player is unavailable, the platform lets the browser handle each song launch, typically opening a new popup window or tab
- Positioning, reuse, and mute state are controlled entirely by the browser; some browsers open a new window every time
- Allow popups for karaokeyourway.com if you rely on this fallback; otherwise the link will appear in a new tab
Performance Workflow
Typical Performance Flow
- Check Queue: Review upcoming songs
- Start Song: Click "Play" â mark as Current
- Open Link: Click song link â video opens in the desktop player (or a browser popup/tab if not connected)
- Perform: Sing using the desktop player windows; if youâre using the browser fallback, move/resize the popup as needed for that song
- Complete: Click "Complete" â song disappears from queue
- Next Song: Repeat for next song
Replaying Songs
- Completed Songs: Access via "All Songs" section
- Replay Button: Click "Replay" to perform again
- Queue Addition: Can add back to queue if needed
đ„ Audience Guide
Joining an Event
No Account Required
- Click the public event link shared by organizer
- Enter your display name (appears on requests)
- Start requesting songs immediately
Requesting Songs
How to Request
- Browse Library: Use the song browser to find songs
- Search: Use search bar to find specific songs
- Request: Click "Request Song" button
- Vote: Vote on other audience requests
Request Management
- Your Requests: See all your submitted requests
- Voting: Vote on requests from other audience members
- Status: Track if your request was accepted
Live Event Experience
Real-Time Updates
- Live Setlist: See currently playing and upcoming songs
- Coming Up Next: Preview next 3 songs in queue
- Auto-Refresh: Page updates automatically when sections change
- Status Indicators: See if event is Live, Upcoming, or Ended
Event Information
- Event Details: Date, time, location
- Live Stream: Access live stream if available
- Organization Info: See who's hosting the event
Mobile Experience
- Responsive Design: Works on all devices
- Touch-Friendly: Easy to use on phones and tablets
- Fast Loading: Optimized for mobile networks
⥠Advanced Features
Search Functionality
Library Search
- Multi-Field Search: Search across title, artist, album, genre, language, singers
- Real-Time Results: Instant filtering as you type
- Case-Insensitive: Works regardless of capitalization
- Partial Matching: Find songs with partial text matches
Using Search
- Library Pages: Use search bar at top of song lists
- Type Query: Enter any part of song information
- View Results: See filtered results instantly
- Clear Search: Click X to reset search
Import Songs Panel
Filterable Song Browser
- Collapsible Panel: Expand it when you need to add songs, collapse it to keep focus on the library list
- Deep Filters: Combine search with album, artist, singer, language, year range, Has Karaoke, and Is Duet filters
- Smart Pagination: Browse large result sets without freezing the pageâideal for our 100k+ song catalog
- Bulk Actions: Multi-select rows, preview totals, and add everything in a single click; duplicates are automatically skipped
- Live Feedback: Progress toasts confirm how many songs were added to the section snapshot library
Organization Management
Multi-Organization Support
- Create Organizations: Set up multiple organizations
- Role Management: Owner, Admin, Member roles
- Cross-Organization Sharing: Share libraries between organizations
- User Management: Invite and manage team members
Library Access
- Private by Default: Libraries stay within your organization; invite members or performers to collaborate
- Section Snapshots: Each event section maintains its own snapshot library so performance changes never alter the source catalog
- Copy Libraries: Duplicate libraries within your organization to create themed sets without rebuilding from scratch
Performance Analytics
Event Tracking
- Song Performance: Track which songs are performed
- Request Analytics: See most requested songs
- Audience Engagement: Monitor voting and participation
- Event Success: Measure event completion rates
đ§ Troubleshooting
Common Issues
Song Links Not Working
- Check URL: Verify the link is correct and accessible
- Try Different Link: Use alternative song links if available
- Browser Issues: Try different browser or clear cache
Queue Not Updating
- Refresh Page: Reload the page to get latest updates
- Check Permissions: Ensure you have proper access
- Contact Organizer: Ask organizer to check settings
Desktop Player Not Connecting
- Same Network: Make sure the desktop app and browser are on the same Wi-Fi/Ethernet network
- App Running: Verify the desktop player is open (look for the tray icon and the two video windows)
- Connection Badge: The PopNGo/Performer badge turns red if the link is lostâclick Reconnect or restart the app
- Firewall: Allow the local server on port 3001 if Windows Defender prompts for access
Popup Windows Not Opening
- Browser Settings: Allow popups for karaokeyourway.com when not using the desktop player
- Try New Tab: The system falls back to opening new tabs if popups remain blocked
- Browser Compatibility: Try a different browser if the popup keeps getting suppressed
Performance Issues
- Large Libraries: Use pagination for better performance
- Network Issues: Check internet connection
- Browser Cache: Clear browser cache and cookies
Getting Help
Support Resources
- Help Center: Comprehensive guides and FAQs
- User Guide: Detailed feature documentation
- Community: GitHub repository for bug reports
Contact Support
- Email: support@karaokeyourway.com
- GitHub Issues: Report bugs and request features
- Documentation: Check help files for solutions
đŻ Best Practices
For Organizers
- Test Everything: Verify all systems before events
- Prepare Libraries: Organize songs by genre, difficulty, or theme
- Train Team: Ensure performers know how to use the system
- Monitor Engagement: Watch audience participation and adjust
For Performers
- Plan Ahead: Review queue and prepare songs
- Position Player Windows: Arrange the desktop player windows for clear sightlines; without the desktop app, be ready to adjust each browser popup as it opens
- Update Status: Mark songs as completed to keep queue current
- Practice Workflow: Get comfortable with the interface before performing
For Audience
- Request Early: Submit requests early for better chances
- Vote Actively: Help prioritize popular requests
- Follow Guidelines: Respect event rules and etiquette
- Stay Engaged: Participate in voting and requests
đ± Mobile Tips
Mobile Optimization
- Portrait Mode: Best experience in portrait orientation
- Stable Connection: Ensure good internet connection
- Browser Choice: Use modern browsers (Chrome, Safari, Firefox)
- Touch Gestures: Use touch-friendly interface elements
Mobile-Specific Features
- Responsive Design: Interface adapts to screen size
- Touch Navigation: Easy-to-tap buttons and links
- Mobile Search: Optimized search experience
- Quick Actions: Streamlined mobile workflows
This guide covers all current features of Karaoke Your Way. For the latest updates and new features, check the help center regularly.
Last Updated: December 2024
Version: 2.2