Skip to content
HxEngine HxEngine

Getting Started

This guide takes you from a clean clone to a running editor.

Prerequisites

Section titled “Prerequisites”
  • Windows 10/11 (x64) — the renderer targets Direct3D 11.
  • .NET 9 SDK — dotnet --version should report 9.x.
  • A GPU with Direct3D 11 feature level 11_0 or newer.

Get access

Section titled “Get access”

HxEngine is currently in private development. Source access is granted on request — contact the developer for early access.

Build

Section titled “Build”

Once you have the source, build the solution:

Terminal window
dotnet build HxEngine.sln

Run the editor

Section titled “Run the editor”
Terminal window
dotnet run --project editor/Hx.Editor/Hx.Editor.csproj

The editor opens with a dockable layout — scene view, inspector, asset browser and the console. From here you can create a scene, drop in entities and hit play.

Run the tests

Section titled “Run the tests”
Terminal window
dotnet test HxEngine.sln

The suite covers the core systems (entities, rendering, physics, animation and more).

Project layout

Section titled “Project layout”
PathContents
src/Engine runtime — Foundation, Core, RHI, Rendering, Engine and subsystems
editor/The Avalonia editor (Hx.Editor)
tests/Unit and integration tests
EngineContent/Built-in templates and default content

Next steps

Section titled “Next steps”