> For the complete documentation index, see [llms.txt](https://nanoscripts.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://nanoscripts.gitbook.io/docs/scripts/nn_karaoke.md).
# nn\_karaoke
A full multiplayer karaoke lounge for your FiveM server. Players bring their own songs, step on stage, and the venue TVs light up each word in time with the music. The singer's voice carries across the room like a real PA, and the crowd rates them, tips them and cheers.
Songs are stored on and played from your own server — nothing streams from anywhere else. Players upload an MP3 or OGG in the **Song Studio**, and with **auto-sync** the lyrics are written down and timed for them in about a minute. They check them, publish, and the song joins the jukebox for everyone.
{% hint style="info" %}
**At a glance** — Resource: `nn_karaoke` · Author: NANO Scripts · Frameworks: QBox, QBCore, ESX (via community\_bridge) · Works with **any MLO** — venues are built in game.
{% endhint %}
#### Features
| Feature | What it does |
| -------------------------- | ------------------------------------------------------------------------------------------- |
| **Player songbook** | Players add the songs. The jukebox lists, searches and ranks them. |
| **Song Studio** | A web page opened from the jukebox: upload a song, check the lyrics, publish. |
| **Auto-sync** | Lyrics written down from the song and timed to the word. Optional — needs your license key. |
| **Lyrics from anywhere** | Read from the song file's tags, a `.lrc` file, or pasted text synced with the spacebar. |
| **Word-by-word lyrics** | On the venue TVs, plus a teleprompter for the singer. |
| **Synced for everyone** | One shared clock — everyone in the room is on the beat, including late arrivals. |
| **Positional sound** | Volume fades with distance from the stage and your speakers. |
| **Amplified microphone** | The singer is heard venue-wide over proximity chat. |
| **Song queue** | Per venue, auto-advancing, with limits you set. |
| **DJ booth** | Host the night: reorder, skip, kick, room volume, mic level, voice sync. |
| **Duets** | Up to four singers per song. Tips and scores are shared. |
| **Ratings & Hall of Fame** | The crowd votes 1–5, building a persistent leaderboard. |
| **Tips** | Tip the performer from the crowd. |
| **Mic poses & crowd FX** | Five stage poses, a spotlight, a Now Performing banner and `/cheer`. |
| **Venue creator** | Build venues anywhere in game. No coordinates, no config editing. |
| **Moderation** | Admins hide or delete any song from the Studio; `/nnk_flag` pulls the one on stage. |
| **5 languages** | English, French, Spanish, German, Polish. |
| **Streamer mode** | Any player can mute the music for themselves only. |
#### What you will need
| Dependency | Required | Why |
| ---------------------------------------------------------------------- | -------- | ---------------------------------------------------- |
| [**community\_bridge**](https://github.com/SinapsDev/community_bridge) | Yes | Framework support — money, notifications, targeting. |
| **pma-voice** | Yes | The amplified stage microphone. |
| **oxmysql** | Yes | Saves scores, venues and the songbook. |
| **ox\_lib** | Yes | Shared library. |
| **rpemotes-reborn** | No | Adds the stage mic poses. |
{% hint style="info" %}
Nothing to host: song files are stored in the resource's `songs/` folder, lyrics in your database. Your license key is only needed for auto-sync.
{% endhint %}
#### Common questions
Where do the songs come from?
Your players. At any jukebox, **Add a song** opens the Song Studio in their web browser; they upload an MP3 or OGG (15 MB by default) and it is in the jukebox a minute later. You decide who may upload — everyone, an ACE group, or admins only.
How are the lyrics kept in sync?
With auto-sync, our sync server writes the lyrics down from the song (or takes the ones in the file's tags) and times every word; the uploader reads along and fixes any misheard word. Without it, the uploader taps the spacebar as each line starts, or loads lyrics that are already synced (an `.lrc` file, or the song file's own tags). Either way the timing is made against that exact file, so it cannot drift from the music.
Do I have to host anything?
No. The Song Studio is served by your FiveM server itself, and the songs are played from it too. Auto-sync sends the song to our sync server to time the lyrics: only the timed lyrics come back, and the song is deleted as soon as the job ends.
Does it work with my MLO?
Yes. Venues are built in game by pointing at the world, so it works in any interior — or outdoors. You can also use TV screens already in your MLO.
What about copyright and streamers?
Players choose what they upload, so the songbook is your server's to moderate: limit uploads with `Config.Uploads.who`, and hide or delete songs from the Studio's **All songs** view. Streamers run `/nnk_streamer_mode on` once — the music is muted for them only.
Can players sing together?
Yes, up to four. Tips are split evenly and everyone is credited on the leaderboard.
#### What's next
**Installation** → **Building Your Venue** → **Adding Songs**.
#### Support
* **Discord:**