Music Settings
Config.music
Playlist
| Option | Default | Description |
|---|---|---|
tracks | 2 samples | Played in order and round again. Each entry is an online song link or an audio file under the ui folder. An empty list means no music and no player |
shuffle | false | A different order on every join |
Each track:
| Field | Required | Description |
|---|---|---|
source | Yes | An online song link, or a file such as 'media/music/song.mp3' |
title | No | Song name. Links use their own title, files their own tags |
artist | No | Artist name |
cover | No | A picture for the cover |
start | No | Second to start from |
lua
tracks = {
{ source = 'https://your-song-link' },
{ source = 'media/music/song.mp3', title = 'Name', artist = 'Who', cover = 'media/cover.jpg', start = 12 },
},
Playback
| Option | Default | Description |
|---|---|---|
volume | 50 | Starting volume, 0–100, until a player picks their own |
fadeIn | 3 | Seconds the music takes to rise out of silence as the screen opens, 0–15 |
startDelay | 1.2 | Seconds after the screen has finished coming in before the player starts, 0–10. Starting it costs the browser a moment's work, so it waits until nothing on the screen is moving; a shorter wait brings the music in sooner, at the risk of the menu's arrival stuttering on a slow machine |
Player
| Option | Default | Description |
|---|---|---|
showPlayer | true | The record button in the menu that opens the player. Off still plays the music |
nowPlaying | true | Name the song in the bottom-right corner whenever a new one starts |
nowPlayingSeconds | 5.5 | Seconds that note stays, 2–15 |
playerLinks | true | Players may paste their own song links. They stay on that player's computer |
maxPlayerLinks | 20 | Most songs one player can add, 1–50 |
playKey | 'Space' | Key that pauses and resumes the music, e.g. 'Space' or 'P'. Empty turns it off |
remember | true | Remember each player's volume, mute, pause and added songs for their next join |