Skip to content

Commit 8eea18e

Browse files
committed
Add info on volume options and the base Unreal audio system. Fix typos
1 parent 55ae634 commit 8eea18e

File tree

5 files changed

+45
-15
lines changed

5 files changed

+45
-15
lines changed

cspell.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@
101101
"slomo",
102102
"SMEI",
103103
"smod",
104+
"Spatialization",
104105
"struct",
105106
"structs",
106107
"subfolder",
@@ -136,6 +137,7 @@
136137
"Vulkan",
137138
"webp",
138139
"winget",
140+
"wproj",
139141
"Wwise",
140142
"wwiser",
141143
"xeno",

modules/ROOT/pages/Development/Satisfactory/Audio.adoc

Lines changed: 43 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,33 @@
1-
2-
// cspell:ignore Audiokinetic
3-
// cspell:ignore Soundbank
4-
51
= Audio
62

73
[NOTE]
84
====
95
This page is a work in progress.
106
====
117

8+
Adding sound effects and music via mods can really help bring them to life.
9+
Coffee Stain uses the Wwise audio system to play sounds in Satisfactory.
10+
Depending on what your mod is trying to do, you may want to use the built in Unreal system or the Wwise system.
11+
12+
== Audio for ADA Messages
13+
14+
See the xref:Development/Satisfactory/AdaMessages.adoc[dedicated page on ADA Messages] for more information.
15+
16+
== Unreal Audio System
17+
18+
If you're playing sound for the purpose of user interfaces (UI) or client-side only effects,
19+
it may be easier to use Unreal's built in sound system
20+
at the cost of losing integration with some of the game's systems (ex. ADA) and the advanced features of Wwise.
21+
22+
The "Play Sound 2D" and "Play Sound at Location" blueprint nodes are useful for this purpose.
23+
1224
== Wwise
1325

14-
Coffee Stain uses the Wwise audio system to play sounds in Satisfactory.
26+
Interfacing with the Wwise sound system will require setting up and integrating a Wwise project and integrating it with the modding project.
1527

16-
To create new audio events to play in your mod, you will need the Wwise project set up and integrated into the SML project.
28+
Note that using large numbers of Wwise sounds may require getting a
29+
https://www.audiokinetic.com/en/blog/free-wwise-indie-license/[Wwise indie license]
30+
for your project.
1731

1832
=== Setting Up Audio Buses
1933

@@ -34,7 +48,7 @@ Attenuation causes the sound to become quieter at a distance or not play at all.
3448
Attenuation is not required if you plan to use Audio for UI or ADA messages, and this step can be skipped.
3549
====
3650

37-
On Wwises Project Explorer, go to the `ShareSets` tab. Share Sets are useful for providing the same configuration to multiple Wwise objects.
51+
On Wwise's Project Explorer, go to the `ShareSets` tab. Share Sets are useful for providing the same configuration to multiple Wwise objects.
3852

3953
You will see the section `Attenuations -> Default Work Unit`
4054

@@ -89,7 +103,7 @@ To make sure you are in the correct layout at the top, go to `Layout -> Designer
89103

90104
On the left-hand side, you will see the project explorer; select the Audio Tab.
91105

92-
image:Satisfactory/Wwise/Wwise_Import_PorjectExplorer.png[Wwise_Import_PorjectExplorer, 350]
106+
image:Satisfactory/Wwise/Wwise_Import_ProjectExplorer.png[Wwise_Import_ProjectExplorer, 350]
93107

94108
Under `Actor-Mixer Hierarchy`, there will be `Default Work Unit`
95109

@@ -202,6 +216,7 @@ Then change the `Unreal Audio Routing` setting to `Both Wwise and Unreal audio`.
202216
You may need to restart the Unreal Editor after making these changes.
203217

204218
=== Creating AKEvents In Unreal Engine
219+
205220
Now that you've defined your audio, events, and soundbanks in Wwise, it's time to utilize them in the Unreal Engine.
206221
The first step in doing this is to create Unreal assets that reference your Wwise assets.
207222
Although it is possible to use the Wwise Browser to create these, this is not recommended,
@@ -286,15 +301,15 @@ Once that is done, you should see something similar to the following:
286301

287302
image:Satisfactory/Wwise/Wwise_RTPC_Overview.png[Wwise_RTPC_Overview, 100%]
288303

289-
Now, to create the link between unreal engine and Wwise you will need to create the Game Parameter in Unreal Engine.
304+
Now, to create the link between Unreal Engine and Wwise you will need to create the Game Parameter in Unreal Engine:
290305

291-
image:Satisfactory/Wwise/Wwise_UERTPC_Create.png[Wwise_UERTPC_Create, 600]
306+
image:Satisfactory/Wwise/Wwise_UE_RTPC_Create.png[Wwise_UE_RTPC_Create, 600]
292307

293308
Name it the same as you have in Wwise.
294309

295310
You can now update the RTPC Game Parameter value using blueprints:
296311

297-
image:Satisfactory/Wwise/Wwise_UERTPC_Usage.png[Wwise_UERTPC_Usage, 700]
312+
image:Satisfactory/Wwise/Wwise_UE_RTPC_Usage.png[Wwise_UE_RTPC_Usage, 700]
298313

299314
== Wwise and Source Control
300315

@@ -316,10 +331,6 @@ Wwise offers advice on connecting to source control
316331
https://www.audiokinetic.com/en/library/edge/?source=Help&id=using_wwise_with_source_control_system[in their documentation].
317332

318333

319-
== ADA
320-
321-
See the xref:Development/Satisfactory/AdaMessages.adoc[dedicated page on ADA Messages] for more information.
322-
323334
== Volume Options
324335

325336
To retrieve the user's volume options, use "Get FGGame User Settings" and "Get Float Option Value".
@@ -350,3 +361,20 @@ RTPC.Menu_Volume_Weapons
350361
These values are on a scale of `0.0` (off) to `1.0` (full volume).
351362
If multiple categories apply, multiply them together to reach the final volume value.
352363
For example, the Chainsaw's volume is probably Master multiplied with Equipment multiplied with the chainsaw's specific category.
364+
365+
You may also wish to implement your own volume slider to factor into the mix.
366+
The suggested approach is to create a
367+
xref:Development/ModLoader/Configuration.adoc[mod float config option]
368+
combobox ranging from 0.0 to 1.0 and multiplying it with the other relevant volume categories to use as the final volume.
369+
370+
=== Volume with the Unreal Audio System
371+
372+
Unreal's play sound nodes take volume as a float parameter.
373+
Follow the steps in the main Volume Options section to combine the relevant volume slider values to obtain the final input volume.
374+
375+
=== Volume with Wwise
376+
377+
The game's master volume slider is automatically applied to any sounds played through Wwise.
378+
Following other base game volume sliders requires using the respective audio busses on the event.
379+
380+
The RTPC system can be used to factor in arbitrary volume options from other sources.

0 commit comments

Comments
 (0)