Registering plugins in Varjo Software

Introduction

This document describes the process of making the tracking plugin available to Varjo software.

Plugin installation

The plugin DLL should be installed in the location chosen by the vendor (or user), e.g.

%ProgramFiles%\<vendor_name>\<product_name>\Plugins\Varjo\plugin.dll

Plugin registration

After the installation, the plugin should be made available for the Varjo software stack. This is done by writing a JSON file, (also known as a plugin manifest file) containing the plugin description.

This file should be installed in:

%ProgramData%\Varjo\VarjoTracking\Plugins\<vendor_name>\<tracking_product_name_plugin>.manifest

Notes:

• The manifest file name can be arbitrary
• Manifest file name extension must be .manifest

Plugin manifest file is a JSON file containing following information:

{
    "manifestFileVersion": "1.0.0.0",
    "ID": "<GUID>",
    "vendorName": "<Tracker system vendor name>",
    "productName": "<Tracker product name>",
    "path": "<absolute path to the tracker plugin DLL>",
    "configurationOptions": []
}

Example:

{
    "manifestFileVersion": "1.0.0.0",
    "ID": "{E6F31B4E-015F-4719-BDDB-8758E400A6BC}",
    "vendorName": "Vendor",
    "productName": "Advanced Tracker",
    "path": "C:\\Program Files\\Vendor\\Product\\Plugins\\Varjo\\Plugin.dll",
    "configurationOptions": [
        {
            "id": "serverAddress",
            "label": "Server IP address",
            "type": "text",
            "defaultValue": "192.168.0.1"
        }
    ]
}

Notes:

• All fields should be UTF-8 encoded
• Field productName is allowed to contain an empty string
• Field ID is an RFC-4122 UUID in Microsoft GUID format e.g.: {123e4567-e89b-12d3-a456-426655440000}
• Configuration options listed in the configurationOptions array will be shown in the VarjoBase UI.