Cart 0

Sonigon Engine 0.9 Documentation

Table of contents

1. Introduction

     1.1 What is Sonigon Engine

2. Getting started

     2.1 Installation

     2.2 Adding the Sonigon Manager

     2.3 Playing a sound using Trigger

3. Playing sounds

     3.1 Play using Trigger

     3.2 Play using Visual Trigger

     3.3 Play using Physics Trigger

4. Parameters

     4.1 How to use parameters

5. ReverbTag

6. Editing and adding your own sounds

     6.1 Sound

     6.2 SoundGroup

1 Introduction

1.1 What is Sonigon

Sonigon is a tool for implementing and playing sounds, directly in Unity®. You can use it for playing the pre implemented sounds, or you can implement your own sounds.

Helpful Links and Info

  • Unity Asset Store (coming soon)

  • Tutorial Videos (on the way)

  • API

2 Getting Started

2.1 Installation

Unity 2017.4.1f1and later (recommended)

  1. Download the latest release from Unity Asset Store (coming soon)
  2. Install the .unitypackage
  3. Verify that it is installed by opening Windows > About Sonigon Engine

  

2.2 Adding the Manager

Add the pre-made prefab

  1. Go to Project > Sonigon Engine > Manager Prefab
  2. Drag "Sonigon Manager" to the scene

Create a new Manager

  1. Create a new empty GameObject in the Hierarchy
  2. Add the component called "Manager"

3 Playing Sounds

3.1 Play using Trigger

  1. Create a new C# script called "TestTrigger" in your project directory
  2. Replace the contents with this code:
using UnityEngine;
using Sonigon;

public class TestTrigger : MonoBehaviour {

    public Trigger trigger;

    private void Update() {
        if (Input.GetKeyDown(KeyCode.X)) {
            trigger.Play(transform);
        }
    }
}

     3 Create a new empty GameObject in the Hierarchy and add the component called "TestTrigger"
     4. Go to "Sound Group" and select the SoundGroup you want to play
     5. Play your scene

 

3.2 Play using Visual Trigger

  1. Create a new empty GameObject in the Hierarchy and add the component called "Sonigon Visual Trigger"
  2. Go to "Sound Group" and select the SoundGroup you want to play
  3. Create a new C# script called "TestVisualTrigger" in your project directory
  4. Replace the contents with this code:
using UnityEngine;
using Sonigon;

class TestVisualTrigger : MonoBehaviour {

    private VisualTrigger cachedVisualTrigger;

    private void Update() {
        if (Input.GetKeyDown(KeyCode.X)) {
            cachedVisualTrigger = gameObject.GetComponent<VisualTrigger>();
            cachedVisualTrigger.Play();
        }
    }
}

     5. Play the scene

3.3 Play using Physics Trigger

  1. Create a new empty GameObject in the Hierarchy and add the component called "Physics Trigger"
  2. Go to "Impact Trigger" > "Sound Group" and select the SoundGroup you want to play
  3. Go to "Friction Trigger" > "Sound Group" and select the SoundGroup you want to play
  4. Done!

4 Parameters

4.1 How to use parameters

  1. Create a new C# script called "TestParameter" in your project directory
  2. Replace the contents with this code:
using UnityEngine;
using Sonigon;

public class TestParameter : MonoBehaviour {

    public Trigger trigger;
    ParameterVolume parameterVolume = new ParameterVolume(1f, UpdateMode.once);

    private void Update() {
        if (Input.GetKeyDown(KeyCode.X)) {
            parameterVolume.volume = Random.Range(0f, 1f);
            trigger.Play(transform, parameterVolume);
        }
    }
}

     5. Play the scene and press "X" to play the sound and change the parameter

5 ReverbTag

On the way

6 Editing and adding your own sounds

6.1 Sound

On the way

6.2 SoundGroup

On the way