Audio Plugin (CCM)

This unofficial TaleSpire pluigin provides a Common Customs Menu (CCM) version of audio plugin for playing ambient and music audio.

Change Log

1.0.3: Fix versioning issue
1.0.2: Added loop controls
1.0.1: Added volume controls
1.0.1: Default audio to looping
1.0.1: Updated to use CCM 1.0.1 which allows writing registration notifications to the main screen
1.0.0: Initial release

Install

Use R2ModMan or similar installer to install this asset pack.

This plugins makes use of Asset Data Plugin if it is available. However, it is not an actual dependency (and thus not downloaded automatically) so that the plugin can still work (mostly) without it. For ideal functionality, please download Asset Data Plugin (along with a message distributor like Chat Service Plugin).

Usage

1. Open the Common Customs Menu
2. Click on the "Audio" (speaker) icon on the left.
3. Select the desired Ambient or Music group from the list.
4. Click on the desired audio within the list.

Note 1: The groups contain a control group which provides a corresponding stop command.

Note 2: The plugin uses a different speaker for ambient and music allow one ambient and one music to be played at the same time.

Where To Put Audio Files

There are two different structures that can be used for storing audio:

General:

Place desired audio files into any FAP legal location under a Audio\Ambient and/or Audio\Music folder. For example:

[LocalAudio]/CustomData/Audio/Ambient/Toads.mp3 [LocalAudio]/CustomData/Audio/Music/WeAreTheChampions.mp3

The ambient and music will show up under a General group.

Specific:

Place desired audio files into any FAP legal location under a Audio\Ambient\GroupName and/or Audio\Music\GroupName folder where "GroupName" is the name of the group under which the audio will be found. For example:

[LocalAudio]/CustomData/Audio/Ambient/Animals/Toads.mp3 [LocalAudio]/CustomData/Audio/Music/Victory/WeAreTheChampions.mp3

The ambient audio would be found under a group called Animals. The music audio would be found under a group called Victory.

Dependencies

The main feature of CCM plugins is that they are designed to be resilient to breaking due to BR or other changes. For this reason, the CCM version of ANGEL plugin tries to minimize the number of dependencies on which it relies since each of those could be a future failure point.

However, on the other hand, you don't want to re-invent the wheel for functions that already exist becuaue then you have multiple places where code does need to be updated if that functionality even need to be changed.

To address this, ANGEL uses soft dependencies. These soft dependencies use reflection to try to access the dependency plugin without actually making it a required dependency.