Generate Vortex Embed Add-on License Files

When you purchase a Vortex Studio product with a Vortex Studio Embed Add-on, CM Labs sends you activation keys that you can use to generate the application license files. The Application is called a Custom Vortex Application.

Generating a License File for a Custom Application

Some licenses let you embed Vortex Studio functionality in other applications. To embed Vortex Studio in a different application to create simulation content, you need to generate a special license which enables Vortex Studio functionality within the custom application.

Licenses for custom applications are node-locked to the executable file of your application. You only need a single copy of the executable to copy to all the computers that use your application. Each time the executable file changes, you must generate the license again.

You must activate the license from a computer with internet access.

Generating a License File for a Custom Application on Windows

  1. Launch the Vortex License Manager.
  2. If you have a valid license on the computer, you will see it listed. To generate another license, select Add Another License / Renew Existing License.
  3. Click Internet Activation.
  4. Enter your activation key. The license type is "node-locked".
  5. Select Activate for an Executable.
  6. Click on the ... button and navigate to your Vortex Studio application .exe file..
  7. Click Activate.
  8. Enter a name for your license file. By default, the .lic file is saved in the same folder as your application .exe file.
  9. Click Save. If successful, a license file is generated in the selected folder.
  10. If needed, copy the .lic file generated with every copy of your application .exe file.

Generating a License file for a Custom Application on Linux

  1. Activate your key to generate your license by launching the Vortex License Manager with the following parameters:

    ./VortexLicenseManager --activate-executable <your key> <file path to your application executable> <file path to the generated .lic file>

    If successful, a license file was generated at the given location.

  2. If needed, copy the .lic file generated with every copy of your executable.

Generate Vortex Embed Add-on licenses for a Simulator

The Vortex Studio Director is only available on Windows. The Vortex License Manager in distributed mode can only be used on this platform.

 Simulators typically rely on several networked computers running Vortex Studio software at the same time to function correctly. For convenience, you can activate and install a license for all the hosts in a simulator system at the same time from the Vortex Studio Director application.

  1. Launch the Vortex Studio Director application
  2. Click to select the simulator that you want to install the licenses on.
    1. Make sure that the application path is set to your custom executable file
  3. Click the Licenses tab.
  4. Click Inspect All.
    The Vortex Studio License Manager application opens in Distributed Mode, showing a list of the computers for the simulator.
  5. To generate a new license, click Add Another License/Renew Existing License.
  6. Click to select Internet Activation
  7. In the Activation Key field, type your Embed activation key.
    The executable that you chose for your simulator will show up in the Embed Executable field.
    Only the nodes that run this executable will show up in the list since you only need the license on these computers.
  8. Click Activate
    The application installs a license on each computer and shows the activation status. To verify that the installation was successful, you can find the new license file in the license folder of each computer.

If you have multiple applications that embed Vortex, repeat this process for each executable file.