Changes

Jump to navigation Jump to search

Documentation/Engine/Sound

830 bytes added, 07:34, 14 December 2021
Sound documentation
The FMOD® system is now (from 1.37 version) used as a core sound engine in the game.<br>
The FMOD® Studio 2.0001.07 05 version is currently in use(from 1.39 version).
''See FMOD documentation ([http://www.fmod.com www.fmod.com]) to better understand of the sound system.''
The game uses two ways to define usage of sound object:
# Direct 'sound id':<br>"Sound id" is string in format "[bank filename]#[event name]". Where [bank filename] is file of the bank relative to the game "base" folder and [event name] is name of the event in the FMOD Studio project.<br>Example: ''"/sound/ui/ui.bank#click"''
# Sound reference file:<br>Sound reference file is used as link for the sound specification. It uses simple path to the soundref file (e.g. ''"/sound/ui/ui_click.soundref"'').  == Sound reference file == We prefer and we recommended to use sound reference file.* There are more possibilities to configure sound.* It is easier to change / modding individual sounds.  '''Sound reference file structure:''' Soundref file is text file (with UTF-8 encoding) and .* It contents 'sound id' on the separate line with following format: source="[bank filename]#[event name]".* There is possibility in the file to change 3D placement of the sound relative to the default position. Format is the separate line: "position_offset=-left/+right;-down/+up;-front/+back" (in meters).<br>Example of content of the file ''"ui_click.soundref": source="/sound/ui/ui.bank#click"''
== Sound documentation ==
* (WIP) Global parameters
* [[Documentation/Engine/Sound/TruckEngine|Sounds - Truck Engine]]
* (WIP) [[Documentation/Engine/Sound/TruckTransmission|Sounds - Truck Transmission and Retarder]]* [[Documentation/Engine/Sound/TruckChassis|Sounds - Truck Chassis]]* [[Documentation/Engine/Sound/TruckCabin|Sounds - Truck Cabin (WIPhorns and noises) ]]* [[Documentation/Engine/Sound/TruckCabinFiltering|Sounds - Truck EffectsCabin Filtering (in/out, windows)]]* (WIP) [[Documentation/Engine/Sound/TruckRemote|Sounds - Remote Truck Noise(multiplayer)]]
* (WIP) Sounds - Truck Interior
* (WIP) Sounds - Tires
* (WIP) Sounds - Collisions
* (WIP) Sounds - Traffic
* (WIP) [[Documentation/Engine/Sound/SoundWorld|Sounds - World]]
* (WIP) Sounds - Game UI and Music
* [[Documentation/Engine/Sound/Modding|Modding sounds]]
* [[Documentation/Engine/Sound/Downloads|Downloads (templates, samples)]]
255
edits

Navigation menu