author Wuzzy
Sat, 15 Sep 2018 03:01:21 +0100
changeset 1564 d7ffa0f2e78e
parent 1249 e169ba5aeb07
child 1672 41dc5e7910c0
permissions -rw-r--r--
Voicepacks: Add recommended sample rate

#summary Short information about the structure and creation of voicepacks
= Voicepacks =
== Introduction ==
Voicepacks are collections of audio files which contain the taunts the hedgehogs say on various events.

== Creating voicepacks ==

A voicepack is a directory in `Data/Sounds/voices` and contains a bunch of audio files which are encoded in the Ogg Vorbis format. All the audio files should have a sample rate of 44100 Hz.

Each audio file represents a single taunt which is played at certain events. Only files with the correct file names will be recognized as taunts, other files will be ignored. For a list of recognized file names, see [Taunts]. We might extend the list of used taunts in the future, so it might make sense to record a few additional taunts besides the currently recognized ones so they might be used in future.

Important links:

 * [Taunts]
 * [https://www.hedgewars.org/node/2132 Recording Voices for Hedgewars] (guide)

== Special voicepacks ==
The voicepack “Default” is the English default voice.

Voicepacks with the name “`Default_<language>`” (where “`<language>`” is a language code) are played by default with respect to the player's language, if a localisation exists for that language. This can be applied to other voicepacks, such as `Pirate_<language>` if such a localisation was created.

If you specify “`Default`” as voice for a team by using Lua scripting, Hedgewars will play the default voice with respect to the player's language. If no default voice for the local language is found, Hedgewars will use the English `Default` voicepack instead. This would apply to other voice pack localisations if they are created.

For example, in German Hedgewars, the voice “`Default_de`” will be played by default for the Default voice (if it exists). `Pirate_de` would be played for the `Pirate` voice if it exists.

If a player or script explicitly selects a localisation, such as `Default_de`, it will be played for everyone regardless of locale.

== Sharing voicepacks ==
Custom voicepacks (voicepacks which are not part of the official Hedgewars installation) can only be heard by other players (online) if they have the voicepack installed under the same name.

In case the other player does not have the custom voicepack installed, the player will hear the default voice instead.

You are encouraged to share your voicepacks in the “[https://www.hedgewars.org/forum/19 Content Creations]” forum.