Difference between revisions of "Setting WWise Audio Modding"

From Killing Floor 2 Wiki
Jump to: navigation, search
m
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
[[Category:KF2]]
 
[[File:SoundBanksSettings.png|thumb]]
 
[[File:SoundBanksSettings.png|thumb]]
  
Line 11: Line 12:
  
 
#Download correct Wwise SDK - 2015.1.9 build 5624
 
#Download correct Wwise SDK - 2015.1.9 build 5624
#Download Wwise Project located here
+
#Download Wwise Project located [https://www.dropbox.com/sh/03m4hb1o2hnnyw6/AADD7Q3Q495K9XIJfWF_tw40a?dl=0 here]
 
#Place the contents of this folder here: “steamapps\common\killingfloor2\KFGame\Content\Packages\Audio\WWISE”
 
#Place the contents of this folder here: “steamapps\common\killingfloor2\KFGame\Content\Packages\Audio\WWISE”
 
#Install Wwise SDK (Common) and (Windows), Authoring Data, and Authoring Binaries
 
#Install Wwise SDK (Common) and (Windows), Authoring Data, and Authoring Binaries
Line 18: Line 19:
 
##Click the “SoundBanks” tab
 
##Click the “SoundBanks” tab
 
##Set the Windows Platform “SoundBank Folder” path to the folder where your brewed  game files live killingfloor2\KFGame\BrewedPC\WwiseAudio\Windows
 
##Set the Windows Platform “SoundBank Folder” path to the folder where your brewed  game files live killingfloor2\KFGame\BrewedPC\WwiseAudio\Windows
#If you want to create brand new banks this will require manually moving them to the \BrewedPC\WwiseAudio\Windows folder.
+
#If you want to create brand new banks this will require manually moving them and the associated .wem files to the \BrewedPC\WwiseAudio\Windows folder.
 
#NEW STATES WILL NOT WORK WITHOUT COMPILING SOURCE. Modders must use existing States.
 
#NEW STATES WILL NOT WORK WITHOUT COMPILING SOURCE. Modders must use existing States.
  
You can find the KF2 Audio Text Files and KF2 Wise Project Settings [https://www.dropbox.com/sh/03m4hb1o2hnnyw6/AADD7Q3Q495K9XIJfWF_tw40a?dl=0 here]
+
'''You can find the KF2 Audio Text Files and KF2 Wise Project Settings [https://www.dropbox.com/sh/03m4hb1o2hnnyw6/AADD7Q3Q495K9XIJfWF_tw40a?dl=0 here]'''
  
 
===Creating New Content in Wwise===
 
===Creating New Content in Wwise===
Line 46: Line 47:
  
 
#Open the KF2 Editor
 
#Open the KF2 Editor
##Create a new package as you would for any asset. Set the Factory as “AKBank”
+
##Create a new package as you would for any asset. Set the Factory as “AKBank”[[File:AudioPackage.png|center|thumb]]
##These UPK’s must have a “WW_” prefix to be seen for the SoundBankGeneration[[File:AudioPackage.png|center|thumb]]
+
##Name the package however you want.
##Rename the package to match the package name you want to use. Again these must have a “WW_” prefix.
+
##The name field will determine the name of the AkBank item. Make sure it matches your Soundbank name exactly, except for the file extension.
##The name field will determine the name of an AkBank item in UE3. We will not use that one. It auto generates the correct bank item.
+
##Press "OK" to create the package.
##Save the package in the appropriate folder (These have to be in one of the following folders or they won't be seen when generating)
+
##Right click in the package and create a new AkEvent. Name the AkEvent the name of one of the events you created in Wwise, making sure the names are exactly the same.
###Content/Packages/Audio/SFX
+
##Press "OK" to create the event.
###Content/Packages/Audio/Music
+
##Open the AkEvent and then in the content browser select the AkBank you created earlier. Then, in the AkEvent, navigate to the "Required Bank" field and press the green arrow. This will link the AkEvent to the sound bank. [[File:Audio Bank Selection Image.png|center|thumb]]
###Content/Packages/Audio/Ambient
+
##Delete the AkBank that the event auto-generated.
###Content/Packages/Audio/Voice
+
##Right click the sound bank and first unload, then load the sound bank.
##[[File:AudoPackageSaveLocation.png|center|thumb]]
+
##Your audio should now work.
##Drag events from Wwise into the newly created package.[[File:MoveSoundsToPackage.png|center|thumb]]
 
##Right Click the AKBank that was auto generated in the package and click “Generate Soundbanks"[[File:GenerateSoundBanks.png|center|thumb]]
 
##Select your new bank and click “OK”[[File:GenerateSoundBanks2.png|center|thumb]]
 
  
 
===Wwise Event Animation Trigger Example===
 
===Wwise Event Animation Trigger Example===
Line 68: Line 66:
 
#Locate your new sound event in the Asset Browser and select it[[File:NewSoundEventInAssetBrowser.png|center|thumb]]
 
#Locate your new sound event in the Asset Browser and select it[[File:NewSoundEventInAssetBrowser.png|center|thumb]]
 
#In the Animation Editor you can now click the Green Arrow which will fill in the name field with the proper event path[[File:SoundEventPathInAnimationEditor.png|center|thumb]]
 
#In the Animation Editor you can now click the Green Arrow which will fill in the name field with the proper event path[[File:SoundEventPathInAnimationEditor.png|center|thumb]]
 +
 +
{{KF2SDKNavBox}}

Latest revision as of 22:48, 10 September 2019

SoundBanksSettings.png

Setting Up Wwise for KF2

Register an account with Audiokinetic here

Create a non-commercial project with over 200 sounds. Make sure to include the words KF2 Mod in the title and description.

You will need to go to the “older versions” area of downloads here.

They will give you a license key that will get you full access to everything needed for KF2 Modding.

  1. Download correct Wwise SDK - 2015.1.9 build 5624
  2. Download Wwise Project located here
  3. Place the contents of this folder here: “steamapps\common\killingfloor2\KFGame\Content\Packages\Audio\WWISE”
  4. Install Wwise SDK (Common) and (Windows), Authoring Data, and Authoring Binaries
  5. Set the correct bank output path in Wwise
    1. Navigate to Project-Project Settings
    2. Click the “SoundBanks” tab
    3. Set the Windows Platform “SoundBank Folder” path to the folder where your brewed game files live killingfloor2\KFGame\BrewedPC\WwiseAudio\Windows
  6. If you want to create brand new banks this will require manually moving them and the associated .wem files to the \BrewedPC\WwiseAudio\Windows folder.
  7. NEW STATES WILL NOT WORK WITHOUT COMPILING SOURCE. Modders must use existing States.

You can find the KF2 Audio Text Files and KF2 Wise Project Settings here

Creating New Content in Wwise

  1. Create a new Work Unit for Audio
    1. Right Click on “Actor-Mixer Hierarchy”
    2. Navigate to “New Child”
    3. Select “Work Unit” Name Work Unit
  2. Add Sound FX to Wwise
    1. Drag sound file you wish on top of the Work Unit
    2. Click “Import” button
  3. Set the properties of your sound.
    1. Set the output bus to the appropriate bus. If you are creating a 1st person weapon sound the appropriate bus would be “Weapons”
      Step 3.1
    2. Under the “Positioning”tab set the sound to 2D or 3D via the drop down
      Step 3.2
    3. If you are creating a 3D sound you will need to set it’s positioning information. There are many presets in the project that should suit your needs
      PositioningPresets.png
  4. Create an Event for your sound
    1. Right click your new sound and select “New Event” and then “Play”
      NewEventAndPlay.png
    2. Click the “Events” tab in the upper left corner
      EventsTab.png
    3. Follow the same steps as above to create a new “Work Unit” here
    4. Your new Event will be located in the “Default Work Unit”. You can cut and paste or drag it to your new Work Unit (or an existing work unit)
      DefaultWorkUnitSetting.png
    5. Save your project!

Adding Wwise Events to the KF2 Editor

  1. Open the KF2 Editor
    1. Create a new package as you would for any asset. Set the Factory as “AKBank”
      AudioPackage.png
    2. Name the package however you want.
    3. The name field will determine the name of the AkBank item. Make sure it matches your Soundbank name exactly, except for the file extension.
    4. Press "OK" to create the package.
    5. Right click in the package and create a new AkEvent. Name the AkEvent the name of one of the events you created in Wwise, making sure the names are exactly the same.
    6. Press "OK" to create the event.
    7. Open the AkEvent and then in the content browser select the AkBank you created earlier. Then, in the AkEvent, navigate to the "Required Bank" field and press the green arrow. This will link the AkEvent to the sound bank.
      Audio Bank Selection Image.png
    8. Delete the AkBank that the event auto-generated.
    9. Right click the sound bank and first unload, then load the sound bank.
    10. Your audio should now work.

Wwise Event Animation Trigger Example

  1. Open the animation you want to add the sound to
  2. Click the Add Notify Icon (Exclamation Point in the toolbar)
    AddNotifyIcon.png
  3. You will now see the Notify in the AnimSequence field
    AnimSequenceTab.png
  4. Set the notify to use “AnimNotify_AKEvent"
    AnimNotifyAKEvent.png
  5. Locate your new sound event in the Asset Browser and select it
    NewSoundEventInAssetBrowser.png
  6. In the Animation Editor you can now click the Green Arrow which will fill in the name field with the proper event path
    SoundEventPathInAnimationEditor.png