Soundpacks CDDA

# Soundpacks

A soundpack can be installed in the `data/sound` directory. It has to be a subdirectory that contains at least a file named `soundpack.txt`. It can include any number of json files which add any number of sound_effect or playlist.

## soundpack.txt format

The `soundpack.txt` file format needs 2 values, a NAME and a VIEW. The NAME value should be unique. The VIEW value will be shown in the options menu. Every line starting with a `#` is a comment line.

#Basic provided soundpack
#Name of the soundpack
NAME: basic
#Viewing name of the soundpack
VIEW: Basic

(Cendar note: The game accept at least .wav and .ogg - I've read somewhere in the forums that the soundfiles must be in 44100Hz to work correctly)

## Music format

(Cendar note: Music can only be added with this format in the musicset.json file (or any other json, could be useful to make different files for different playlists, needs testing))

A playlist can be included with a format like this:

[
    {
        "type": "playlist",
        "playlists":
        [
            {
                "id" : "title",
                "shuffle" : false,
                "files" : [
                    {
                        "file": "Dark_Days_Ahead_demo_2.wav",
                        "volume": 128
                    },
                    {
                        "file": "cataclysmthemeREV6.wav",
                        "volume": 90
                    }
                ]
            }
        ]
    }
]

(Cendar notes:
The only type possible is: "playlist"
You can turn shuffle on or off by changing the shuffle line to false or true)

## SFX format

(Cendar note: Sound effects can be included with a format like this in the soundset.json (or any other json, could be useful to make different files for different categories and better workflow, like ambiant.json, guns.json, etc...)

[
    {
        "type": "sound_effect",
        "id" : "menu_move",
        "volume" : 100,
        "files" : [
            "nenadsimic_menu_selection_click.wav"
        ]
    },
    {
        "type": "sound_effect",
        "id" : "fire_gun",
        "volume" : 90,
        "variant" : "bio_laser_gun",
        "files" : [
            "guns/energy_generic/weapon_fire_laser.ogg"
        ]
    }
]

Each sound effect is identified by an id and a variant. If a sound effect is played with a variant that does not exist in the json files, but a variant "default" exists, then the "default" variant is played instead. The file name of the sound effect is relative to the soundpack directory, so if the file name is set to "sfx.wav" and your soundpack is in `data/sound/mypack`, the file must be placed at `data/sound/mypack/sfx.wav`.

(Cendar note: The only type possible is: "sound_effect")

A full list of sound effect id's and variants is given in the following. Each line in the list has the following format:

`id variant1|variant2`

Where id describes the id of the sound effect, and a list of variants separated by | follows. When the variants are omitted, the variant "default" is assumed. Where the variants do not represent literal strings, but variables, they will be enclosed in `<` `>`. For instance, `<furniture>` is a placeholder for any valid furniture ID (as in the furniture definition JSON).

* `id variant1|variant2|...`
* `menu_move default`
* `menu_error default`
* `footstep default|light|clumsy|bionic`
(Cendar note: the fatigue sounds loops)
* `plmove clear_obstacle|fatigue_m_low|fatigue_m_med|fatigue_m_high|fatigue_f_low|fatigue_f_med|fatigue_f_high|walk_barefoot|walk_grass|walk_dirt|walk_metal|walk_water|walk_tarmac`
* `deal_damage hurt_f|hurt_m`
* `clean_up_at_end death_f|death_m`
* `explosion default|small|huge`
* `open_door <furniture>|<terrain>`
* `close_door <furniture>|<terrain>`
* `bash default`
* `smash wall|door|door_boarded|glass`
* `smash_fail <furniture>`
* `smash_success <furniture>|hit_vehicle`
* `melee_swing default|small_bash|big_bash|small_cutting|big_cutting`
* `melee_hit_metal default|small_bash|big_bash|small_cutting|big_cutting`
* `melee_hit_flesh default|small_bash|big_bash|small_cutting|big_cutting`
* `melee_attack monster_melee_hit`
* `melee_hit <weapon> # note: use weapon id "null" for unarmed attacks`
* `fire_gun <weapon>|brass_eject|bio_lightning_tail`
* `bullet_hit hit_wall|hit_flesh|hit_metal`
* `reload <weapon>`
* `mon_bite bite_hit|bite_miss`
* `mon_death zombie_death|zombie_gibbed`
* `chainsaw_cord chainsaw_on`
* `chainsaw_start chainsaw_on`
* `chainsaw_stop chainsaw_on`
* `chainsaw_idle chainsaw_on`
* `weapon_theme chainsaw_on`
(Cendar note: the danger sounds loops and are played at the same time as music)
* `danger_low default`
* `danger_medium default`
* `danger_high default`
* `danger_extreme default`
* `environment thunder_near|thunder_far|daytime|nighttime|indoors|indoors_rain|underground|WEATHER_DRIZZLE|WEATHER_RAINY|WEATHER_THUNDER|WEATHER_FLURRIES|WEATHER_SNOW|deafness_shock|deafness_tone_start|deafness_tone_light|deafness_tone_medium|deafness_tone_heavy|alarm`