Changes

Jump to navigation Jump to search

Documentation/Engine/Sound

607 bytes added, 07:57, 9 July 2020
no edit summary
=== WARNING ! ===
'''The sound system and current pages are in 'work in progress' state.'''
We continuously update content of the site and the audio data structures.<br><br> 
=== FMOD® ===
The FMOD® system is now (from 1.37 version) used as a core sound engine in the game.<br>
The FMOD® Studio 2.00.07 version is currently in use.<br>
''See FMOD documentation ([http://www.fmod.comwww.fmod.com]) to better understand of the sound system.''
=== Sound and Sound Bank(s) ===
Each sound is represented by the sound '''Event'''. An Event is an instanceable sound unit of the FMOD Studio project.<br>
It is collection of the Events and Parameters used for the sound playing in the game.
=== Master Bank ===
Master Bank is primary sound bank of the sound system.<br>
'''Never change the Master Bank!'''<br>Only if you absolutely sure what you are doing and you are rewriting all the sounds of the game you can change it.
=== Sound definition ===
A common sound in game is the '''Event''' in the FMOD Studio project.<br>
The game use two ways how to define using of sound object:
# Direct '''sound id'''<br>"Sound id" i string in format "[bank filename]#[event name]".<br>[bank filename] is file of the bank relative to the game "base" folder.<br>[event name] is name of the event in the FMOD Studio project.<br>''Sample: "/sound/ui/ui.bank#click"''
# Sound reference file<br>Sound reference file is used as indirection for the sound specification.<br>It is simple path to the soundref file (''sample: "/sound/ui/ui_click.soundref"'').<br>Soundref file is text file (UTF-8) contents 'sound id' on the separate line at the format: source="[bank filename]#[event name]".<br>''Sample of content of the file "ui_click.soundref": source="/sound/ui/ui.bank#click"''<br> == Sound documentation == * [[Documentation/Engine/Sound/Mixer|Audio buses, routing and mixer]]* (WIP) Global parameters* [[Documentation/Engine/Sound/TruckEngine|Sounds - Truck Engine]]* (WIP) Sounds - Truck Retarder* (WIP) Sounds - Truck Effects* (WIP) Sounds - Truck Noise* (WIP) Sounds - Truck Interior* (WIP) Sounds - Tires* (WIP) Sounds - Collisions* (WIP) Sounds - Traffic* (WIP) 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