MK Syrinscape Sound Links module

[mattekure]

This extension and associated module make it easy to trigger Syrinscape sounds from within Fantasy Grounds. This extension is compatible with both the Syrinscape Online and Genre players (Fantasy & Sci-Fi).

The Fantasy Grounds module containing the sounds is not included with the automated download as it will be unique to each user. The sound link module is created by converting a CSV file which is provided by Syrinscape. There are two options to generate your sound links module, a web service and an offline conversion utility.
Web Service: https://mattekure.com/Syrin2FG/ This method can take a bit of time as it depends on the size of your CSV, your upload speed, the web server load, and download speeds.
Offline Utility: https://github.com/mattekure/SyrinCSV2FG/releases Source code and executables are available here. Please note, some Anti-Virus applications have wrongly flagged this file as potentially harmful. If you have any concerns, please use the Web service instead.

Using either of these methods will produce a unique, fully up to date syrinscape sound links module including any custom sounds you may create using the online soundset creator. These will not however, create links for any sounds created directly in the fantasy or sci-fi clients as those are not reported to Syrinscape and not included in your CSV file.

This extension and an optional sound triggers module are now available on the Forge
Syrinscape Sounds
https://forge.fantasygrounds.com/shop/items/117/view
Chat Triggers Module (contains nearly 800 premade chat triggers)
https://forge.fantasygrounds.com/shop/items/118/view

With the mandatory move from DMsGuild to the Smiteworks Forge, the Classic version is no longer available for purchase. If you have previously purchased, updates will still be available on DMsGuild, but all future purchases will be on the Forge for Unity.

Linux and Mac users
With the release of v23, a separate URL application is no longer necessary if using Syrinscape Online. Fantasy Grounds v4.20 introduced a new function which allows the links to work directly with the Syrinscape web API. The below links are only for users using the old Classic version.

FG Classic Only
Currently the Syrinscape Players for Linux and Mac do not have the ability to handle syrinscape links properly. Some members of the community have created some workarounds detailed below.
MAC Users Mac Syrinscape Bridge for Syrinscape Online. https://github.com/Moroverse/syrinscape_bridge/releases
Linux Users - Syrinscape Online Linux URI Handler for Syrinscape Online (tested only on Ubuntu) https://github.com/mattekure/Syrinsc...ndler/releases
Linux Users - Fantasy or Sci-fi Linux URI Handler for Syrinscape Fantasy & Sci-fi Players https://forum.syrinscape.com/t/linux...dling/10030/28

Youtube Playlist:
https://www.youtube.com/playlist?lis...jWMgtP5kkUPFV-

Features:

• Access to all sounds included in your Syrinscape subscription, including any made in the online soundset creator
• Begin Playback or Stop syrinscape sounds
• Sound records can be linked in story entries to make soundboards
• Play and Stop buttons can be dragged to form links which immediately begin playback or stop the sound.
• Chat triggers can be defined to automatically begin playback of sounds based on text appearing in chat.
• Chat triggers can include or exclude the name of the PC/NPC in the pattern matching
• Chat triggers can be set to trigger on hidden messages, or restricted to only messages visible to players.
• Syrinscape Online global volume and global oneshot volume can now be controlled within FG
• Volume controls are now draggable and linkable

v24 adds a new slash command.
/syrindebug [on|off] - turning on syrin debug will output a message to chat for each sound played, and each trigger matched.

Chat Trigger instructions video.
https://www.youtube.com/watch?v=i6GNCO7Mtlk

An awesome community member has release a new utility to help with making chat triggers. Check it out. https://www.fantasygrounds.com/forum...-Chat-Triggers

[mattekure]

Sound Module Generation
The Fantasy Grounds module containing the sounds is not included with the automated download as it will be unique to each user. The sound link module is created by converting a CSV file which is provided by Syrinscape. There are two options to generate your sound links module, a web service and an offline conversion utility.
Web Service: https://mattekure.com/Syrin2FG/ This method can take a bit of time as it depends on the size of your CSV, your upload speed, the web server load, and download speeds.
Offline Utility: https://github.com/mattekure/SyrinCSV2FG/releases Source code and executables are available here. Please note, some Anti-Virus applications have wrongly flagged this file as potentially harmful. If you have any concerns, please use the Web service instead.

[Ulric]

I purchased your mod and read the readme.txt. I put it in the correct folder and loaded a Starfinder campaign and loaded the module in my library. Syrinscape is running and I can hear sounds when I activate them in Syrinscape but not in FGC. I am running on a Mac using the FGC WINE install. Was this mod tested for this type of install?

[mattekure]

I have tested in Starfinder, and they work. But I have no ability to test with a Mac. I suspect there is an issue between WINE and the syrinscape protocol handlers, but I have no way to test.

[mattekure]

I purchased your mod and read the readme.txt. I put it in the correct folder and loaded a Starfinder campaign and loaded the module in my library. Syrinscape is running and I can hear sounds when I activate them in Syrinscape but not in FGC. I am running on a Mac using the FGC WINE install. Was this mod tested for this type of install?

DMGuild is also pretty good about allowing returns if you cant get it to work, just contact their support and explain that the module is incompatible with your setup.

[dmbrown]

If this is similar to dulux’s solution then it won’t work on a Mac without a little work around. Below is a link to a write up I did on how to get FG and Syrinscape to work on a Mac through Wine using Dulux’s extension. The only problem is I never found a way to patch the audio through Wine into Discord for example. Maybe when the online player version is available it will work better with Macs as it should allow for links to web addresses.

https://www.fantasygrounds.com/forum...scape-on-a-Mac

[mattekure]

I believe the underlying method of triggering the URL works the same way that dulux's did. Its an Instance.openWindow() call which triggers it. So it would suffer from the same limitations with Mac, WINE, and those complicated setups.

[Ulric]

DMGuild is also pretty good about allowing returns if you cant get it to work, just contact their support and explain that the module is incompatible with your setup.

I also have windows computers but I like Macs! No need for a refund but thanks for the suggestion. I will tinker with it and try to install Syrinscape in WINE with FGC.

[Hector Trelane]

Thanks for the prompt and timely responsiveness mattekure.

Just got this extension, and I'm excited to make use of it. I'm using mostly MoreCore and so have been underutilizing Syrinscape up to now. This is a good use of $--offload lots of link management to a paid mod such as this.

[dmbrown]

I think it might work in FGC on the Mac with the online player when you have that ready, as that is using web urls and I believe the Mac OS will allow that.