Skip to main content
  1. Chyron
  2. PRIME VSAR
  3. Guides

01. PRIME VSAR INSTALLATION

01. PRIME VSAR INSTALLATION

Installation and configuration steps.

đź“ťSupported platforms are Windows 10 x64 and Windows 11 x64.

Installation Note

Possible Windows Defender prompt, when trying to run installers. In some configuration, one may get a warning like the following:

image30.png

In that case, click on the “More info” link and then “Run anyway”

image13.png
‎

License

The following should be done only once, during the first installation.

For any license update, step 3) to 8) may be re-run, after features are added through Download Area (DA).

 

  1. Plug the provided dongle in a USB port.
  2. Install Sentinel System Driver.
  3. Run ChyronHegoLicenseUpdater.
  4. The updater will now show the current licenses.
  5. Click Yes.
  6. Make sure your license has been updated from within the DA.
    1. VSAR(Fresh)
      1. Option: Primitive Library
    2. Cesium
      1. Option: Parallax
  7. The updater will now show the licenses to be updated.
  8. Click Yes to update your license.
  9. After this License updater will show you what licenses, options and what validity you have.
  10. Please make sure this matches with your ordered configuration - namely Hal Inputs and outputs.

image61.png image87.png


‎ 

Cesium

Cesium is the software that manages translation of any (raw or pre-processed) tracking data coming from any provider into virtual 3D space coordinates.

  1. Install Cesium running its corresponding Windows installer (should look like Cesium_5.6.NNN_Windows_10_Pro.exe - NNN being release ID).
  2. Follow the instructions above, if Windows Defender prompts for an unrecognized application.
  3. After the installation is done, you may want to try and run Cesium.
    ‎The following pop-up signals the software is not able to find the license.

    image35.png

    If not already done, plug in the USB dongle with the provided license and run again.
    ‎Cesium should open fine.

    image97.png

  4. Open any of your tracking file or one provided as sample that can be found at
    ‎%ProgramFiles%\Chyron\Cesium\data\cesium\samples
    ‎For instance Simulation.cs.
  5. For setting up customized and/or your actual tracking environment, refer to the dedicated Cesium manual.
  6. To check proper connection in PRIME VSAR, see below, in Configuration Panel.
    ‎

PRIME VSAR Tools

PRIME VSAR Tools provide a couple of utilities that help PRIME VSAR users to manage the environment, like connection with the CAMIO Universe and other remote access software.

 

  1. Install PRIME VSAR Tools, using related Windows installer.
  2. Follow instructions above, if Windows Defender prompts for an unrecognized application.

 

PRIME VSAR Web

Gives the ability to remotely control aspects of PRIME VSAR from a web browser. It’s part of the PRIME VSAR Tools installation.

Make sure the version of PRIME VSAR Tools matches the PRIME VSAR version or install PRIME VSAR Tools that is included in the PRIME VSAR installation to ensure full compatibility.

Services used by VSAR Web can be registered at the end of PRIME VSAR Tools installation:

 

 

image56.png

We highly recommend enabling and starting all the marked services after installation.

Along with the VSAR Web service there is also Envoy service and VSAR Controller service that needs to be registered and running in order for VSAR Web to function properly.

Services can be seen if they are registered and are running in the Services window ( Win + R - “services.msc”):

image93.png

VSAR Web configuration

By default VSAR Web is hosted on the Local machine and can be accessed on http://localhost:8080/ or on local network with the ip address of the machine followed by the port (:8080). This port can be changed in the website configuration file VsarWebProd.env that is located in the PRIME VSAR Tools installation folder bin\config\VsarWebProd.env.

 

There is a separate configuration file VSAR Web, the static website located in PRIME VSAR Tools installation folder%ProgramFiles%/Chyron/PRIME_VSAR-Tools_xxx/bin/build/config.js. (where xxx is a current VSAR Tools version) this file contains:

  • port to the Envoy service
  • refresh time
  • material settings (range, advanced) for chroma keyer

 

Envoy service configuration

VSAR Web expects the Envoy service to be on the same machine.

Envoy works as proxy for VSAR Web, it is a third party tool, more about Envoy proxy on (https://www.envoyproxy.io/)

Configuration for Envoy service is located in the PRIME VSAR Tools installation folder (mentioned above) bin\envoy.yaml . Inside the config section vsar_controller_service there is an ip address and port that should be set to the machine that has VSAR Controller service installed.

VSAR Controller service configuration

VSAR Controller allows VSAR Web to run commands on multiple VSAR Renderers, this allows the division of work between multiple machines.

When adding new VSAR to VSAR Controller

  1. Make a copy of the Unreal project
  2. (this is needed only if project are on the same machine) Change the port in the project files Config\DefaultMithril.ini (create the file if it doesn't exist) and entry
    ‎example:
    ‎[/Script/Mithril.MtGrpcHandler]
    ‎Address=localhost:50051
  3. Add new VSAR to VSAR Controller configuration located in PRIME VSAR Tools installation folder bin\config\config.ini
    1. add name of the VSAR to VSAR_NAME_LIST
      ‎ example:
      ‎[VSAR_NAME_LIST]
      ‎VSAR_LIST=MY_VSAR,NEW_VSAR
    2. add entry with the suffix "_URL"
      ‎example:
      ‎[NEW_VSAR_URL]
      ‎VSAR_IP=127.0.0.1
      ‎VSAR_PORT=50051
      ‎VSAR_POOL=1
      ‎VSAR_ENABLED=1

 

PRIME VSAR

Multiple PRIME VSAR versions can be installed on the same machine, there is no need to uninstall a previous version prior to installing a new one. Warning: it is recommended to uninstall any previous version prior, if expecting to work with only the last one.

 

  1. Log in to the Chyron Download Area with your username and password, and search for the PRIME VSAR product.

The PRIME VSAR release name includes the following information

  • Associated VSAR version (for example, 2.3.1)
  • Associated Epic’s Unreal Engine version (for example, 5.6.1)
  • Full Build or Plugin version *

* The Full Build version of VSAR includes the installation of Epic's Unreal Engine; the Plugin or Standalone version requires the user to already have a compatible version of Epic's Unreal Engine installed.

For example, 2.3.1-5.6-plugin refers to

  • PRIME VSAR v2.3.1
  • Epic’s Unreal Engine v5.6.1
  • Plugin

 

  1. Install PRIME VSAR, by double clicking the .exe file (should look like PRIME_VSAR_2.3.1.xxxx-Setup.exe).
    ‎
  2. PRIME VSAR Full Build Destination Location - This is the folder where you want to install the full build of PRIME VSAR. By convention, it's recommended to use the suggested folder.

    image43.png

    PRIME VSAR Plugin / Standalone Destination Location - This is the root folder for the Plugin’s compatible version of Epic's Unreal Engine. VSAR automatically detects if you already have that version installed. If you wish, you can specify a different root directory. The plugin will automatically be installed in rootfolder/Engine/Plugins/Chyronhego.

    image9.png

  3. Follow instructions above, if Windows Defender prompts for an unrecognized application.
  4. If not already installed, you may be prompted for .NET Framework 3.5 installation.
  5. When asked about components you wish to install, install all components shown in the installer except the Prime VSAR Tools if installed in the previous steps, or unless you have a specific reason not to install Prime VSAR Tools.

image69.png

The “Full Installation” includes the following list of components:

  • PRIME VSAR: PRIME VSAR Core software
  • PRIME VSAR Tools: Additional Tools and Services for remote connectivity
  • Chyron Panels / Live Assist Panels: Control Panel application *
  • Development environment: To work with nDisplay and Switchboard
  • Sentinel License Key Driver: Driver for the USB Dongle License *
  • License Updater: Chyron’s license manger *
  • Diagnostic Tools: Debug purposes

* Can be downloaded from Chyron’s Download Area and installed separately


‎ 

To update PRIME VSAR only, we recommend selecting the "Compact Installation" option.

image15.png

  1. During the installation process of the Chyron Panels (Live Assist Panels), select the Software license option
  2. When prompted to restart your computer, do so.
  3. Successful installation

image29.png

In the case of the Plugin version, it is activated automatically after installation. If the PRIME VSAR Plugin is not activated after installation, you can open your version of Unreal Engine, and under Edit > Plugins, search for "VSAR" to activate/deactivate it manually.

image94.png

 

 

 

Chyron Panels (Live Assist Panels)

The Chyron Panels (Live Assist Panels) web server has to be started manually by clicking on the LIVE Assist Panels Desktop shortcut.

  • Run it to start the web server. You should get the following output:

image98.png

 

  • Open Chrome and type in the following URL to open the Panel web page: http://localhost. Login default credentials are admin / adminLAP

image40.png