Skip to content

WAI WSP Modding

Jump to bottom
ArthurHeitmann edited this page Mar 4, 2023 · 1 revision

First make sure you hav Wwise 2014 installed and F-SERVO configured as described here.

Music & voice line modding changes several files. But you don't have to worry about it, since F-SERVO does it for you. All files are in [Nier Automata]\data\sound

  • stream\*.wsp: Container for .wem files
  • WwiseStreamInfo.wai: Information on where to find which .wem file
  • bgm\BGM.bnk: For music mods only. Controls music playback & looping
  • audioModsMetadata.json: Created by F-SERVO. Information about what audio mods are installed.

End users need Music Mod Manager to install mods.

Short overview of modding steps

  1. Open WwiseStreamInfo.wai
    (optionally) "Revert all changes" or install an exiting mod
  2. Open .wem from .wsp
  3. "Select WAV"
  4. "Replace WEM"
  5. Save
  6. (for music only) Edit BNK playlists
  7. After you're done, "Package Mod"

Detailed instructions

Starting

  • Open WwiseStreamInfo.wai from [NierAutomata]\data\sound
  • If this is the first time opening the file, you'll have to select where you want to extract the audio files.
  • If you're starting a new mod and have previously made any changes, right click on the .wai and press "Revert all changes".
  • If you want to edit some existing mod, click "Install Packaged Mod" instead and select the zip.

image

Replacing .wem files

  • First you have to find the files you want to edit.
    If you're searching for a specific song, here's a list of all the songs and their files.
    Here's a (not 100% complete) list of voice lines.
  • Open the .wem :)
  • If you want, you can "Export as WAV", if you want to edit the original file.
  • Select a new WAV file with "Select WAV".
  • (optionally) enable or disable "Volume normalization". Enabling it usually makes it a bit quieter.
  • "Replace WEM" and wait for it to finish. (This uses Wwise in the background)
  • Save
  • If you're editing music, the wem will probably be used in several BNK playlists (list on the right). In order for it to play properly you have edit most of them. More in the next section.
  • [Test whether it works in game]
  • Once you're done with your mod, you have to package it, so that it can be easily installed be others. To do so, right click on the WwiseStreamInfo.wai, click "Package Mod", give it a name and save it. People can then install using the Music Mod Manager.

image

Editing BNK playlists

What are playlists?

Wwise playlists are compositions of one or more audio files and are made of multiple segments. Segments can be played once, looped or randomized.

image

In the simplest case, there are 2 segments and 1 audio file. One start segment plays once and another segments that keeps looping.

The green/red markers at the start/end are entry/exit cues. A segment starts playing at the start marker. When it hits the end marker the next segment is played. If after the end marker still is audio it will continue playing. So generally try to make sure that after the exit marker there is no more audio.

image

In more complex playlists you might have multiple audiofiles layered on top of each other. For example when the vocals and instruments are in separate audio files or there are multiple variations of a song and it fades between them. The blue lines indicate volume fade in/out.

Playing a playlist or segment

The playlist player in F-SERVO isn't 100% accurate, but good enough to check your edits without starting the game.

  • You can play single tracks, segments or entire playlists
  • Only single or looping playback is supported (no random playback)
  • Volume/HPF/LPF fading is not supported
  • Switching between segments might have small stutters

To play something click on the play icon either on the playlist, segment or track. You can drag the top of the position indicator to seek. Making any changes cancels the playback.

Editing

What you can edit (a clip is a section of an audio file with a start and end point):

  • Clip start + end time and position
  • Delete clip
  • Duplicate clip
  • Delete volume/HPF/LPF curves

You can do these either by right clicking on a clip or with some shortcuts. To set the start/end point of a clip, drag the left/right edge. To move a clip, select it and drag it.

image

To accurately set the start position of a clip in the second (looping) segment, select the clip from the first segment and the one you want to trim, right click and "Trim start to other selection".

Make sure your audio clips start at 00:00 (where the green/start marker is) and that the red exit marker is at the end. Otherwise you will have weird gaps or jumps in the audio.

Sometimes a segment has many clips, but you really only need one. In that case you can delete all other clips.

To make looping music you first need an audio file that loops. If you don't know how to do that, there are plenty of tutorials online. You have to know the start point of the loop and the end point. Preferably the end point is also the end of the audio file, that will make it easier for you. On the first segment, set the red exit marker to the time of the loop start point and make sure all clips end at the exit marker. In the second segment set the start position with "Trim start to other selection" as described above and the exit marker.

Don't forget to save once you're done with your edits :)

Clone this wiki locally