Documentation / Start

Get started

Troolio 10.0.8 is a .NET 10 framework for event-sourced actors on Microsoft Orleans 10. This path gets you from a package reference to a small actor, then points to the host and provider decisions that make a real application work.

On this page

Before you begin

Install the foundation

Create a project, then add the framework and Orleans build tooling. The exact version avoids mixing the five-package cohort with older builds.

dotnet new classlib -n MyApp -f net10.0
cd MyApp
dotnet add package Troolio.Core --version 10.0.8
dotnet add package Microsoft.Orleans.Sdk --version 10.0.0

Add a provider only when the host needs it:

dotnet add package Troolio.SqlServer --version 10.0.8
# or
dotnet add package Troolio.KurrentDB --version 10.0.8

Use the package guide for the roles and dependencies of all five packages. A SQL Server or KurrentDB reference does not install a production schema or select a serving route.

Follow the first application path

  1. See how Troolio works, then model a command and build your first actor with a command, an event, an event handler, and a query. The guide shows the 10.0.8 actor API.
  2. Configure a host with actor assembly registration, a store, a serializer, and Orleans services.
  3. Read actors and commands and events and state before choosing a persistence provider.
  4. For an explicitly selected atomic path, review the selected command route and atomic commit together. The route needs compatible store capabilities, authority, projection handoffs, and recovery.
  5. Plan for security and retention and deployment before serving real callers.

What the package does and what the host does

Troolio supplies actor and event contracts, command dispatch, storage abstractions, and opt-in provider surfaces. The application host authenticates callers, authorizes the current command and target, configures credentials, selects a route, operates projection and recovery workers, and sets evidence and idempotency retention windows. Installing a package by itself activates none of those decisions.

Run a complete sample

Start with Calculator, continue with the ToDo API, then explore Shopping List. The examples use public packages and include host setup, source code and storage boundaries. Packages describes the framework and optional extension version lines.