Sections

Manifest can contain any of the following sections.

Sections provide "good defaults", a way to classify your audio assets, and even more.

SFX

sfx is used to define simple sounds.

my_custom_sfx: ./somewhere/sfx.ogg

Default		Editable?
usage	`in-memory`	✅
volume settings	`SfxVolume`	⛔

Onos

onos (onomatopeia) is used to define audio with 2 files each, one per gender.

YAML

my_custom_ono:
    fem: ./somewhere/ono.wav
    male: ./somewhere/else/ono.wav

Default		Editable?
usage	`in-memory`	✅
volume settings	`DialogueVolume`	⛔

Info

Useful for audio that do not require any subtitle, but still have a notion of gender.

e.g. goons grunts and other onos.

Voices

voices (sometimes called voiceovers) is used to define audio with multiple files each
and optional subtitles.

Default		Editable?
usage	`on-demand`	✅
volume settings	`DialogueVolume`	⛔

Simple Voice

YAML

my_simple_voice:
  en-us: ./some/voice.wav

Info

Useful for audio that have to be translated into multiple languages, but for which the notion of gender does not matter.

e.g. a vending machine promotional speech

Simple Voice with subtitle

YAML

my_simple_voice:
  en-us: ./some/voice.wav
  subtitle: "hello world"

Info

Useful to add simple subtitle to be played along your audio.

e.g. NPC dialogues or chatters.

Tip

Defining subtitle will automatically register them with Codeware Localization and play them alongside audio, for the proper gender and locale(s).

Warning

There is no fallback locale. Audio will not play for other locales other than the ones explicity specified.

Plural Voice

YAML

version: 1.0.0
voices:
  my_plural_voice:
    en-us:
      fem: ./fem_intro.mp3
      male: ./male_intro.mp3
      subtitle: "Let me introduce myself, I'm V."
  my_other_plural_voice:
    en-us:
      fem:
        file: ./fem_wake_up.mp3
        subtitle: "Looks yourself in the mirror, girl."
      male:
        file: ./male_wake_up.mp3
        subtitle: "Look yourself in the mirror, dude."

Info

Useful for dialogues that are both locale-based and gender-based, with subtitle.

e.g. V's dialogues.

Music

music defines songs and ambience music.

YAML

version: 1.0.0
music:
  gorillaz_feel_good_inc: ./feel-good-inc.mp3

Default		Editable?
usage	`streaming`	✅
volume settings	`MusicVolume`	⛔

audioware