Skip to content

Entrance Themes

Custom entrance themes must be placed in a directory named Themes inside your content pack. The only supported formats are MP3 (*.mp3 files) and Ogg Vorbis (.ogg files). Optionally, you may attach a JSON file with some additional settings such as length of the intro, volume adjustment etc.

JSON Parameters

You can provide optional parameters in a JSON file with the same name of the entrance theme. For example, if you have a theme named music.mp3, then the JSON file must have the filename music.json.

The following JSON contains all supported parameters with their default values:

1
2
3
4
5
6
7
8
9
{
    "Title": "",
    "Artist": "Unknown",
    "Tempo": 120.0,
    "VolumeGain": 0.0,
    "IntroDuration": 0.0,
    "LoopStart": 0.0,
    "LoopEnd": 0.0
}

The parameters work as follows:

  • Title: The title as displayed in the entrance theme selection in the Entrance menu. If left empty, the filename will be used.
  • Artist: The artist name. This is currently not displayed anywhere, but may be in the future.
  • Tempo: The tempo of the theme in beats per minute (BPM). This is planned to be used for light and other entrance effects in the future, so try and fill this info accurately for best results.
  • VolumeGain: The volume gain applied to the theme in decibel (dB). See Volume Notes for some extra information.
  • IntroDuration: The duration, in seconds, of the theme's intro. During the entrance, wrestlers will only come up from behind the curtain once the intro is over. When the theme is played after winning a match, or when a wrestler enters mid-match (e.g., a gauntlet or timed battle royal), the intro is skipped.
  • LoopStart: The time, in seconds, to jump back to when the LoopEnd time has been reached during playback.
  • LoopEnd: The time, in seconds, at which to jump back to LoopStart during playback. Leave this at zero to mark the very end of the theme.

Volume Notes

Try to make sure that your theme's volume roughly matches other themes. In particular, make sure it is not too loud!

Use a negative value (e.g., -1.5) to tune down the volume somewhat or positive values to tune it up if necessary. Note that decibel is on a logarithmic scale of perceived volume: a gain of +6 is double the volume, while a gain of -6 is half the volume.

Additional Notes

  • Filenames must have the .mp3 or .ogg extension (lowercase).
  • Accompanying JSON files must have the same file name but with a .json extension (e.g., music.json). If it does not exist, it is automatically generated on startup.

  • Audio files must not be larger than 10 mebibytes (10 MiB). Larger files are not imported.

  • If a theme is not being loaded, please check the logfile for any relevant messages regarding the file.