Get started

Installing the tools

You do this once. After that, one dotnet new command is enough for every new Komod.

Prerequisites

What Note
.NET 10 SDK Windows, Linux and macOS. Check: dotnet --version (10.x).
An editor Visual Studio 2022 / 2026 (.NET desktop and ASP.NET workloads), JetBrains Rider, or VS Code with C# Dev Kit.
A running KOFA To try your Komod. The installer can be downloaded from kofa.kncsk.hu (Windows, Linux).

1. Add the KOFA NuGet source

The SDK packages, the templates and the kofa-pack tool are on KOFA's own NuGet source (they are not on nuget.org).

dotnet nuget add source https://kofa.kncsk.hu/nuget/v3/index.json --name kofa

Check:

dotnet nuget list source

Note

In Visual Studio the same is: Tools → NuGet Package Manager → Package Manager Settings → Package Sources → +, name kofa, source: the address above. A source added with dotnet nuget add source is also valid in VS (shared user NuGet.Config).

2. Install the templates

dotnet new install Kofa.Komod.Template

Two templates are added:

Short name What it creates
kofa-komod One Komod (server part + optional UI tile): an empty skeleton with the most common elements.
kofa-komod-quickstart Two cooperating Komods (thermometer and thermostat): the finished result of the tutorial.

List them: dotnet new list kofa. Update for a newer SDK: run the same dotnet new install command again.

Visual Studio: after dotnet new install the templates appear in the Create a new project window, search for "KOFA" (restart VS if it was open). Rider: the New Solution window shows them. VS Code: dotnet new kofa-komod in the terminal.

3. The kofa-pack tool

dotnet tool install --global Kofa.Pack

The command is called kofa-pack. It checks and packs the Komod, and can publish it to the Komod store. Update: dotnet tool update --global Kofa.Pack.

4. A running KOFA to try things on

Install KOFA from the download page (the Windows or Linux version is fine for development), open it in the browser, and create the admin account with the setup token printed at the first start. You upload Komod packages on the Komodok page.

What gets installed and what does not

Your project gets the Kofa.Abstractions and Kofa.Abstractions.Ui NuGet packages as compile-time references: they are not copied into your package, because the running KOFA provides them. You never need the KOFA source code.

Next: The first two Komods.