255
edits
Changes
Jump to navigation
Jump to search
=== FMOD® ===
=== Sound and Sound Bank(s) ===
=== Master Bank ===
=== Sound definition ===
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>
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.''
Each sound is represented by the sound '''Event'''. An Event is an instanceable sound unit of the FMOD Studio project.<br>
All sounds/events are provided by sound banks. The final sound banks are builded by FMOD Studio.<br><br> FMOD Studio builds the "[bank name].bank" file for each bank in the sound project.<br>It is collection of the Events and Parameters used for the sound playing in the game.
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.
A common sound in game is the '''Event''' in the FMOD Studio project.<br>
Each object (bank, bus, event, parameter, etc.) used by FMOD system has unique identifier - '''GUID'''.<br>
# Use FMOD Studio menu command: File / Export GUIDs...
# There is new file GUIDS.txt in the "build" subfolder of the project main folder.
# The file has to be renamed to "[bank filename].guids" and has to be placed next to "bank" file.<br>This file is "dictionary" between names of the objects in the bank and their GUIDs. '''Sound definition'''<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)]]
