SpeedTree Modeler licensing

The SpeedTree Modeler requires a valid license to run. When the application starts, the SpeedTree Licensing dialog appears if a license has not yet been activated.

There are two ways to license the SpeedTree Modeler:

Both methods unlock the full functionality of the Modeler once a valid license is detected.

Log in with a Unity ID

If you purchased your SpeedTree license online, the best way to activate SpeedTree is to log in with your Unity ID. This uses the standard Unity authentication workflow and automatically checks your account for a valid SpeedTree license.

To activate the license with a Unity ID, follow these steps:

  1. Launch the SpeedTree Modeler.

  2. In the menu, select License info.

  3. In the SpeedTree Licensing window, select Login with Unity ID.

    The SpeedTree Licensing window with the "Login with Unity ID" option selected.

  4. Select Login.

  5. Complete the Unity sign-in process in your browser.

  6. Once the authentication is complete, the SpeedTree Modeler automatically verifies your license and starts.

  7. If multiple licenses are associated with your account, the Modeler automatically selects the appropriate license.

Tab reference

Option Description
Login Opens your default web browser to log in with your Unity ID.
Force fresh login Clears any cached authentication and prompts a new Unity sign-in.
Purchase now Opens your default web browser to purchase a SpeedTree license online.
Manage account Opens your default web browser to manage your Unity account online.

Use a license file

Traditional licensing is available for Enterprise customers. The license is either tied to a single machine (with a node-locked license), or it receives licenses from a license server (with a floating license).

The SpeedTree Modeler utilizes RLM from Reprise Software, Inc. to manage all licensing. They provide an RLM End-User Manual that may be useful if you are having licensing issues. Also, please contact licensing@speedtree.com if you are having trouble licensing the SpeedTree Modeler.

To request, apply, and manage a license file for trial licenses and node-locked licenses, follow these steps:

  1. Launch the SpeedTree Modeler.

  2. In the menu, select License info.

  3. In the SpeedTree Licensing window, select Use a license.

Note: To manage floating licenses, the process is different, ask your IT department to follow the corresponding steps.

The SpeedTree Licensing window with the "Use a license" option selected.

Tab reference

Option Description
Information Displays your license information when you have a license already set up.
License The box to paste the license key into when you receive one.
Request license Allows you to send a SpeedTree license request.
Purchase now Opens your default web browser to purchase a SpeedTree license online.
Apply License Applies the license according to the key specified in the License box.

Trial licenses

When you first run the SpeedTree Modeler, you are in trial mode. This mode lets you use the Modeler, but it only lasts a few days so you can try out the Modeler before you buy it.

The trial mode includes the following limitations:

  • Exporting meshes is limited by having random polygons removed.
  • Exported animations are limited to 100 frames.

In the event that you have not had adequate time to evaluate the application during its free trial period, you can request an extension. Contact licensing@speedtree.com for a trial license extension.

Node-locked licenses

Node-locked licenses allow the SpeedTree Modeler to run on a single machine.

To use a node-locked license, you need to request a key for use on your machine. Follow these steps:

  1. Select Request license to submit a license request. You will receive an email containing a license string.

  2. Paste that string into the License box.

  3. Select Apply License.

Floating licenses

Floating licenses work by running a license server on a machine designated to be the host and then having each installation of the Modeler look to that host to get a license.

Ask someone from your IT department to contact licensing@speedtree.com to set up a license server. We will walk you through the process, which involves these steps:

  1. Select a machine that will be the license server for your company.

  2. Download the "End User Bundle" that matches the platform of your license server from Reprise Software (https://reprisesoftware.com/support/admin/).

  3. Run the command rlmutil rlmhostid. Email the hostid(s) along with the name of the license server to licensing@speedtree.com.

  4. You will receive two files: idvinc.set and customer.lic (where customer.lic is a license file unique to your company).

  5. Place these files in the End User Bundle folder and run the rlm binary. The license server is now running.

  6. Once the license server is running, all that remains is to make each installation of the SpeedTree Modeler know where to get its license. The easiest way to do that is to copy the .lic into the folder where the Modeler executable resides.

    Alternatively, you can copy the contents of the .lic file into the License box in the Modeler. The Modeler uses the first line of the file to find the license server and check out a license.

  7. To administer the license server, open a browser and enter *myhostmachine*:5054 in the address bar.

    This opens the license server's embedded web interface for checking license usage, license server status, and all other administration utilities. For a detailed description of license server management, refer to RLM's end-user manual.

Getting through a firewall

You can specify ports in the license file to ensure it can get through your firewall. Modifying the ports in the license file doesn't require us to re-sign the license, so you can add/change them as needed.

On the host line, you can specify the port that clients use communicate with the server

HOST *<hostname> <hostid> <port #>*

There is also a port for the ISV itself to communicate with the main server process. This port is chosen randomly if it is not supplied. Usually, this is fine, but occasionally you do need to set this port, as well, depending on your firewall settings.

ISV idvinc port=*<port #>*

Alternate means to specify a license

Putting the license info directly into the dialog in the Modeler is often the easiest method, but there are alternatives to use when installing in a multi-user environment or deploying an install to a network.

An environment variable can be used to store the license. This variable is idvinc_LICENSE. Note that this is case-sensitive, even on Windows.

You may also place a file next to the executable which holds the license. All files next to the executable with the ".lic" extension get scanned as possible licenses to use.

Note

License files take precedence, so remember if you place one and later try to update your license from within the Modeler.