Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/twhl-community/halflife-unified-sdk/llms.txt

Use this file to discover all available pages before exploring further.

The Unified SDK ships a suite of automation tools written in .NET that handle asset synchronisation, mod packaging, game-content installation, and map upgrading. These tools are included in the hlu/tools directory of every mod installation archive and are designed to work on both Windows and Linux.

Prerequisites

All .NET tools require the .NET 6 SDK to be installed on your machine.
1

Download the .NET 6 SDK

Visit the official download page and select the .NET 6 SDK installer for your operating system:https://dotnet.microsoft.com/en-us/download
2

Run the installer

Execute the downloaded installer and follow the on-screen instructions. No additional configuration is required after installation.
3

Verify the installation

Open a terminal and confirm that the SDK is available:
dotnet --version
The output should show a 6.x.x version string.

Launching .NET Tools

Every Unified SDK tool ships as both a Windows executable (.exe) and a portable .NET assembly (.dll). Choose the appropriate approach for your platform.
On Windows you can launch a tool by double-clicking its .exe in File Explorer, or by running it from a Command Prompt or PowerShell window:
path\to\tools\ToolName.exe [options] <arguments>
Running from a command window is recommended when you need to pass options or review the tool’s output.

Common Command-Line Options

All Unified SDK tools are built with System.CommandLine, which provides a consistent set of built-in options across every tool.
OptionDescription
--versionDisplay version information for the tool and exit.
-?, -h, --helpDisplay help text including a description of the tool’s purpose and a full list of available options and arguments.
Always run a tool with --help first when exploring its functionality. The help output lists every available option with descriptions and shows which arguments are required.

Available Tools

AssetSynchronizer

Copies assets from the assets repository to your mod directory and monitors for changes in real time.

Packager

Creates a timestamped ZIP distribution archive of your mod installation and removes old archives on success.

ContentInstaller

Copies, converts, and upgrades maps from Half-Life, Opposing Force, and Blue Shift into the mod directory.

MapUpgrader

Standalone tool to upgrade a custom map made for vanilla Half-Life to the Unified SDK format.

Mod Setup

Learn how AssetSynchronizer and Packager fit into the full development and release workflow.

Project Structure

Understand the repository layout and where the C# tools source code lives.

Build docs developers (and LLMs) love