Skip to content
This repository has been archived by the owner on Nov 17, 2022. It is now read-only.

X-Streamer v.0.7.0

Compare
Choose a tag to compare
@kingargyle kingargyle released this 12 Nov 16:47
· 21 commits to master since this release

This is the released version of X-Streamer v0.7.0. This release adds support for Imperial Assault overlays.

Requirements

  • Java JDK 1.8
  • Installation of either the XWing Fonts or the Imperial Assault Fonts depending on which overlays you want to use.
  • Imperial Assault needs internet access to be able to access Deployment Card and Command Card images, Skirmish Maps do not need internet access.
  • Both need an internet connection or a way to read saved JSON files to import squads or armies.
  • TableTop Admiral is the recommended Army Builder to use with X-Streamer at this time as it supports the necessary JSON file exports.

Installation

  • Download the appropriate ZIP/Tar file for your platform.
  • Extract the application to a directory
  • Launch the xstreamer binary for the platform.
  • Configure your preferences: Edit->Preferences
    • Fill in the general section and then select either the Imperial Assault or X-Wing Preferences.
    • Select where you want the Files to be Generated
    • Select your preferred template if the option exists.
    • Save the preferences.
  • If you want to use Imperial Assault switch that perspective (upper right corner select the perspective icon, select Imperial Assault).
  • Load Squads or Armies.
  • Set up your Streaming software to display the generated overlays.
  • Have Fun!

What's New

This section covers the features between two support games now and the overlays.

Screenshots

screenshot from 2017-10-30 20-30-02

screenshot from 2017-10-30 20-32-52

X-Wing

  • X-Wing Ship symbols will appear next to each of the pilots.
  • Fix bug where discarded indicator was not showing up in right aligned X-Wing template.
  • When a pilot is destroyed, a Skull and Crossbones indicator will be placed next to the pilot.
  • Critical Hit and Upgrade Discard indicators
  • Reworked the Player 1 and Player 2 screens. Now properties are displayed in a seperate view. Update the property and press enter and the squadron overlay is regenerated automatically.
  • New Image Viewer. When selecting a Pilot or Upgrade within a list, the cards image will be displayed. You can zoom in/out, rotate, and Save the image to an external directory. You can use the image in OBS Studio or X-Split by using an Image Source.
    • When viewing pilots or upgrade cards, the image will be exported to xstreamer_xwing_pilot.png and xstreamer_xwing_upgrade_card.png. If you use these as ImageSources when you select a pilot in the list, it will automatically update the image source and display in OBS Studio and XSplit. You don't need to use a Window Screen Capture to handle the images, just treat them as another overlay source. Image quality will not be lost.
    • Images will be exported to the same directory that you specify the Overlays to be generated.
  • Updated to latest ships through Guns for Hire and latest FAQ.

Imperial Assault

  • New Imperial Assault Perspective and Preference Settings. Click the icon in the upper Right corner to get the list of available perspectives. The application defaults to the X-Wing Perspective.
  • Ability to import Player Armies using the Imperial Assault Interchange Format. Currently Tabletop Admiral squad builder is the only one that supports exporting into this format. You must be logged into Tabletop Admiral and then you can select to Download as JSON. Use the Import Army section to paste the json into the input box and then select Import. Each player tab has this option available.
  • Ability to View the Deployment Cards and Command Cards for each of the armies. Currently you need an active Internet connection to use this feature as the images are currently retrieved from external sources.
  • Ability to mark a unit dead by changing it's Health to 0.
  • When viewing an image for a deployment or command card exported images are saved locally to the following file names, xstreamer_command_card.png and xstreamer_deployment_card.png. Use these as ImageSources in OBS Studio or XSplit and when you select them in the players list, they will automatically be displayed in the ImageSource in OBS Studio or XSplit.
  • Ability to view the Skirmish Map and display it in an ImageSource overlay. Skirmish Maps are accessed through the MAP view and they are modified images of the Imperial Assault Skirmish Map Project.
    • Images are Transparent PNGs, suitable for displaying on a black background on the stream.
      • You can use these as possible input for Telestrators, or just to comment on where figures may be going or use them as inputs to mark where objectives are setup.
      • Images are optimized for low memory usage and have been run through TinyPNG to help keep the quality
    • Images are in HD resoultion so should work well for most any stream.
    • Maps are automatically exported to the same directory that you specify that Imperial Assault overlays to be generated.
      • Maps are saved as xstreamer_skirmish_map.png
  • Imperial Assault Overlays have the option to be automatically refreshed in when imported using a Browser Source. This is checked by default and most people should not need to change this. This guarantees that you get the latest information displayed when you update the information in XStreamer. If you are using Linux you can turn this off as the automatic reload is handled by OBS Linux Browser Source.
  • Imperial Assault Overlays are generated for Deployment Cards and Command Cards. These are two separate files and can be used however you want to display in your list. If there are requests for modification of these files please open issues and we can look at creating some new templates.
    • Imperial Assault Deployment cards will display the faction the group belongs too.
    • Displays health, movement, and number of units in a group.
    • Displays whether the figure is alive or dead.
    • Command Cards display the name and point cost, also whether the card has been discarded or not.

This is the first stage of imperial assault support. Please open issues with feature enhancements, or if I'm missing any information for cards and command cards. Please feel free to submit pull requests to update the deployment db and command card db with relevant information. They are JSON files so can be easily edited in any text editor.