Linking with External Services and Applications

Sync Your Fantasy Grounds Account To Steam

In this screenshot tutorial we are going to show you how to sync your Fantasy Grounds account to Steam.

Syncing your account to Steam allows your Steam account to communicate with the Fantasy Grounds server so you can download any of the DLC that you purchase for Fantasy Grounds while using Steam.

One important thing to note: When you want to Complete a Bundle or start working to complete a Bundle like Dungeons & Dragons 5e, Devin Night Tokens, Deadlands, Castles & Crusades, etc, we recommend using either Steam or the Fantasy Grounds website to complete the bundle. Unfortunately the two different storefronts cannot communicate with each other to complete a bundle from both stores at once. So stick to either Steam or the Fantasy Grounds website for completing bundles.

Please be aware that Steam accounts should only be linked to one Fantasy Grounds account at a time. If it is linked to more than one account, it will need to be unlinked and relinked to the primary account. Never share your Steam or Fantasy Grounds password with other users.


1. There are two ways to sync your Fantasy Grounds account to Steam. The first way is going to the Fantasy Grounds website HERE: https://www.fantasygrounds.com/store/syncSteamAccount.xcp

The second way is going into your Fantasy Grounds Settings and in the purchases section click the Account tab.

Then inside of the Manage section Click on the Link Steam Purchases Button.

2. Which ever way you decide to access the Steam synchronization page it will bring you to this screen on a browser that will pop up.

This is where you will need to be logged into your Steam account.

Once logged in, click on the Sign In Through Steam Button and follow any instructions.

3. Lastly, you will need to click on the Refresh Steam Purchases Button.

You can refresh your Steam purchases at any time if there is an item that is showing in your Steam account but not on your Fantasy Grounds account. Always give Steam at least 5 minutes or more to synchronize all items with Fantasy Grounds before resynching.

That is it! You are all sync'd up to Steam.

Just remember to make sure you go back to your Fantasy Grounds start up page and hit the Update Button anytime you purchase DLC on Steam.

Removing the Steam link from your Fantasy Grounds account

You can unlink your Steam account on the same webpage used to link your account originally.
Link: https://www.fantasygrounds.com/store/syncSteamAccount.xcp
You can also get there by clicking the Link Steam button on the Account tab in Settings as seen above.

Sync Your Fantasy Grounds Account To Paizo

In this screenshot tutorial you are going to learn how to sync your Fantasy Account to the Paizo website.

When you sync your Fantasy Grounds account to the Paizo website it will give you the appropriate discounted price on any official Paizo PDF products that you have purchased from Paizo (if a discount applies to the item. There may be exceptions). This only counts for PDF's and not physical products. This discount does not apply to third party products sold on the Paizo website.

This works the other way as well. If you purchase a Paizo product from our Fantasy Grounds store at regular price you can go to the Paizo website and download that PDF.

One thing to note: If you get a refund on a Paizo purchased product and you have downloaded the PDF than the price of the PDF will be taken out of the refund.

 

The first thing you will need to do is go to the Paizo.com website and log into your account. If you do not have an account you will need to create one.

Once inside of your Paizo.com account click on My Account. You are going to need to get a Auth Token.

Next you will need to click on Manage Partner Authorizations in the My Partner Authorizations section. This will give you the code you will need.

After you will need to use this code from Paizo to sync your Fantasy Account.

Now that you have your Activation Code, there are two ways to sync your Fantasy Grounds account to the Paizo website. The first way is going to the Fantasy Grounds website [HERE: https://www.fantasygrounds.com/store/syncPaizoAccount.xcp]

The second way is going into your Fantasy Grounds Settings and click on the Account tab.

Then on the Account tab, click the Link Paizo button.

Which ever way you decide to access the Paizo synchronization page it will bring you to this screen on a browser that will pop up. This is where you will take the Activation Code you got from the Paizo website and put it into the Auth Token Box. Then click on the Authorize Account Button.

Lastly, all you need to do is retrieve your Paizo purchases to start receiving your discounts (if any apply to your purchases) on Paizo modules or send your purchases from Fantasy Grounds to Paizo to get your PDF's.

And that is it! You are all sync'd up and ready to go!

Using the Audio Overseer Extension To Use Syrinscape with Fantasy Grounds Unity

The following tutorial video was created by Lord Gwydion (Discord: Gwydion#0391) based on the Ccelestian’s Audio Overseer extension found on the FG Forge.

Tutorial Video:

This is a very detailed tutorial for Celestian's Audio Oversser Extension. This is an audio mamagement tool for use with Fantasy Grounds. It can be used to trigger sounds from Syrinscape and also for files on your computer.

https://www.youtube.com/watch?v=GARUiFaBpF8

The Audio Overseer (Audio Management) Extension

Description (by Celestian)

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.

Please see the full FG Forge page description or Forum thread for important details, more information, to report any bugs you may encounter or simply ask questions about installation and use.

Audio Overseer extension in FG Forge:

Link: https://forge.fantasygrounds.com/shop/items/94/view

Audio Overseer extension forum thread:

Link: https://www.fantasygrounds.com/forums/showthread.php?53583-AudioOverseer-(Audio-Management-Extension

Syrinscape, Web and Local Audio using Kenku FM with Discord Bot for Stereo Sounds (August, 2022)

Fantasy Grounds user Amerisun has created a tutorial on Reddit explaining how to use Syrinscape with Fantasy Grounds via a Discord bot. From the thread:

I have a new method for an old tutorial I had for using Syrinscape and Fantasy Grounds using a Discord Bot for sweet stereo sound. If you combine this with an extension called AudioOverseer, so when someone attacks or crits it sends one shot noises through, it's such a great experience for the players and DM alike.

This should also work when the integration comes out in Fantasy Grounds directly to Syrinscape, as this would still use the URL of your Syrinscape Online player to play through Discord. This is especially useful as I find most players even when given the URL will not open it or close it on accident and forget about the sounds, but they are always in Discord with you on audio.

This new tutorial uses the Syrinscape Online Player with the new Web Player functionality in combination with a new piece of software called Kenku FM where you can combine local files and online website music and audio in combination with Syrinscape.

Tutorial video:

I made a new tutorial that replaces a lot of the complicated pieces of trying to get Syrinscape to work with Discord. This method is easier than the previous by a landslide. I hope you enjoy it!

Video Chapters:
0:00 Intro
0:35 Download and Install Kenku FM
1:39 Discord Bot Creation
3:04 Connect Bot to Kenku FM
4:11 Connect Syrinscape to Kenku FM
6:13 Kenku overview showing how to use local audio

Kenku FM links:
https://www.kenku.fm/ - Main Download Link
https://www.kenku.fm/docs - Documentation for the application

SyrinScape link: https://www.syrinscape.com

Discord Bot Setup link: https://discord.com/developers/applic...

Link to Amerisun’s Discord Server: https://discord.gg/Ky5G7m8WMa

Linking Syrinscape, Discord & Fantasy Grounds Unity - Thick Client Method (OUTDATED but still functional)

Fantasy Grounds user Amerisun has created a tutorial on Reddit explaining how to use Syrinscape with Fantasy Grounds via a Discord bot. From the thread:

I created a tutorial for using Syrinscape and Fantasy Grounds using a Discord Bot for sweet stereo sound. If you combine this with an extension called AudioOverseer, so when someone attacks, or crits it sends one shot noises through, it's such a great experience for the players and DM alike.

Tutorial video:

 

Instead of using SyrinScape, you could have anything output to the Virtual Audio Cable to get Stereo sound through a Discord bot and use most of the tutorial and just not install SyrinScape.

 

Turorial video link: https://www.youtube.com/watch?v=lZ1FlHRjthc
AudioOverseer extension link: https://www.fantasygrounds.com/forums/showthread.php?53583-AudioOverseer-(Audio-Management-Extension))
Reddit link:

Linking TeamSpeak & Syrinscape (OUTDATED - for legacy information purposes only)

The DOE Sound Extension that is used in the following tutorial is no longer available and, should you still have a downloaded copy, doesn’t work with Fantasy Grounds Unity. Please use the information above for Discord & Syrinscape or the extension listed below.

There is currently an audio extension that works with Fantasy Grounds Classic and Unity called AudioOverseer (Audio Management Extension). From the author:

Forum Link: https://www.fantasygrounds.com/forums/showthread.php?53583-AudioOverseer-(Audio-Management-Extension)

With the inclusion of the DOE Sound Extension and the resulting use of some third-party audio and VoIP applications (primarily Syrinscape and TeamSpeak) this Wiki Page has been put together to help people configure everything properly so as to make the use of sound and music in games as seamless as possible. Although these instructions are aimed primarily at Syrinscape and Teamspeak, the information should be useful to link up any audio application to any VoIP application - as an example, the instructions for using the popular VLC Media Player with TeamSpeak are also included.

Teamspeak is a free VoIP Client that enables people to speak to each other over the Internet, and works by connecting to any number of (free) TeamSpeak Servers located around the world, including the FG-Community TeamSpeak Server run by the community members who organize the popular FG-Con.

Syrinscape is a free audio player designed to play sounds and music particularly relevant to Role-Playing Games. Syrinscape packages its sounds and music into Sound Packs, and it comes with two Sound Packs free. Other Sound packs can be purchased or the entire library of Sound Packs can be unlocked via a monthly subscription.

VLC Media Player is a free, fully-featured generic media player that plays all types of video and audio files.

The links to all of these applications (and others) are included below.

What We're Going To Do

To understand what we're going to do we need to understand how everything fits together. As the GM, Fantasy Grounds (via the DOE Sound Extension) uses Syrinscape to play sound effects and music, which we then need to send over the Internet via TeamSpeak (our VoIP application). But we also need to send our own voice over the Internet via TeamSpeak as well (if we are using voice in our games).

To accomplish this what we are going to do is set up our audio application (Syrinscape and/or VLC) as a separate user on TeamSpeak (our VoIP application). We do things this way because it allows us to connect to a given TeamSpeak Channel both as ourselves (for regular voice communication) and as our audio application (for music and sound effects) and it means that other people on the channel can set the volume, etc, of the two sources of sound (our voice and the audio application) separately, including being able to set the music and sound effects OFF completely if they don't want to hear them.

It is also possible to extend this methodology to include a third, forth or even more sources of sound in our TeamSpeak Channel if we want.

TeamSpeak normally takes as its source sound from out microphone, and TeamSpeak also normally outputs its sound to our speakers or headphones. Syrinscape (and VLC) also normally output their sound to our speakers or headphones. So we need to set things up so that TeamSpeak takes as it source sound from Syrinscape. But how do we accomplish this? Well, if we were connecting two devices together in the real world we'd need a cable, just like the HDMI Cable we use to connect our DVD player to our TV. But as both TeamSpeak and Syrinscape are on our computer, we need a Virtual Cable. We can then get Syrinscape to output its sound to the Virtual Cable and at the same time get TeamSpeak to take its sound from the 'other end' of the Virtual Cable.

There are a number of Virtual Audio Cables available, but we'll be using VB-Cable, a free Virtual Audio Cable. You you can make a donation to the makers of VB-Cable and receive two extra Virtual Audio Cables (VB-A and VB-B) for a total of three, if you like. The link to VB-Cable is included below.

Step-By-Step Setup

So now we know about all of the components we need to get sound to work for out games, follow the below steps to set everything up. We only have to do this Setup once, so while it may be a lot of steps its shouldn't take that long (maybe 5 minutes after all of the software is downloaded/installed).

Step 1 - Downloading

First, if you haven't already, download and install TeamSpeak, Syrinscape and VB-Cable (and VLC if you'd like to use that application). Each program installs as a typical Windows application, although you might have to unzip the VB-Cable download first.

Step 2 - Adding Identities

Each source of sound that we are going to feed into TeamSpeak needs its own Identity within TeamSpeak. Most people simply use the Default Identity, but we're going to set up all the Identities we need, including one for our Voice.

  1. Start TeamSpeak

  2. Go to the TeamSpeak Identities by either:

    • Clicking on Settings->Identities, or

    • Typing CTRL+I

    Adding an Identity for Yourself (your Voice)

  3. Click the Add Button towards to top-left corner of the Identities Window

  4. In the Identity Entrybox type in your desired name (eg 'GM')

  5. In the Nickname Entrybox type in your desired nickname (eg 'GM Nickname')Adding an Identity for Syrinscape (or VLC)

  6. Click the Add Button

  7. In the Identity Entrybox type in the name you'll use for Syrinscape's connection (eg 'GM Sounds')

  8. In the Nickname Entrybox type in the nickname you'll use for Syrinscape's connection (eg 'GM Sounds')If you want to create a third (or a forth, fifth, etc) Identity (eg so you can use other audio applications through TeamSpeak at the same time) then follow Sub-Steps 6-8 above again.

  9. Click the OK Button along the bottom of the Identities Window

Step 3 - Adding Profiles

In addition to a TeamSpeak Identity for each sound source we need to create a Capture Profile for each sound source, and also a Playback Profile for our Voice so we can hear what is being said/played on any TeamSpeak Channel we join. Syrinscape (and VLC) doesn't require a Playback Profile because Syrinscape can't 'hear' anything.

  1. Start TeamSpeak (if its not already stated)

  2. Go to the TeamSpeak Options by either:

    • Clicking on Settings->Options, or

    • Typing ALT+P

    Adding a Playback Profile for Yourself (your Voice)

  3. Click the Playback Button on the left-side of the Options Window

  4. Click the + Button (Add profile) towards the bottom-left of the Options Window

  5. In the Profile Name Entrybox type in the same name you used for your Identity (eg 'GM')

  6. Click the OK Button along the bottom of the Create Profile Window

  7. Making sure the new Profile has focus (click on it to make sure), in the Playback Device Dropdown List select your preferred speakers or headphone

  8. Click the Apply Button along the bottom of the Options WindowAdding a Capture Profile for Yourself

  9. Click the Capture Button on the left-side of the Options Window

  10. Click the + Button (Add profile)

  11. In the Profile Name Entrybox type in the same name you used for your Identity (eg 'GM')

  12. Click the OK Button along the bottom of the Create Profile Window

  13. Making sure the new Profile has focus (click on it to make sure), in the Capture Device Dropdown List select your preferred microphone

  14. Click the Apply Button along the bottom of the Options WindowAdding a Capture Profile for Syrinscape (or VLC)

  15. Click the + Button (Add profile)

  16. In the Profile Name Entrybox type in the same name you used for Syrinscape's connection (eg 'GM Sounds')

  17. Click the OK Button along the bottom of the Create Profile Window

  18. Making sure the new Profile has focus (click on it to make sure), in the Capture Device Dropdown List select 'CABLE Output (VB-Audio Virtual Cable)' or your preferred Virtual Cable

  19. Select the Continuous Transmission Radiobutton

  20. Uncheck the Advanced Options Checkbox

  21. Click the Apply ButtonIf you want to create a third (or a forth, fifth, etc) Capture Profile (eg so you can use other audio applications through TeamSpeak at the same time) then follow Sub-Steps 15-21 above again, but you need to choose a different Virtual Audio Cable (eg VB-A or VB-B) at Sub-Step 18.

  22. Click the OK Button along the bottom of the Options Window

Step 4 - Tying It All Together

To tie everything together we're going to create a TeamSpeak Bookmark for each sound source. As a TeamSpeak Bookmark also stores information about a particular TeamSpeak Server, you may need to set up a set of these Bookmarks for each TeamSpeak Server you connect to.

  1. Start TeamSpeak (if its not already stated)

  2. Go to the TeamSpeak Bookmarks by either:

    • Clicking on Bookmarks->Manage Bookmarks, or

    • Typing CTRL+B

  3. Click the More Button toward the bottom-left of the Bookmarks WindowAdding a Bookmark for Yourself (your Voice)

  4. Click the Add Bookmark Button towards to top-left corner of the Bookmarks Window

  5. In the Label Entrybox type in the name of the TeamSpeak Server you want to use along with your Identity Name from Step 2 (eg 'FG-Con Server - GM')

  6. In the Address Entrybox type in the IP Address or the URL/Name of the TeamSpeak Server you want to use (eg 'ts.fg-con.com')

  7. Enter an appropriate Nickname into the Nickname Entrybox

  8. If the TeamSpeak Server has a password, type it into the Server Password Entrybox

  9. In the Identity Dropdown List select the Identity we created for use with our Voice (eg 'GM')

  10. In the Capture Profile Dropdown List select the Capture Profile we created for use with our Voice (eg 'GM')

  11. In the Playback Profile Dropdown List select the Playback Profile we created for use with our Voice (eg 'GM')

  12. Click the Apply Button along the bottom of the Bookmarks WindowAdding a Bookmark for Syrinscape (or VLC)

  13. Click the Add Bookmark Button

  14. In the Label Entrybox type in the name of the TeamSpeak Server along with Syrinscape's Identity Name from Step 2 (eg 'FG-Con Server - GM Sounds')

  15. In the Address Entrybox type in the IP Address or the URL/Name of the TeamSpeak Server (eg 'ts.fg-con.com')

  16. Enter an appropriate Nickname into the Nickname Entrybox

  17. If the TeamSpeak Server has a password, type it into the Server Password Entrybox

  18. In the Identity Dropdown List select the Identity we created for use with Syrinscape (eg 'GM Sounds')

  19. In the Capture Profile Dropdown List select the Capture Profile we created for use with Syrinscape (eg 'GM Sounds')

  20. In the Playback Profile Dropdown List select 'None'

  21. Click the Apply Button along the bottom of the Bookmarks WindowIf you want to create a third (or a forth, fifth, etc) Bookmark (eg so you can use other audio applications through TeamSpeak at the same time) then follow Sub-Steps 13-21 above again.

  22. Click the OK Button along the bottom of the Bookmarks Window

And that's it for setting up.

Running The System

So, how do we actually use all this? Well, we need to connect to TeamSpeak as us (our Voice) and we need to connect a second time as Syrinscape (and a third, forth, etc, time with another audio application, if we want), but we also need to tell Syrinscape (and/or VLC) to use the Virtual Audio Cable. How to do this is all outlined below:

Connecting As Us (Our Voice)

Follow these steps to connect to use Voice over TeamSpeak:

  1. Start TeamSpeak

  2. Go to the TeamSpeak Bookmarks by Clicking on Bookmarks

  3. Click on the Bookmark we created for ourselves (eg 'FG-Con Server - GM')

That's it! You should connect to the chosen TeamSpeak Server with your preferred microphone and speakers/headphones.

Connecting As Syrinscape

All audio applications use the Windows Default Output Device (speakers, virtual cable, etc) unless told otherwise. Unfortunately, at this time there is no way to tell Syrinscape how to use a different Output Device from the Windows Default. This is a limitation of the Unity Engine which powers Syrinscape, not Syrinscape itself. So we need to change the Windows Default Output Device before we start Syrinescape to get it to work with TeamSpeak. Follow these steps to connect to use Syrinscape over TeamSpeak:

  1. Go to Windows Sound by either:

    • Going to the Control Panel and Clicking on Sound, or

    • Right-Clicking on the Speaker Icon in the Windows System Tray and selecting Playback devices

  2. On the Playback Tab select the other end of the Virtual Audio Cable we selected in Step 3, Point 18 above (eg 'CABLE Input (VB-Audio Virtual Cable)')

  3. Click on the Set Default Button towards the bottom-righ of the Sound Window

  4. Start Syrinscape

  5. On the Playback Tab of the Sound Window choose your preferred Output Device (eg your speakers) to reset everything the way it was. Syrinscape only needs the Default Output Device set when it first starts - after that we can change the Default Output Device and Syrinscape won't know or care.

  6. Click on the Set Default Button towards the bottom-right of the Sound Window.

  7. Click the OK Button along the bottom of the Sounds Window

  8. Start TeamSpeak (if its not already stated)

  9. Go to the TeamSpeak Bookmarks by Clicking on Bookmarks

  10. Right-Click on the Bookmark we created for Syrinscape (eg 'FG-Con Server - GM Sounds')

  11. Choose Connect in new tab to run the Syrinscape connection simultaneously with another connection

That's it! Syrinscape should connect to the chosen TeamSpeak Server via the Virtual Audio Cable and you can use Syrinscape to play audio as normal.

Connecting As VLC Media Player

VLC allows us to specify which Output Device (speakers, virtual cable, etc) it uses. Follow these steps to connect to use VLC over TeamSpeak:

  1. Start VLC Media Player

  2. Go to the VLC Preferences by either:

    • Clicking on Tools->Preferences, or

    • Typing CTRL+P

  3. Click the Audio Button along the top of the Preferences Window

  4. In the Output Module Dropdown List select Direct X audio output

  5. In the new Device Dropdown List which is now displayed select the other end of the Virtual Audio Cable you selected in Step 3, Point 18 above (eg 'CABLE Input (VB-Audio Virtual Cable)')

  6. Click the Save Button along the bottom of the Preferences Window

  7. Close down and restart VLC to make sure the new Preferences take effectYou can make these changes once if VLC will permanently be used to connect to TeamSpeak, but if you use VLC to play audio or video that you want to hear and see on your computer, you need to follow these Sub-Steps again and set the Output Module Dropdown List back to 'Default'.

  8. Start TeamSpeak (if its not already stated)

  9. Go to the TeamSpeak Bookmarks by Clicking on Bookmarks

  10. Right-Click on the Bookmark you created for VLC (eg 'FG-Con Server - VLC')

  11. Choose Connect in new tab to run the VLC connection simultaneously with another connection

That's it! VLC should connect to the chosen TeamSpeak Server via the Virtual Audio Cable (or via a 2nd Virtual Audio Cable, if that is what you set up) and you can use VLC to play audio as normal.

Here are the Webpages for all of the software mentioned on the Wiki Page

Acknowledgments

The original information for this article was developed by the Community Member Blackie - thank you to him for providing it.

Tools to Assist With Exporting Characters from D&D Beyond

The most up-to-date version of the D&D Beyond to Fantasy Grounds Character Converter can be found here:
Link: https://www.alexanderkorn.nl/dnd2fg/

If you need assistance with the tool, please feel free to join their Discord server where the tool is being maintained, located here:
Link:
For questions, you can contact the tool maintainer on Discord @ zeroking#8318

Community Developer Zacchaeus has created a video showing how to import and export characters in Fantasy Grounds Unity (FGU), and also covers how to export character information from D&D Beyond and import the character in FGU.