Installation

Prerequisites

Make sure the following tools are installed before building TK Clip Manager:

RequirementVersionPurpose
.NET SDK8.0 LTSBackend service compilation
Windows10/11 x64Target OS (Windows Service)
Node.jsLTS (v22)Overwolf CLI & frontend build
Overwolf CLILatestnpm install -g @overwolf/ow-cli
OverwolfLatestGame Events Provider integration
FFmpegLatestClip extraction
Python3.12+Batch clip extraction scripts

Clone the Repository

git clone <repo-url>
cd TKClipManager

Verify Environment

Run the prerequisites check script to validate your setup:

.\Scripts\check-prerequisites.ps1

This will verify that all required tools are installed and at the correct versions.

Build

The unified build script handles everything:

# Full build (debug)
.\build.ps1

# Clean release build
.\build.ps1 -Clean -Publish

# Run tests only
dotnet test TKClipManager.sln

# Build with MSI installer
.\build.ps1 -Publish -PackageMsi

Build Flags

FlagDescription
-ConfigurationDebug (default) or Release
-CleanClean before building
-PublishCreate publish artifacts
-SkipTestsSkip unit test execution
-PackageMsiBuild the WiX v4 MSI installer
-SignBinariesAuthenticode-sign binaries
-VersionSet the build version string

Code Signing

TK Clip Manager supports Authenticode code signing. Set the certificate thumbprint once:

$env:CODE_SIGNING_THUMBPRINT = "<your-thumbprint>"

All subsequent builds will sign binaries and MSI packages automatically.

Next Steps

  • Quick Start — Run the backend and open the dashboard.