Skip to Content
This documentation is provided with the HEAT environment and describes this HEAT instance.
DevelopersHEAT CaptureCapture pluginsHCP VBSInstall HCP VBS

Install HCP VBS

Before you start

  • Windows 10 or 11 x64.
  • VBS4  25.1 or later, with Gears Studio installed for component management and deployment.
  • HEAT Capture running and reachable from this workstation.

VRAI distributes HCP VBS to customers as a built Gears Studio component package; it is not published as a GitHub release. Building it yourself from source is only needed for development - see Build from source below.

Install the supplied package

  1. Obtain the HCP VBS component package from VRAI for the hcp-VBS version you are deploying.

  2. In Gears Studio, use component management to import or copy the supplied HCPVBS component into VBS4.

  3. Confirm the four configuration files are present next to the deployed DLL, in VBS4’s mycomponents/HCPVBS/ folder:

    FilePurpose
    HCPVBSConfig.jsonTransport, session endpoints and collection settings
    DISMappings.jsonFallback VBS object type to DIS type mapping
    DISConfigNameMappings.jsonPrimary VBS config-class-name to DIS type mapping
    EntityDenyList.jsonEntities to exclude from tracking

  4. Edit HCPVBSConfig.json before first launch - see Configure; the values shipped in the package are not usable against current HEAT Capture as they stand.

  5. Start VBS4. The component loads automatically through the Gears component system.

Verify the install

Start a mission with HEAT Capture running and a user signed in. Check the VBS4 / Gears log for:

HCPVBS loaded
HCPVBS Connecting

With a working WebSocket configuration (see Configure), the console log shows onopen once the connection to HEAT Capture succeeds. Confirm entities are arriving by checking HEAT Capture’s own session view for the workstation VBS4 is running on.

⚠️

HCPVBS loaded and HCPVBS Connecting appear even when nothing on the other end is listening. Neither line is proof that HEAT Capture is receiving data - see Troubleshooting.

Build from source

Only needed for development against hcp-VBS itself, not for deploying the VRAI-supplied package above.

  1. In Gears Studio, create a new project named HCPVBS with the project folder set to HCPVBS-dev.

  2. Inside that project folder, clone or copy the hcp-VBS repository into a subdirectory named HCPVBS - this is the repository root Gears Studio expects.

  3. In Gears Studio, select Import Component and point it at the HCPVBS repository folder.

  4. Generate the solution in Gears Studio, then open build/vs2022/HCPVBS.sln in Visual Studio 2022 (v143 toolset, C++20).

  5. Select the ReleaseWithSymbols | x64 configuration and build the solution. Gears Studio deploys the output DLL into VBS4’s component folder; the four configuration files still need editing per Configure before first launch.

Uninstall

Remove the HCPVBS folder from VBS4’s mycomponents/ directory, or use Gears Studio’s component management to unload it. No credentials or session data are stored outside that folder; the four JSON configuration files are the only state left behind.

HEAT Capture team. Last updated 2 October 2026.

Opens your browser's print dialog. Choose "Save as PDF" as the destination.
HCP VBSConfigure HCP VBS