Skip to content

man572142/Bro_Audio

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

BroAudio

A simple and intutive Audio Middleware for Unity
Explore the docs »

Discord · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Quick Start
  3. Explanation
  4. Roadmap
  5. License
  6. Contact
  7. Acknowledgments

About The Project

Official Tralier

Product Name Screen Shot

BroAudio is a sound management and playback system designed for Unity. It's unique in its focus on sound quality and a developer-friendly experience. You can create extensive and captivating audio systems without the need for mastering complex middleware like FMOD or Wwise. Whether you're part of a large team or a solo developer, achieving the goals becomes effortless and efficient with BroAudio.

(back to top)

Features

  • Fade In/Out and Cross Fade with multiple ease function
  • Seamless Loop
  • Random Playback (with weight), Sequential Playback
  • Clip Editor for permanent clip editing
  • Dynamic audio effect
  • Enhanced Volume Control Range (up to +20dB)
  • Visualized waveform and visualized playback flow view
  • Customizable GUI settings
  • Write code in just one line
  • and more…

(back to top)

Quick Start

Install

Get it from Unity Asset Store, install it from Package Manager

Creating sound libraries

  • Locate Tools/BroAudio/Library Manager in the Unity menu bar.
  • Drag and drop the required AudioClip.
  • Edit the parameters
    edit the clip's volume, playback position... etc.
  • Name the asset and entities and choose an AudioType
    You could also skip this step. Just remember to set it before you need them in your scene.

Implementation

You can implement the sound you've created in Library Manager with or without coding.

Without Code

  • Add SoundSource component to a game object
  • Select the required sound via the dropdown menu

SetAudioID

  • Choose the triggering strategy
    Enables "Play On Start" if you want to play it when the game object is activated at runtime. Or using Unity Event to trigger the Play() function like the Button's OnClick as below.

With Code

  • Declare a SoundID and implement BroAudio.Play() to play it

Logo

  • Select the required sound via the dropdown menu in the Inspector
    The same way as using SoundSource.

Hit the Unity play button and enjoy it !

That's all you need to start using BroAudio. Of course, there is more than just this. Check out the rest of the documentation to fully unlock all the features of BroAudio.

(back to top)

Explanation

Why is this tool related to sound quality?

Indeed, apart from issues like noise and distortion that need to be repaired, there is no objective method to enhance sound quality. However, a playback system still holds significant impact over the quality of sound. This is because the loss of sound quality is relatively easy to occur and hard to avoid.

Here are some common issues listed along with how BroAudio addresses them:

Issues Bro's Solutions
Distortion caused by playing multiple sounds simultaneously. Well-designed mixer and auto-ducking on the master track
Comb Filtering Preventing rapid repetition of the same sound
Unbalanced volume levels Full range (-80dB to +20dB) and highly adaptable real-time volume control system
Unnatural volume changes in Fade In, Fade Out and CrossFade Utilizing AudioMixer for volume control

(back to top)

What does Developer-Friendly mean in this tool?

BroAudio aims to minimize the amount of information presented to developers. This means that by default, you will only see a few commonly used features, while other functions dynamically appear in the UI interface as you interact. You won't be overwhelmed by a large number of rarely used, or even completely unfamiliar settings and parameters.

What's even better is that BroAudio allows you to customize the GUI layout. You can set and select the parameters you want to display in Tools/BroAudio/Preferences.

(back to top)

Can I still use Unity's built-in audio features?

Yes, BroAudio is an add-on plugin, all of Unity's built-in audio features are still available.

Roadmap

See the Roadmap page of the documentation.

(back to top)

Support & Contact

Join us on Discord

Che Hsiang Weng - man572142@gmail.com

Project Link: https://github.com/man572142/Bro_Audio

(back to top)

Acknowledgments

These blogs and articles have been a great source of help and inspiration for BroAudio.

(back to top)