Section 03 · Shared audio

Music List Configuration

A music list is a collection of audio files organized for synchronized selection within a room. A basic list requires only mood folders and supported audio files.

Directory Structure

A music list contains one or more mood folders. Each mood-folder name becomes a category in the music controls. Unless metadata specifies another title, the audio filename without its extension becomes the displayed track title.

content/music/default/
  Relaxing and Calm/
    [999] Eternitybox.wav
    [AAI2] Reminiscence.wav
  Suspense/
    [999] Imaginary.wav
    [AAI2] Announce the Truth 2011.wav

Place .wav, .ogg, or .mp3 files inside the mood folders. Assign category names that describe their intended use, such as Courtroom, Chase, or Somber.

Caution: Blarp ignores audio files located directly in the root of the music-list folder. Every track must be placed within a mood folder.

Installation and Server Selection

Install the completed list folder under content/music/. Press Ctrl+Shift+R, or select File → Refresh, to load the list without restarting the client.

The server selects the active music-list identifier. For example, a server started with the following option selects content/music/default/:

--music default

If the option is omitted, the server also requests the list with the identifier default.

Note: Each connected client must have a local copy of the active list. The server transmits the selected track identifier but does not transmit the audio file. A client without the list may display the selection without producing sound.

Playback Operation

A track selection is synchronized with all users in the room. Mute, pause, repeat, and seek controls operate locally; changing one of these controls does not alter playback for other users.

The room retains its most recent track selection. A user who enters the room after playback has started receives the current selection automatically.

music.json Metadata

The music.json file is optional. It changes descriptive information but does not determine which tracks are available. An audio file that is not listed in music.json remains available under its filename.

{
  "schema": 1,
  "id": "default",
  "name": "Default Music List",
  "tracks": {
    "Relaxing and Calm/[999] Eternitybox.wav": {
      "title": "Eternitybox",
      "source": "999: Nine Hours, Nine Persons, Nine Doors"
    },
    "Suspense/[999] Imaginary.wav": {
      "title": "Imaginary"
    }
  }
}
  • Each key is the exact path within the list, including the mood folder, filename, and extension.
  • title replaces the filename in the displayed list.
  • source records the game, album, composer, or other source of the audio.
  • info replaces the complete scrolling now-playing description.

The search function checks the title, source, and mood without regard to capitalization. Consistent values in the source field permit users to locate tracks from the same work.

Room Ambience

Background ambience is defined separately in room.json. It plays when no music-list track is selected and is not included in the music list.

Troubleshooting

Use the following conditions to isolate common configuration faults.

  • One track is not displayed: Verify that the file is located inside a mood folder and uses the WAV, OGG, or MP3 format.
  • The complete list is not displayed: Verify that the server selected the correct music-list identifier.
  • Playback is silent on one client: Verify that the active list is installed on that client.
  • Metadata is not applied: Verify that the metadata key exactly matches the mood folder, filename, and extension.

Caution: Use only audio that may be distributed for the intended purpose. Record the source in music.json and comply with the permissions associated with the work.