by celestian
Total Subscribers:
Description
WARNING, THIS EXTENSION WILL NO LONGER BE UPDATED. FGU has support for this functionality built in now.
I've put together an extension called AudioOverseer that allows you to control sound for a higher level of immersion in your FantasyGrounds games. It should work on CoreRPG layered rulesets (I've tested with 2E and 5E). It leans heavily on the use of Syrinscape Fantasy & Online Player. If/when sound support is added into FGU directly I'll integrate that functionality.
AudioOverseer Features
- Works with FGC and FGU.
- Manage sounds (via links).
- Filter/search all sounds (triggers and collections).
- Trigger Sounds based on text that appears in a line of text but not multi-line. (set sound, linked sounds or a random sound from a list of sounds).
- Collections of Sounds to play a group of sounds for a specific ambient theme.
- General sounds and Collections have links that can be conveniently placed into story entries, chat or object descriptions where it can be clicked to play the audio.
- Supports Syrinscape Online & Fantasy Player.
- Import options for Syrinscape link file (can be downloaded)
- Export all records so you can use them in other campaigns as a module.
Notes Regarding how Triggers Work
- Triggers should generally assume that the matches will be in close proximity in chat lines.
- Once a trigger is fired, the previous match tracking will be reset.
- It will not cross match multiple triggers because of the previous note.
- Repeat matches within a trigger will reset tracking of a trigger.
- Single line matching also works.
What AO DOESN'T do.
Fantasy Grounds does not natively support playing sound files. Because of that...The system assumes you stream/push the audio to the players either using something like Syrinscape Online or VLC Stream or Cleanfeed.org.
If you would like to see even more features added to AudioOverseer, while using Syrinscape, such as the ability to adjust volume of specific sound link or looping, repeat, playback count, or random play repeat timers then visit the Syrinscape forums and request they add the ability to add those options into the API url calls. I've made requests for those features but they declined each of them. Perhaps they will acquiesce to the suggestions if more folks than I request them.
Visit the forum post for AudioOverseer for extensive discussions, tutorial vids and other resources.
https://www.fantasygrounds.com/forums/showthread.php?53583-AudioOverseer-(Audio-Management-Extension)
It is highly recommended to watch the tutorial videos to understand how to use and manage AO.
Check out this tutorial video on basics for AudioOverseer.
Collections
Collections are a group of sounds that play in a persistent fashion (typically) so you can have a combination of various ambient sounds. In the example case I use, in the Elemental Plane of Air... so wind, lightning, gusts along with a bit of music that plays.
Here is a short video on how to create a "Collection" using AudioOverseer.
Example Sound Boards
Here is another short tutorial video on how I make "Sound Boards" using sound links provided in AudioOverseer.
Example Audio Triggers
How I setup Triggers in AudioOverseer to play sounds based on text that appears in chat.
Setup and Debug
If you are using Syrinscape Online Player be sure to add your token via "/ao token XXXXX" where XXXXX is the token you get from the Syrinscape My Account page.
If you are using the Syrinscape Fantasy (local player) you will need to set SOURCE to SOURCE 1. If you are using the Syrinscape Online Player you need to set your SOURCE to SOURCE 2 in Campaign options.
MAC/Apple users. Please review this post. It might help you.
If you are using a MAC there is a optional method you can use if the above doesn't work. You'll need to set the method option via "/ao method local". This sends commands through your browser as currently the Syrinscape Online player for mac does not have that functionality.
If you are using the Syrinscape Online Player web interface to copy "sound paths" you must manually remove the "?auth_token=XXX" part of that string. It is HIGHLY recommended to not manually add sounds in this manner, download the CSV file and import them.
If you are still having problems:
- Download the latest version and remove all "folders" of the same name of this extension in the extensions folder.
- Disable ALL OTHER EXTENSIONS except AudioOverseer.
- If triggering sounds is a problem, make sure GM rolls are set to SHOW in Campaign Settings.
- Enable debug output "/ao debug enable"
- Type "/console"
- If Trigger issues: Type the text in chat of the trigger you'd like to activate and review the debug output.
- If still Trigger or general sounds not playing: Click "Play" on a sound. (click a sound link)
- Review that output to see why sound is not playing.
- Verify you are using the right source in your configuration. Source 1 for Player, Source 2 for Online
- If you are still unable to resolve why your sound isn't playing copy the output from the Console.
- Create a post here and paste the console output into in with your question.
- Note the operating system, version of FG (FGU or FGC), ruleset and version of ruleset and exact procedure you are trying to play a sound.
- NOTE THE VERSION OF FG AT THE TOP.
I've included a sample module that contains some examples of triggers and collections along with the Syrinscape Online Player "Free" version sound links.
UUID 853c5326-e9a7-11eb-8c52-0050562be458