AFGUtT Setup: Step By Step

  1. Make sure you have the following software installed and ready to go.
  2. Set up the FGU Extension
    1. In FGU, enable the Alynn's FGU to Twitch Exporter Extension.
    2. Load up your campaign.
      • All Characters need owners.
      • All characters need to be in the party sheet.
      • All characters need to be in the Combat Tracker.
    3. Configure the AFGUtT Export Options to "On".
    4. Check your Campaign Folder in Fantasy Grounds and you should see a characters.xml and a tracker.xml file.

  3. If you plan on using the Twitch Extension, go to AFGUtT Self Serve Portal and create an account. Please use a legitimate email or else the account creation process will fail.

  4. Configure the Local Client
    1. In the folder where you unzipped the AFGUtT Local Client is a config.toml file, open it in a text editor of choice.
    2. If you wish, do File -> Save As (or your editor's equivilent) and save a copy of the file for future reference.
    3. Follow along with the comments in the toml file to configure the settings for the client.
    4. By default the local client will always reference config.toml, however you can specify a different config file by using the command line option -cfg <filename>.toml
    5. Start up the local client (see the readme) and it should take the configuration you provided and start watching the files created by FGU. 
    6. At this point you should go into FGU Combat Tracker and click Next Character once. This should export the data based on the configuration (text files for local, to the middleware for online).
    7. If you are only using AFGUtT locally and not using the Twitch Extension you are done.
       
  5. In the configuration page of the AFGUtT you only need to use the registration email you created in step 3, then hit submit.
         
    1. If Server Status has failed it means that the extension was unable to reach the server. This could mean a network issue between you and the middleware server, or that the server is no longer reachable. You may just need to wait and try again.
    2. If Data Status has failed it means that we were either unable to pull character data from the extension because the email was incorrect, there has been no data uploaded to the server, or an internal server issue. 
      1. If you haven't, make sure you have done step 4-7 and successfully exported the data to the middleware. The local client will show any errors if there were any to the web server.
      2. If you are unable to get both to green, please contact Alynn (yelloweyedstudio@gmail.com.

  6. At this point you should be fully good to go. When changes are made within FGU and the next character button is hit, the data is then exported by FGU. The Local Client then writes text files and/or uploads the data to the middleware server. The Twitch extension then reaches to the middleware server and pulls the data for display to the viewers.
  7. If you run into any  issues that you can't figure out please reach out to yelloweyedstudio@gmail.com