0.1.2

Author: XanGrab

CHANGELOG.md

@@ -25,3 +25,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 + [AlwaysLinkAssembly] attribute added to boostrapper
 
 ### Removed
+
+## [0.1.2] - 2024-01-03
+
+### Changed
+
+* Sound.cs
+* AudioManager.cs
+
+### Added
+
++ Fade functionality
++ AudioManager.cs and Sound.cs moved into seperate SoundSystem namespace

CHANGELOG.md.meta

@@ -11,17 +11,53 @@ A simple unity package that contains some of my commonly reused systems
 
 A utility function used to load any systems required at Runtime (e.g. `AudioManager`). In the Editor hierarchy, a GameObject named "GlobalSystems" gets added on Runtime Initalized.
 
-## Audio Manager 🎹
+# SoundSystem
 
-A manager class that utilizes `Sound` ScriptableObjects to play Audio Clips on command from scripts.
+Use this simple sound system by importing the `SoundSystem` namespace into a file.
+
+## 🎵 Sound
+
+Sound class ineherits from SctiptableObject, and represents a collection of AudioClips for a specific SFX or music track that will be played in game. 
+
+Each sound is automatically loaded into memory of the AudioManager when the attached MonoBehavior enters the scene.
 
 | **Properties** |                                                                                 |
 | -------------- | ------------------------------------------------------------------------------- |
-| `Instance`     | the current instance of the AudioManager class (implements _Singleton_ pattern) |
-| `sounds`       | Array of `Sound` objects that can be played at any time                         |
-
-| **Methods** |                                                                            |
-| ----------- | -------------------------------------------------------------------------- |
-| `Play`      | plays a specified sound in the current scene, if it is not already playing |
-| `PlayOnce`  | triggers a specified sound to be played in the current scene               |
-| `Stop`      | stop a specified sound in the current scene                                |
+| `Clips`     | the collection of AudioClips associated with this Sound |
+| `ClipType`    | specifies how clips should be retrieved from this Sound |
+| `Mixer` | the output `AudioMixerGroup` this Sound should be played on |
+| `Volume` | the volume these Sounds should be played at |
+| `Pitch` | the pitch these Sounds should be played at |
+| `Loop` | toggles whether or not this Sound should repeat itself |
+
+### Methods
+
+`PlayOneShot` - Triggers the next clip to be played once from the current AudioManager. Useful for SFX.
+
+`Play` - Plays the next clip on this Sound from the current AudioManager, if it is not already playing. Useful for Music.
+
+## 🎹 AudioManager
+
+The AudioManager class a Singleton MonoBehaviour that can be used to play all clips from the currently loaded Sounds in Unity. 
+
+Sounds can be added to the AudioManager manually in the inspector if they should remain persistantly loaded memory for the manager's lifetime, or loaded dynamically at runtime from Sound ScriptableObjects.
+
+| **Properties** |                                                                                 |
+| -------------- | ------------------------------------------------------------------------------- |
+| `Instance`     | The current instance of the AudioManager class (implements _Singleton_ pattern) |
+| `Persist Sounds`       | Array of `Sound` objects that can be played at any time during the lifetime of the manager                        |
+| `Play On Awake`       | When toggled, the manager will attempt to play the first loaded Sound in its internal array as soon as it is added OnAwake() |
+
+### Methods
+
+`PlayOneShot` - Plays a specified Sound as a one shot audio event from the current AudioManager. Useful for SFX.
+
+`Play` - Plays a specified Sound from the current AudioManager, if it is not already playing. Useful for Music.
+
+`PauseToggle` - 
+
+`Stop` - 
+
+`FadeVolume` - 
+
+`FadeTo` -