Skip to content

Installation ​

1. Automatic installation (Setup) ​

Download and run HelpChatAI_Setup.exe. It:

  • finds the RAD Studio versions installed on the machine and lets you choose which ones to install into;
  • copies the library where you decide;
  • builds the runtime packages (Win32 and Win64) and the design-time ones;
  • installs the design-time packages in the IDE, so the components appear in the palette;
  • adds a HELPCHATAIDIR environment variable and the source paths to the library path.

If a previous version is installed it is removed first.

The setup choosing the Delphi versions to install into

Silent installation

HelpChatAI_Setup.exe /DIR="C:\Dev\HelpChatAI" /SILENT /RADStudioVersions=all installs into every RAD Studio found; /RADStudioVersions=37.0,23.0 restricts it to Delphi 13 and 12.

2. Installation with DPM (Delphi Package Manager) ​

The library is also published on delphi.dev as the package EtheaDev.HelpChatAI (Delphi 10.4 to 13, Win32 and Win64): you can install it with DPM, the Delphi Package Manager, as an alternative to the Setup. From the IDE, right click on your project in the Project Manager and choose Manage DPM Packages, or from the command line:

dpm install EtheaDev.HelpChatAI <path of your project>.dproj

DPM downloads the package, builds it for the Delphi version and the platforms of your project and adds it to the project. Its dependencies are installed automatically: EtheaDev.MarkdownProcessor from delphi.dev and Indy from your Delphi installation. The package also copies the WebView2Loader.dll of the platform next to your executable (see below).

3. Manual installation ​

  1. Get the sources (clone or download the repository).

  2. Open the group project of your Delphi version:

    packages\Delphi13\HelpChatAIPackages.groupproj
    packages\Delphi12\HelpChatAIPackages.groupproj
    packages\Delphi11\HelpChatAIPackages.groupproj
    packages\Delphi10.4\HelpChatAIPackages.groupproj
  3. Build the group (Release), then Install the design-time packages: dclHelpChatAIVcl, and dclHelpChatAIFmx from Delphi 12 on. The first project of the group is the MarkdownProcessor of Ethea, which the engine requires: it is built before the others, and an IDE that already has it loaded has to be closed first.

  4. Add to the library path of every platform you target:

    <HelpChatAI>\source
    <HelpChatAI>\Ext\MarkdownProcessor\source
  5. For Test HelpChat... and the Appearance preview inside the IDE, either define the IDE environment variable HELPCHATAIDIR (Tools > Options > Environment Variables) as the folder of the library, or copy Redist\WebView2\<x86|x64>\WebView2Loader.dll into the output folder of your project. The Setup does the first for you.

From a command line, packages\BuildAllPackages.ps1 builds every version installed on the machine - the MarkdownProcessor first, then the runtime and design-time packages - and ends with a table of the results; packages\BuildAllPackagesD13.ps1 (and D12, D11, D10.4) builds one version.

The packages ​

PackageKindContents
HelpChatAIruntimethe engine: store, providers, index, actions, the panel page
HelpChatAIServerruntimethe transports: local server, remote client, remote server, host channel
HelpChatAIVclruntimeTVclHelpChatAI, the chat control, VCL style theming
dclHelpChatAIVcldesignpalette registration ("Ethea HelpChat"), the component editor with the configuration editor and the preview, the property editors
HelpChatAIFmxruntimeTFmxHelpChatAI and its chat control (Delphi 12+)
dclHelpChatAIFmxdesignpalette registration and the component editor of the FireMonkey component, with the configuration editor and the preview (Delphi 12+)

The .dpk files are identical across Delphi versions; what changes in the .dproj is the ProjectVersion and the folder the DCUs go to (Lib\<version>).

4. What your application has to ship ​

WebView2 (VCL, and FMX on Windows) ​

The chat is rendered by the Microsoft WebView2 runtime, which is part of Windows 11 and of every machine with a recent Edge. What your application must carry next to its executable is the loader DLL:

Redist\WebView2\x86\WebView2Loader.dll   →  next to your Win32 exe
Redist\WebView2\x64\WebView2Loader.dll   →  next to your Win64 exe

The documentation index ​

If you use docsearch or a model provider, ship help-index.json (see The documentation index) next to the executable, or point Settings.DocIndexFile at it.

Nothing else ​

No database, no service to install, no port to open in the firewall: the local transport binds 127.0.0.1 on a free port and is reachable only from the machine itself.

5. Check that it works ​

Drop a TVclHelpChatAI on a form, right-click it and choose Test HelpChat...: the chat opens in a modal window, with no API key and no network connection. A component left as it was dropped answers with the placeholder of the stub provider, which is enough to see the WebView2 page and the panel at work; set Settings.Provider to docsearch and point Settings.DocIndexFile at an index and it answers from that manual.

The sample application comes as source

The installer brings the sample application, under CRM Demo\VCL (and CRM Demo\FMX for FireMonkey), as source and not as an executable: open its project, run it and press F1 on any screen — that is the component working on a real manual, and with a Claude key in %APPDATA%\HelpChatAI\helpchatai.json you can also ask it to open a screen, create a lead or prepare a proposal.

Released under the Apache License 2.0