Skip to content

Verify and activate

After the engine is installed, we need to ensure it's up and running, and activate license to be able to use it. Both steps need ViveEngineAdm, the administration tool included with ViveEngine.

Locate ViveEngineAdm tool

ViveEngineAdm lives in the engine installation directory.

Windows

Open the engine installation directory in File Explorer.

For the Shared edition, the default location is:

C:\Program Files\ViveEngine (Shared)\

Ensure this file exists:

ViveEngineAdm.bat

Open a terminal in this directory:

  1. Click the address bar in File Explorer.
  2. Type cmd.
  3. Press Enter.

Then check that the tool runs:

.\ViveEngineAdm.bat --version

macOS

Open Terminal and go to the engine installation directory.

For the Shared edition, the directory is:

cd "/Library/Application Support/ViveEngine (Shared)"

Ensure that ViveEngineAdm symlink exists:

ls -l ViveEngineAdm

And that the tool runs:

./ViveEngineAdm --version

Verify the engine is running

Note

Don't forget rebooting computer after installation. Engine services may not be fully registered until after reboot.

Run the status command:

.\ViveEngineAdm.bat status

./ViveEngineAdm status

You should see a status report like this:

ViveEngine status report

    Profile:   engine.shared/prod
    Edition:   ViveEngine (Shared) 1.3.0

    RPC interface:   online
    RPC address:     127.0.0.1:49172

    Orchestrator state:   online
    Gateway state         online
    Driver state:         online

Make sure all engine services are online before continuing.

Activate your license

Run one of the activation commands below.

Available activation methods depend on your engine edition.

Note

License activation is per OS user. If several users on the same machine need to use ViveEngine, activate the license separately for each user.

Tip

Activation contacts the licensing service. If activation fails, check internet access first, then verify that the selected activation method is supported by your engine edition.

Start a trial

Use this if your edition supports trial activation:

.\ViveEngineAdm.bat activate_license --trial

./ViveEngineAdm activate_license --trial

Trial activation is machine-bound and does not need a license key or account credentials.

Activate with a license key

Use this if you received a license key:

.\ViveEngineAdm.bat activate_license --key

./ViveEngineAdm activate_license --key

The tool prompts for the license key.

For scripted setup, you can read the key from a file:

.\ViveEngineAdm.bat activate_license --key --file=C:\path\to\key.txt

./ViveEngineAdm activate_license --key --file=/path/to/key.txt

Activate with account credentials

Use this if your license is attached to a ViveSound account:

.\ViveEngineAdm.bat activate_license --email=user@example.com

./ViveEngineAdm activate_license --email=user@example.com

The tool prompts for the account password.

For scripted setup, you can read the password from a file:

.\ViveEngineAdm.bat activate_license --email=user@example.com --file=C:\path\to\password.txt

./ViveEngineAdm activate_license --email=user@example.com --file=/path/to/password.txt

Check license status

After activation, verify the current user's license state:

.\ViveEngineAdm.bat license_info

./ViveEngineAdm license_info

A successful activation shows IsVerified: true and details for the active license, such as activation mode, features, activation date, and expiration date.

Example:

License info:

    IsVerified:      true

    Mode:            activation_key
    Type:            node_locked

    Activation ID:   8f3b7c2a-4e91-4c6d-9a25-1d7e5b8f0c43
    Features:        voice_enhancements byoc_captioning

    Key:             VSND-2K9M-7Q4P-X8R3-N6T1

    Activations:     7 / 100

    IssueDate:       2026-06-15
    ActivationDate:  2026-07-06
    ExpirationDate:  2027-06-15

If IsVerified is not true, the engine is installed but this user is not ready to use licensed processing yet. Run activation again with the correct method.

Next step

The next step is installing ViveSound SDK. You'll need it to talk to the engine and develop plugins: