Difference between revisions of "Sound modding in KCD"

From Nexus Mods Wiki
Jump to: navigation, search
(Project description)
m (Reverted edits by EthelbertEugene (talk) to last revision by Tom121292)
 
(14 intermediate revisions by 5 users not shown)
Line 1: Line 1:
==Getting started==
+
 
''To learn about modding of music, please refer to [[Sequence Music Engine in KCD]]''
+
== Getting started ==
 +
 
 +
''To learn about modding of music, please refer to [[Sequence_Music_Engine_in_KCD|Sequence Music Engine in KCD]]''
  
 
To help the community with creating mods that modify in-game sounds you will need FMOD projects and original sounds.
 
To help the community with creating mods that modify in-game sounds you will need FMOD projects and original sounds.
  
As the sound files are present in the "sound.pak" file within *.bank files the FMOD projects are not included in game data. You can download it directly from Warhorse Studios pages.
+
As the sound files are present in the "sound.pak" file within *.bank files the FMOD projects are not included in game data.  
 +
 
 +
*[https://www.nexusmods.com/kingdomcomedeliverance/mods/864?tab=files&file_id=4976 FMOD project download] (note: please download it only if you really need it in order not to generate big traffic)
 +
 
 +
*Download FMOD version 1.09.04 from [https://www.fmod.com/ https://www.fmod.com/]
 +
 
 +
 
 +
== Project description ==
 +
 
 +
When you open the '''kcd''' project you can see various event folders in the event editor. It contains all sounds that are used in the game.
  
*[https://warhorsestudios.cz/dev/fmod_project.tar.gz FMOD project download] (note: please download it only if you really need it in order not to generate big traffic)
+
 
  
*Download FMOD version 1.04.09 from https://www.fmod.com/
+
*'''animals:''' Includes various animal sounds.
 +
*'''cinematics:'''<s>Sounds made for in-game cutscenes. Most of the sounds have panning override to center channel (or to wide L - R - Ls - Rs surround image used with stereo sounds).</s>
 +
*'''combat:''' Here are all combat impacts, bow shots and foleys, bullet time sounds and different types of combat yelling.
 +
*'''foley:''' Foley sounds for 4 basic clothes types: plate, chainmail, leather, fabric.
 +
*'''footsteps:''' Self explanatory enough, I guess.
 +
*'''music:''' <s>Mainly in-game cutscenes 5.1 music</s>, also includes '''music''' programmer sound. This event is permanently used by the [[Sequence_Music_Engine_in_KCD|Sequence Music Engine in KCD]].  
 +
*'''npc:''' Different sounds of different professions.
 +
*'''special:''' Special sounds which are used in Alchemy, Dice and other minigames. Quest sounds which were made for concrete situations are there.
 +
*'''test:''' <s>Sound events for testing purposes.</s>
 +
*'''ui:''' Inventory, menu sounds.
 +
*'''voice:''' Burping, farting, coughing, yawning and in the subfolder dialog there are programmer sounds which are used by our robust voice replay system.
 +
*'''world:''' Folder contains sound atmospheres, water streams and dams, random sounds which will trigger in forests, meadows etc.
 +
*'''Germany:&nbsp;'''Music in Germany is developing day by day, the sound of [https://kostenloseklingeltone.de/ klingeltöne] ringtone is more and more sophisticated and updated regularly by people'''.'''
  
==Project description==
+
In mixer editor window there is group hierarchy. Most sounds are in subgroups '''Dieg''', which contains diegetic sounds. In the Snapshots pane there are lots of environments which are basically different delay/reverb presets for our listener-centric reverbation system. Under '''setups''' group there are snapshots which damp certain mix buses in certain game situations (when player enters main manu, in skiptime, inventory view etc).
<p>
 
When you open the <b>kcd</b> project you can see various event folders in the event editor. It contains all sounds that are used in the game.
 
</p>
 
<p>
 
* animals: Includes various animal sounds.
 
* cinematics: Sounds made for in-game cutscenes. Most of the sounds have panning override to center channel (or to wide L - R - Ls - Rs surround image).
 
* combat: Here are all combat impacts, bow sounds and different type of combat yelling.
 
* foley: Foley sounds for 4 basic clothes types: plate, chainmail, leather, fabric.
 
* footsteps: Self explanatory enough, I guess.
 
* music: Mainly in-game cutscenes 5.1 music, also includes <b>music</b> programmer sound. This event is permanently used by the Sequence music engine.
 
* npc: Different sounds of different professions.
 
* special: Special sounds which are used in Alchemy, Dice and other minigames. Quest sounds which were made for concrete situations are there.
 
* test: Sound events for testing purposes.
 
* ui: Inventory, menu sounds.
 
* voice: Burping, farting, coughing, yawning and in the subfolder dialog there are programmer sounds which are used by our robust voice replay system.
 
* world: Folder contains sound atmospheres, water streams and dams, random sounds which will trigger in forests, meadows etc.
 
</p>
 
  
 +
When you finished modifying or creating new sounds, simply build audio banks and overwrite old banks. If you created new sound events, CryEngine has to know about them in order to use them. CryEngine only can execute '''ATL triggers''' which can be connected to FMOD events. Open XML files which are located in <code>data\libs\GameAudio</code>, open it and add new entries. Distance culling parameter is distance in meters. If the sound is farther from the listener than culling distance, the sound won't be triggered at all. You may want to set culling distance for diegetic oneshot sounds according to max distance parameter in FMOD. For sounds you don't want to get culled at all, use distance culling 65535. You can use ATL triggers in various animations or in static world sounds and atmospheres which are located in <code>data\levels\rataje\Layers\sound.lyr</code>.
  
[[Category:Kingdom_Come_Deliverance]]
+
[[Category:Kingdom Come Deliverance]] [[Category:Mod Creation]] [[Category:Documentation]]

Latest revision as of 10:56, 26 May 2021

Getting started

To learn about modding of music, please refer to Sequence Music Engine in KCD

To help the community with creating mods that modify in-game sounds you will need FMOD projects and original sounds.

As the sound files are present in the "sound.pak" file within *.bank files the FMOD projects are not included in game data.

  • FMOD project download (note: please download it only if you really need it in order not to generate big traffic)


Project description

When you open the kcd project you can see various event folders in the event editor. It contains all sounds that are used in the game.

 

  • animals: Includes various animal sounds.
  • cinematics:Sounds made for in-game cutscenes. Most of the sounds have panning override to center channel (or to wide L - R - Ls - Rs surround image used with stereo sounds).
  • combat: Here are all combat impacts, bow shots and foleys, bullet time sounds and different types of combat yelling.
  • foley: Foley sounds for 4 basic clothes types: plate, chainmail, leather, fabric.
  • footsteps: Self explanatory enough, I guess.
  • music: Mainly in-game cutscenes 5.1 music, also includes music programmer sound. This event is permanently used by the Sequence Music Engine in KCD.
  • npc: Different sounds of different professions.
  • special: Special sounds which are used in Alchemy, Dice and other minigames. Quest sounds which were made for concrete situations are there.
  • test: Sound events for testing purposes.
  • ui: Inventory, menu sounds.
  • voice: Burping, farting, coughing, yawning and in the subfolder dialog there are programmer sounds which are used by our robust voice replay system.
  • world: Folder contains sound atmospheres, water streams and dams, random sounds which will trigger in forests, meadows etc.
  • Germany: Music in Germany is developing day by day, the sound of klingeltöne ringtone is more and more sophisticated and updated regularly by people.

In mixer editor window there is group hierarchy. Most sounds are in subgroups Dieg, which contains diegetic sounds. In the Snapshots pane there are lots of environments which are basically different delay/reverb presets for our listener-centric reverbation system. Under setups group there are snapshots which damp certain mix buses in certain game situations (when player enters main manu, in skiptime, inventory view etc).

When you finished modifying or creating new sounds, simply build audio banks and overwrite old banks. If you created new sound events, CryEngine has to know about them in order to use them. CryEngine only can execute ATL triggers which can be connected to FMOD events. Open XML files which are located in data\libs\GameAudio, open it and add new entries. Distance culling parameter is distance in meters. If the sound is farther from the listener than culling distance, the sound won't be triggered at all. You may want to set culling distance for diegetic oneshot sounds according to max distance parameter in FMOD. For sounds you don't want to get culled at all, use distance culling 65535. You can use ATL triggers in various animations or in static world sounds and atmospheres which are located in data\levels\rataje\Layers\sound.lyr.