Formats/Audio

2012-11-14T22:58:18Z

Knova: /* Sound replacement progress */

==Licensing==

The following licenses are suitable for music and sounds:

* [http://creativecommons.org/licenses/sampling+/1.0/ CC-Sampling Plus]
* [http://creativecommons.org/licenses/by-sa/2.0 CC-BY-SA] (v2.0 or newer)

==Sound replacement progress==

Please see the [[Sound_Progress|full article]].

KNova was given access by cron to the sound/music dropbox, so he is slowly working on replacing all the sounds.

==Configuration files==

===Buildables===

There are 14 animations (animation types) per buildable (buildable type): ''construct1'', ''construct2'', ''idle1'', ''idle2'', ''idle3'', ''attack1'', ''attack2'', ''spawn1'', ''spawn2'', ''pain1'', ''pain2'', ''destroy1'', ''destroy2'', and ''destroyed''. Note that not all of these are used for a given buildable and the spawn2 and destroy2 sounds are never used; see the [[Exporting_Models#MD5_4|model exporting guide]] for more information. Each buildable has a sound configuration file, located at ''sound/buildables/<var><buildable></var>/sound.cfg'', that describes two properties for each buildable animation:
* whether a unique (buildable-specific) sound is associated with the given buildable animation, and
* whether the animation's sound is to be played in a loop.
Such a file should contain a 1 for a yes answer and a 0 for a no answer, for the above 2 questions, in the given order, for each buildable animation. Technically, this means that the file should contain 28 integers (2 per animation). However, by convention, 1 line is used for each animation, and comments are added for guidance about which animation a pair of numbers refers to.

{{Note|header = Engine Developer Note|disregardby = sound designers|content =

Filenames for sounds for buildable animations are enumerated in the <code>cg_buildableSoundNames</code> array in [https://github.com/Unvanquished/Unvanquished/blob/master/src/gamelogic/game/bg_public.h src/gamelogic/game/bg_public.h]. Buildable sound files are loaded in CG_InitBuildables() in [https://github.com/Unvanquished/Unvanquished/blob/master/src/gamelogic/cgame/cg_buildable.c src/gamelogic/cgame/cg_buildable.c].
}}

So each line in a buildable sound configuration file is formatted as follows:
<var><unique></var> <var><loop></var> //<var><filename></var>

An example of a full buildable sound configuration file is:
<pre>
1 0 //construct1.wav
0 0 //construct2.wav
1 1 //idle1.wav
0 0 //idle2.wav
0 0 //idle3.wav
0 0 //attack1.wav
0 0 //attack2.wav
0 0 //spawn1.wav
0 0 //spawn2.wav
0 0 //pain1.wav
0 0 //pain2.wav
1 0 //destroy1.wav
1 0 //destroy2.wav
0 0 //destroyed.wav
</pre>
Again, the comments only help human readers, and are indifferent to the game (do not reorder the lines!).

If, for a particular buildable, a unique sound is associated with a particular animation, then the game will look for the buildable-specific ''sound/buildables/<var><buildable></var>/<var><animation></var>.wav'' audio file, and otherwise (and also if the buildable-specific audio file cannot be found) the game will use the default ''sound/buildables/<var>team</var>/<var><animation></var>.wav'' (based on the team of the buildable).

==Sound filenames==

A list of all the sound filenames currently in use is available on the [[Sound_Progress|sound progress]] page.

* The structure <code>cg_customSoundNames</code> in [https://github.com/Unvanquished/Unvanquished/blob/master/src/gamelogic/cgame/cg_players.c src/gamelogic/cgame/cg_players.c] contains a list of some sounds.
* Sounds for weapons are controlled by the [[Exporting_Models#Weapons_2|weapon configuration file]].
* A number of sounds are loaded in <code>CG_RegisterSounds()</code> in [https://github.com/Unvanquished/Unvanquished/blob/master/src/gamelogic/cgame/cg_main.c src/gamelogic/cgame/cg_main.c].

Unvanquished - User contributions [en-gb]

Formats/Audio