Linking TeamSpeak & Syrinscape

From Fantasy Grounds Wiki
Jump to: navigation, search

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 Window
    Adding 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 Window
    Adding 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 Button
    If 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 Window
    Adding 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 Window
    Adding 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 Window
    If 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 effect
    You 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.

Links

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.