Skip to content
OpenTS Manual

Volume

Changed in 0.2.0

The share of full loudness a sound effect or a music track is played at.

Sound effect loudness

Specification — Sound effect loudness
Applies to
Sounds
File
SOUND.INI / SOUND01.INI
Section
[<Sound ID>]
Value
string
When omitted
1.0

Volume= sets how loud the sound plays, as a fraction of its sample’s recorded loudness. A value above 1 is read as a percentage, so 0.5 and 50 mean the same thing, and 1 and 100 are both full loudness. Volume=1.5 is therefore 1.5 percent. The value is held between silence and full loudness, so no sound plays louder than its sample.

Each play multiplies the value by two more factors, and the product is again held at full loudness:

  • the distance fade of a sound played at a place in the world, or the loudness the game asks for when the sound has no place;
  • the play’s random VShift= draw.

The SoundVolume option then scales every sound effect, and while it is at zero no sound effect starts. The one exception is the beep the voice volume slider plays outside a game, which follows VoiceVolume instead.

sound01.ini
[SCOLD8]
Priority=75
Volume=0.5

A Volume= in the [Defaults] section of SOUND.INI applies to every sound section that omits the key.

Track loudness

Specification — Track loudness
Applies to
Themes
File
THEME.INI + THEME01.INI
Section
[<Theme ID>]
Value
string
When omitted
1.0

Volume= sets how loud the music track plays, as a share of the level the ScoreVolume option gives every track. It uses the same scale as the music volume slider: Volume=0.5 with the slider at full sounds as loud as a track without the key with the slider at half. A value above 1 is read as a percentage, so 0.5 and 50 mean the same thing. The value is held between silence and full loudness, so no track plays louder than its file.

theme01.ini
[MYTHEME]
Name=Example theme
Volume=0.7

A value that is not a number is ignored, and the track plays at full loudness.

See also — Priority, MinVolume, VShift, SoundVolume, VoiceVolume, Sound, ScoreVolume

History

  1. Added0.2.0In development

    Play music tracks from WAV, OGG, FLAC and MP3 files, and set each track's file and loudness — themes

  2. Changed0.2.0In development

    Define sounds with the Yuri's Revenge SOUND.INI keys — sounds