> For the complete documentation index, see [llms.txt](https://sonity.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sonity.gitbook.io/docs/sonity/getting-started.md). # Getting Started How to get started using Sonity ### Video Tutorials A great way to get started is watching the tutorial videos. #### Sonity - Showcase {% embed url="" fullWidth="false" %} [Link to video](https://www.youtube.com/watch?v=Ik56geuZ1iA\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=1)\ [0:00](https://www.youtube.com/watch?v=Ik56geuZ1iA\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=1\&t=0s) Intro\ [0:19](https://www.youtube.com/watch?v=Ik56geuZ1iA\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=1\&t=19s) Features\ [1:31](https://www.youtube.com/watch?v=Ik56geuZ1iA\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=1\&t=91s) Outro #### Sonity - Quickstart Tutorial {% embed url="" %} [Link to video](https://www.youtube.com/watch?v=3gSttAnbg6Y\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=3)\ [0:00](https://www.youtube.com/watch?v=3gSttAnbg6Y\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=2) Intro\ [0:19](https://www.youtube.com/watch?v=3gSttAnbg6Y\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=2\&t=19s) Installation\ [0:49](https://www.youtube.com/watch?v=3gSttAnbg6Y\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=2\&t=49s) Asset Creation\ [1:41](https://www.youtube.com/watch?v=3gSttAnbg6Y\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=2\&t=101s) Asset Editing\ [2:53](https://www.youtube.com/watch?v=3gSttAnbg6Y\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=2\&t=173s) SoundTrigger Implementation\ [3:15](https://www.youtube.com/watch?v=3gSttAnbg6Y\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=2\&t=195s) C# Implementation\ [4:34](https://www.youtube.com/watch?v=3gSttAnbg6Y\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=2\&t=274s) Outro #### Sonity - Realistic Gun Sounds Tutorial {% embed url="" %} [Link to video](https://www.youtube.com/watch?v=fCaEeRm9pRo\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=3)\ [0:00](https://www.youtube.com/watch?v=fCaEeRm9pRo\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=3\&t=0s) Intro\ [0:45](https://www.youtube.com/watch?v=fCaEeRm9pRo\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=3\&t=45s) Distance Crossfades\ [3:22](https://www.youtube.com/watch?v=fCaEeRm9pRo\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=3\&t=202s) Pistol Shot Editing\ [4:30](https://www.youtube.com/watch?v=fCaEeRm9pRo\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=3\&t=270s) Adding SoundTags\ [5:44](https://www.youtube.com/watch?v=fCaEeRm9pRo\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=3\&t=344s) Play Shot Sound in C#\ [6:42](https://www.youtube.com/watch?v=fCaEeRm9pRo\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=3\&t=402s) Set Global SoundTags\ [8:07](https://www.youtube.com/watch?v=fCaEeRm9pRo\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=3\&t=487s) Mixing Reflections\ [8:46](https://www.youtube.com/watch?v=fCaEeRm9pRo\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=3\&t=526s) Using the Lowpass Filter\ [10:00](https://www.youtube.com/watch?v=fCaEeRm9pRo\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=3\&t=600s) Using Distortion\ [10:41](https://www.youtube.com/watch?v=fCaEeRm9pRo\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=3\&t=641s) Outro #### Sonity - SoundPhysics & Intensity Tutorial {% embed url="" %} [Link to video](https://www.youtube.com/watch?v=ehnwL678N4E\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=3)\ [0:00](https://www.youtube.com/watch?v=ehnwL678N4E\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=3\&t=0s) Introduction\ [1:45](https://youtu.be/ehnwL678N4E?feature=shared\&t=106s) SoundPhysics Basic: Impact and Intensity, Crossfading velocity layers\ [9:55](https://www.youtube.com/watch?v=ehnwL678N4E\&t=596s) SoundPhysics Intermediate: Friction, Exit and OnTrigger\ [16:56](https://www.youtube.com/watch?v=ehnwL678N4E\&t=1016s) SoundPhysics Advanced A: Using SoundPhysicsConditions\ [21:52](https://www.youtube.com/watch?v=ehnwL678N4E\&t=1312s) SoundPhysics Advanced B: Using SoundTags\ [32:09](https://youtu.be/ehnwL678N4E?feature=shared\&t=1929s) Outro #### Sonity 1.0.6 - The Big Volume & Debug Update {% embed url="" %} [Link to video](https://www.youtube.com/watch?v=SX4dQFX-5Yw\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=1)\ [0:15](https://www.youtube.com/watch?v=SX4dQFX-5Yw\&t=15s) Introduction\ [0:29](https://www.youtube.com/watch?v=SX4dQFX-5Yw\&t=29s) SoundEvent Base Settings\ [1:02](https://www.youtube.com/watch?v=SX4dQFX-5Yw\&t=62s) AudioMixerGroup Legacy Conversion\ [1:34](https://www.youtube.com/watch?v=SX4dQFX-5Yw\&t=94s) Enable Volume Increase\ [3:41](https://www.youtube.com/watch?v=SX4dQFX-5Yw\&t=221s) Log SoundEvents\ [4:16](https://www.youtube.com/watch?v=SX4dQFX-5Yw\&t=256s) SoundEvents Debug Settings\ [4:44](https://www.youtube.com/watch?v=SX4dQFX-5Yw\&t=284s) Editor Tools\ [5:21](https://www.youtube.com/watch?v=SX4dQFX-5Yw\&t=321s) Editor Tools - Reference Finder\ [5:34](https://www.youtube.com/watch?v=SX4dQFX-5Yw\&t=334s) Editor Tools - Select Same Type\ [5:54](https://www.youtube.com/watch?v=SX4dQFX-5Yw\&t=354s) Editor Tools - Selection History\ [6:29](https://www.youtube.com/watch?v=SX4dQFX-5Yw\&t=389s) Notes Fields\ [6:49](https://www.youtube.com/watch?v=SX4dQFX-5Yw\&t=409s) SoundPresets\ [8:44](https://www.youtube.com/watch?v=SX4dQFX-5Yw\&t=524s) AudioListenerDistance\ [10:37](https://www.youtube.com/watch?v=SX4dQFX-5Yw\&t=637s) Outro #### Sonity 1.1.1 - Steam Audio, PlayMaker + tips & tricks {% embed url="" %} [Link to video](https://www.youtube.com/watch?v=jl0hOuqpZEU\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=1)\ [0:08](https://www.youtube.com/watch?v=jl0hOuqpZEU\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=1\&t=8s) Whats New \ [0:25](https://www.youtube.com/watch?v=jl0hOuqpZEU\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=1\&t=25s) Steam Audio Integration \ [5:40](https://www.youtube.com/watch?v=jl0hOuqpZEU\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=1\&t=340s) PlayMaker Integration \ [6:37](https://www.youtube.com/watch?v=jl0hOuqpZEU\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=1\&t=397s) 2D/3D Information Panel \ [8:04](https://www.youtube.com/watch?v=jl0hOuqpZEU\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=1\&t=484s) Tip: Volume Increase with AudioMixerGroups \ [9:32](https://www.youtube.com/watch?v=jl0hOuqpZEU\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=1\&t=572s) Tip: Legacy support for PlayMusic and Play2D \ [10:13](https://www.youtube.com/watch?v=jl0hOuqpZEU\&list=PL8HmiLFR3c5RyFFc_mqQVagE-qrdtMP6z\&index=1\&t=613s) Outro ### Installation 1. After purchase, go to the Package Manager, show “My Assets” and search for “Sonity”. 2. Then click on “Sonity” and press “Download”, then “Import”. 3. It should be located at “Assets\Plugins\Sonity” {% hint style="info" %} **💡 TIP - Materials for URP** If materials are **pink or transparent**, select all “ExampleMaterial” and upgrade to URP with:\ Edit → Rendering → Materials → Convert Selected Built-in Materials to URP. ![](https://3478075546-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FECYQ2OSoWTLdq4EUgnCW%2Fuploads%2FGCeVfsNU2zmriUDl1mtT%2FScreenshot%202026-03-14%20124447.png?alt=media\&token=12866d38-eedc-4024-830a-5f0f210a9fc7) {% endhint %} ### Upgrade 1. Backup your project before adding or updating Sonity. 2. Delete the whole Sonity folder if it says so in the Sonity Changelog.txt. 3. Import and install the latest version of Sonity from the Asset Store. 4. Restart Unity if needed. **How to Upgrade Free Trial** Just delete the “Sonity” folder and import the [paid version](https://assetstore.unity.com/packages/tools/audio/sonity-audio-middleware-229857) of Sonity, all assets created with the [free trial](https://assetstore.unity.com/packages/tools/audio/sonity-audio-middleware-free-trial-244369) will continue to work. {% hint style="info" %} **💡 TIP - Upgrading** If you’re upgrading from an earlier version you might need to remove the whole “Sonity” folder in the project.\ And if you´re still having trouble, try removing the “.asmdef” files, search for “t:asmdef Sonity.” and then re-import those files again.\ Also, if you have your own .asmdef files in your project, you might have to reference both Sonity Runtime .asmdef files to use Sonity. {% endhint %} ### Adding the SoundManager The [SoundManager](/docs/soundmanager.md) is used to play sounds and manage global settings.\ An instance in the scene is required to play [SoundEvents](/docs/soundevent.md).\ You can either add the pre-made prefab called “[SoundManager](/docs/soundmanager.md)” or add the “Sonity - Sound Manager” component to an empty GameObject in the scene. {% hint style="info" %} ❕ Tip: Distance Scale\ Don’t forget to set up the Distance Scale to match the scale of your project. {% endhint %} {% hint style="info" %} 💡 Tip: Play On Awake\ If you need to play [SoundEvents](/docs/soundevent.md) on Awake() when starting your game you need to edit the Script Execution Order.\ Go to "Project Settings..." -> "Script Execution Order" and add "Sonity.SoundManager".\ Then set it to a negative value (like -50) so it loads before the code which you want to use Awake() to play sounds when starting your game. {% endhint %} More info at [SoundManager](/docs/soundmanager.md) Component. ![](https://content.gitbook.com/content/ECYQ2OSoWTLdq4EUgnCW/blobs/PyWoYljrKkM36frVWGFc/image32.gif) ### Asset Creation The asset hierarchy for playing sounds is:\ AudioClip → [SoundContainer ](/docs/soundcontainer.md)→ [SoundEvents](/docs/soundevent.md)\ If you have a bunch of AudioClips in your project, just select them (or their folder).\ Then right click to bring up the “Create” → “Sonity” → “Create Assets from Selection” menu and press the desired button. More info at [Create Assets From Selection](/docs/sonity/create-assets-from-selection.md). ![](https://content.gitbook.com/content/ECYQ2OSoWTLdq4EUgnCW/blobs/kJQwPl9k4zBHAeURK8sb/image28.gif) ### Asset Editing The [SoundContainers ](/docs/soundcontainer.md)and [SoundEvents](/docs/soundevent.md) contain the settings of how your sounds are played.\ They are made of scriptable objects, so all changes you make in runtime are updated live and saved.\ All Sonity scriptable objects and components are multi-object editable. #### **SoundContainer Intro**
[SoundContainers ](/docs/soundcontainer.md)are the building blocks of Sonity.\ They contain AudioClips and options of how the sound should be played.\ All [SoundContainers ](/docs/soundcontainer.md)are multi-object editable. **Overview of settings:** * [Looping](/docs/soundcontainer.md#settings) * [Volume](/docs/soundcontainer.md#volume) * [Pitch](/docs/soundcontainer.md#pitch) * [Spatial Blend](/docs/soundcontainer.md#spatial-blend) * [Spatial Spread](/docs/soundcontainer.md#spatial-spread) * [Stereo Pan](/docs/soundcontainer.md#stereo-pan) * [Reverb Zone Mix](/docs/soundcontainer.md#reverb-zone-mix) * [Distortion](/docs/soundcontainer.md#distortion) * [Lowpass Filter](/docs/soundcontainer.md#lowpass) * [Highpass Filter](/docs/soundcontainer.md#highpass) {% hint style="info" %} ❕ Tip: Don’t forget to use the [presets](/docs/soundpreset.md). {% endhint %} More info at [SoundContainer](/docs/soundcontainer.md). #### **SoundEvent Intro**
[SoundEvents](/docs/soundevent.md) are what you play in Sonity.\ They contain SoundContainers and options of how the sound should be played.\ All [SoundEvents](/docs/soundevent.md) are multi-object editable. **Overview of settings:** * [Timeline](/docs/soundevent.md#timeline) * [Modifier volume, pitch, fade in/out, etc](/docs/soundevent.md#modifiers) * [Intensity](/docs/soundevent.md#intensity) * Trigger another [SoundEvent](/docs/soundevent.md) on [Play](/docs/soundevent.md#trigger-on-play), [Stop](/docs/soundevent.md#trigger-on-stop), [Tail](/docs/soundevent.md#trigger-on-tail), [Tag](/docs/soundevent.md#trigger-on-tail) More info at [SoundEvent](/docs/soundevent.md). ### Shortcuts These are the default shortcuts used by Sonity and [Sonity Tools](/docs/soundmanager/editor-tools.md).\ You can customize them at Edit → Shortcuts.
ShortcutCommand
Create Assets From Selection/SC from AudioClips Multiple
Create Assets From Selection/SC from AudioClips Single
Ctrl+Shift+QCreate Assets From Selection/SC+SE from AudioClip Group Multiple SE
Ctrl+Shift+WCreate Assets From Selection/SC+SE from AudioClip Group Single SE
Create Assets From Selection/SE from SC Multiple
Create Assets From Selection/SE from SC Single
Ctrl+Alt+Shift+FReference Finder 🔍 /Find References for Selected Assets
Ctrl+Alt+AReference Finder 🔍 /Open Reference Finder Window
Ctrl+Alt+Shift+ASelect Same Type 👆 /In Folder
Select Same Type 👆 /In Subfolders
USelection History 📜 /Back
Shift+USelection History 📜 /Forward
Ctrl+QSound Preview - Play
Ctrl+WSound Preview - Stop
Shift+MSelect - SoundManager
**Create Assets From Selection Shortcuts**\ Ctrl+Shift+Q - SC+SE from AudioClip Group Multiple SE\ Ctrl+Shift+W - SC+SE from AudioClip Group Single SE **Preview Shortcuts**\ Ctrl+Q - Play (Previews the selected [SoundEvent](/docs/soundevent.md) or [SoundContainer](/docs/soundcontainer.md)).\ Ctrl+W - Stop (Stops any playing preview of [SoundEvents](/docs/soundevent.md) and [SoundContainers](/docs/soundcontainer.md), press two times to skip fade out). **Timeline Shortcuts & Controls**\ Zoom: Mousewheel scroll.\ Pan: Mousewheel hold and drag (or left mouse button also if outside of item).\ Volume: Hold and drag top of item up/down or click on the volume to write the decibel value.\ Move item: Hold and drag on item left/right.\ Focus on items: F ### Playing with SoundTrigger To play a [SoundEvent](/docs/soundevent.md), create a gameobject and add a [SoundTrigger](/docs/soundtrigger.md) component to it.\ Then select the [SoundEvent](/docs/soundevent.md) you want to play and when you want it to play like in the example below: More info at [SoundTrigger](/docs/soundtrigger.md). ![](https://content.gitbook.com/content/ECYQ2OSoWTLdq4EUgnCW/blobs/6bFtVcW36lo1lxOUXQj7/image95.gif) ### Playing with C\# To play a [SoundEvent](/docs/soundevent.md), create a C# script and include the “Sonity” namespace.\ Then make a public “[SoundEvent](/docs/soundevent.md)” property, select the desired SoundEvent in the inspector.\ Use the functions of the [SoundEvent](/docs/soundevent.md) to play and stop your [SoundEvents](/docs/soundevent.md) like in the example below. More info at [SoundEvent Functions](/docs/soundevent/soundevent-functions.md) and the [SoundManager Functions](/docs/soundmanager/soundmanager-functions.md). Example code: {% code overflow="wrap" %} ```csharp using UnityEngine; using Sonity; public class PlayStopExample : MonoBehaviour { public SoundEvent soundEvent; void PlayExample() { // Plays the SoundEvent at the position of the transform soundEvent.Play(transform); } void StopExample() { // Stops the SoundEvent playing at the transform soundEvent.Stop(transform); } } ``` {% endcode %}