Changelog
Every release, what changed in it, and whether it breaks anything.
-
Breaking change
This is a breaking update from Audio Clip Toolkit 1.0. The entries below describe the differences between the released 1.0 package and version 2.0.
Added
- Added Weighted Random and Sequential variant selection alongside Random No Repeat.
- Added independent weight, start, end, fade-in, and fade-out values for every AudioClip variant.
- Added Repeat Selected and Reselect Each Loop modes.
- Added an explicit pooled AudioManager with persistent-scene support and runtime voice statistics.
- Added per-cue voice limits, retrigger cooldown, playback priority, bounded temporary voices, and priority-based voice stealing.
- Added generation-safe AudioHandle values with pause, resume, stop, state, and terminal-reason access.
- Added fixed-position and Transform-following playback through
PlayAtandPlayAttached. - Added natural completion, manual stop, stolen voice, destroyed follow target, and destroyed manager end reasons.
- Added a nondestructive three-band equalizer for runtime playback and Inspector preview.
- Added optional equalizer baking during WAV export.
- Added dedicated trigger-volume and Input System pointer adapters with layer, tag, exit, hover, click, and one-shot controls.
- Added mouse, pen, and touchscreen primary-pointer support.
- Added separate runtime, editor, and sample assembly definitions.
- Added the in-Editor Markdown Documentation window and complete installation, quick-start, authoring, API, troubleshooting, and migration guides.
Changed
- Rebranded Audio Clip Toolkit as
AudioCue - AudioClip Editor & Player. - Replaced
AudioClipDatawithAudioCueand moved runtime types to thePaperLynxStudio.AudioCueToolkitnamespace. - Replaced shared trim and fade values with per-variant authoring.
- Replaced the
PlayRandomlyandLoopbooleans with explicit selection and loop modes. - Moved random, sequential, cooldown, concurrency, and playback state out of ScriptableObjects and into AudioManager.
- Replaced the per-component AudioSource playback model with reusable manager-owned voices.
- Split the original monolithic AudioClipPlayer trigger and mouse behavior into AudioCuePlayer, AudioCueTrigger, and AudioCueMouseTrigger.
- Reworked AudioCuePlayer so it no longer requires or hides a local AudioSource and BoxCollider.
- Embedded spatial settings in each AudioCue instead of requiring a separate SpatialSettings asset.
- Rebuilt the AudioCue Inspector from the 1.0 UI Toolkit layout into responsive Variant, Playback, Processing, and Advanced IMGUI tabs.
- Changed WAV export from shared cue trimming to selected-variant export with optional baked fade and equalization.
- Changed exported variants to track baked processing and prevent fade or EQ from being applied twice.
- Updated the Welcome window with direct AudioCue creation, explicit manager setup, demonstration-scene access, and documentation shortcuts.
- Updated the demonstration content to use AudioCue assets, the explicit manager workflow, dedicated adapters, Input System pointer interactions, and URP sample visuals.
Fixed
- Fixed scheduled delay, segment timing, and fades continuing while playback was paused.
- Fixed selected-segment duration not accounting for randomized pitch.
- Fixed null, empty, and zero-duration cue data reaching an unsafe playback path.
- Fixed runtime variant selection state living on and mutating shared ScriptableObject data.
- Fixed stale playback references being able to target a pooled voice after reuse.
- Fixed ambiguous completion handling by separating natural completion from stop and interruption reasons.
- Fixed duplicate managers running simultaneously; a duplicate now reports the configuration error and disables itself.
- Fixed editor preview and export depending on silently readable source samples by adding an explicit Prepare Clip for Editing workflow.
Removed
- Removed the legacy
AudioClipData,AudioClipPlayer,SpatialSettings, andAudioCategoryAPI. - Removed the
AudioClipToolkitruntime namespace and oldAssets/AudioClipToolkitpackage path. - Removed the old player settings for Allow Overlap, Destroy On Finish, Destroy After Time, trigger size, trigger layer, and built-in mouse modes.
- Removed the standalone Spatial Settings editor window.
- Removed batch trimming across every clip in one asset.
- Removed the UI Toolkit USS-based Inspector implementation.
- Removed bundled TextMesh Pro Essentials and the legacy PDF manual.
Migration and compatibility
- Version 1.0 ScriptableObjects, components, prefabs, and serialized references are not migrated automatically.
- Remove the old
Assets/AudioClipToolkitfolder before importing version 2.0. - Recreate
AudioClipDataassets as AudioCue assets and reconnect component and UnityEvent references. - Add exactly one AudioManager to the first scene that can play audio.
- Replace direct
AudioClipPlayeruse with AudioCuePlayer or AudioManager API calls. - Add AudioCueTrigger or AudioCueMouseTrigger only where the corresponding interaction is required.
- Unity 6 is the target editor generation. Version 2.0.0 was validated in Unity 6000.0.81f1.
- Unity Input System is required by the runtime assembly. The included demonstration scene additionally uses Unity UI and Universal Render Pipeline.
Notes
- AudioCue runtime playback is render-pipeline independent.
- The included demonstration scene targets Universal Render Pipeline.
- WAV export creates new PCM assets and does not destructively modify source AudioClips.
- Equalizer processing supports up to eight channels and is bypassed for clips with more channels.