Manifest
A manifest is a simple YAML1 file to describe your sounds.
Audioware then use them to build sounds banks on game startup.
Let's take a closer look at a Manifest's anatomy.
Anatomy
A manifest is a .yml1 file located in a folder named after your mod inside one of 2 depots.
It expects a version and sections like sfx, onos, voices or music.
It must be defined:
- in a folder named after your mod (e.g.
mods\MyMod) itself located inside any valid depot (modsorr6\audioware), - alongside audio files: files can be located in sub-folders, at your discretion.
Each section contains one or multiple audio ID(s) which points to an audio file path.
When using a simple audio file, you can write it inline.
version: 1.0.0
# ⬇️ section
sfx:
# ⬇️ audio ID ⬇️ audio file path
my_custom_audio: some.mp3
But you can also write nested properties for settings:
version: 1.0.0
sfx:
my_custom_audio:
file: some.mp3
settings:
volume: 4.0 # 4 times louder!
All audio accepts multiple optional settings.
Supported audio formats
Audioware supports the following formats:
- .wav
- .ogg
- .mp3
- .flac
Generally speaking, Cyberpunk 2077 vanilla audio uses 48kHz / 16 bit PCM.
analyze with ffprobe
$ just analyze C:\\Development\\modding-cyberpunk\\4ddicted\\archive\\source\\archive\\base\\localization\\common\\vo\\civ_mid_m_85_mex_30_mt_vista_del_rey_f_1ed3f72f92559000.wem
ffprobe -i 'C:\Development\modding-cyberpunk\4ddicted\archive\source\archive\base\localization\common\vo\civ_mid_m_85_mex_30_mt_vista_del_rey_f_1ed3f72f92559000.wem' -show_format
ffprobe version 6.0-essentials_build-www.gyan.dev Copyright (c) 2007-2023 the FFmpeg developers
built with gcc 12.2.0 (Rev10, Built by MSYS2 project)
configuration: --enable-gpl --enable-version3 --enable-static --disable-w32threads --disable-autodetect --enable-fontconfig --enable-iconv --enable-gnutls --enable-libxml2 --enable-gmp --enable-lzma --enable-zlib --enable-libsrt --enable-libssh --enable-libzmq --enable-avisynth --enable-sdl2 --enable-libwebp --enable-libx264 --enable-libx265 --enable-libxvid --enable-libaom --enable-libopenjpeg --enable-libvpx --enable-libass --enable-libfreetype --enable-libfribidi --enable-libvidstab --enable-libvmaf --enable-libzimg --enable-amf --enable-cuda-llvm --enable-cuvid --enable-ffnvcodec --enable-nvdec --enable-nvenc --enable-d3d11va --enable-dxva2 --enable-libmfx --enable-libgme --enable-libopenmpt --enable-libopencore-amrwb --enable-libmp3lame --enable-libtheora --enable-libvo-amrwbenc --enable-libgsm --enable-libopencore-amrnb --enable-libopus --enable-libspeex --enable-libvorbis --enable-librubberband
libavutil 58. 2.100 / 58. 2.100
libavcodec 60. 3.100 / 60. 3.100
libavformat 60. 3.100 / 60. 3.100
libavdevice 60. 1.100 / 60. 1.100
libavfilter 9. 3.100 / 9. 3.100
libswscale 7. 1.100 / 7. 1.100
libswresample 4. 10.100 / 4. 10.100
libpostproc 57. 1.100 / 57. 1.100
[wav @ 0000023cb642ebc0] Estimating duration from bitrate, this may be inaccurate
[wav @ 0000023cb642ebc0] Could not find codec parameters for stream 0 (Audio: none ([255][255][0][0] / 0xFFFF), 48000 Hz,
1 channels, 103 kb/s): unknown codec
Consider increasing the value for the 'analyzeduration' (0) and 'probesize' (5000000) options
Input #0, wav, from 'C:\Development\modding-cyberpunk\4ddicted\archive\source\archive\base\localization\common\vo\civ_mid_m_85_mex_30_mt_vista_del_rey_f_1ed3f72f92559000.wem':
Duration: 00:00:05.94, bitrate: 103 kb/s
Stream #0:0: Audio: none ([255][255][0][0] / 0xFFFF), 48000 Hz, 1 channels, 103 kb/s
Unsupported codec with id 0 for input stream 0
[FORMAT]
filename=C:\Development\modding-cyberpunk\4ddicted\archive\source\archive\base\localization\common\vo\civ_mid_m_85_mex_30_mt_vista_del_rey_f_1ed3f72f92559000.wem
nb_streams=1
nb_programs=0
format_name=wav
format_long_name=WAV / WAVE (Waveform Audio)
start_time=N/A
duration=5.937938
size=76925
bit_rate=103638
probe_score=99
[/FORMAT]
Validation
What is worth mentioning is that Audioware will actually validate many properties of your audios on game startup, here's a non-exhaustive list.
In any case error(s) will never crash your game, Audioware will instead ignore the invalid entries and report them both in the logs at red4ext\logs\audioware-xyz.log and in CET Game Log.
each audio ID (e.g. my_custom_audio) is automatically added to game's CName pool on startup, so make sure they are truly uniques (across all game and all mods).
Audio files can be defined at your convenience at the root of your mod folder inside its depot, or any sub-folder, but they cannot be located outside.
Each audio file is briefly preloaded on game startup to make sure they will play just fine during your game session.
Each setting defined alongside audios must be valid.
e.g. specifying a
start_positionfurther than audio total duration is not!
If you would like to know exactly how validation works, consider browsing unit-tests files.
Guarantees
The reason behind these numerous validation checks: it then allows Audioware to make assumptions about your sounds bank.
Upholding these invariants guarantees for example that any audio ID that makes it into Audioware both exists and can be safely loaded without further need for runtime validation, increasing overall in-game performances!
Of course if you delete audio file(s) while your game is running, Audioware will crash as soon as called with e.g. Play. This is expected.
Let's be pragmatic 1sec: if you do so, you probably deserve your game to crash anyway 😂
Since everything is loaded at-most once on startup, Audioware does not currently provide any way to hot-reload your audio assets in-game.
💡 To get you going fast during mod development, you can rely on AudioSettingsExt instead to adjust audio effects until you get them to your liking, then write them down in your Manifest.
YAML is a file format, see how to write your own.