Building
The launcher requires .NET 10 SDK and Git. Node.js and npm are needed only for the documentation site
Clone and build
Run these commands in a terminal:
git clone https://github.com/hyprismteam/Hyprism.git
cd Hyprism
dotnet restore Hyprism.slnx
dotnet build Hyprism.slnx
The solution builds Core, Desktop, Local Node, and their test projects
Desktop resources
Avalonia automatically includes .axaml and .paml files as AvaloniaXaml items. The Desktop project's Assets/** resource glob excludes these items so each resource is embedded once. Keep this exclusion when changing the asset layout.
Run Desktop
dotnet run --project Sources/Hyprism.Desktop/Hyprism.Desktop.csproj
Desktop uses the same data directory as a packaged launcher unless you override it. To keep development data separate on Linux or macOS
hyprism_data="$(mktemp -d)"
HYPRISM_DATA="$hyprism_data" dotnet run \
--project Sources/Hyprism.Desktop/Hyprism.Desktop.csproj
On Windows PowerShell:
$hyprismData = Join-Path ([IO.Path]::GetTempPath()) ("hyprism-dev-" + [guid]::NewGuid())
New-Item -ItemType Directory -Path $hyprismData | Out-Null
$env:HYPRISM_DATA = $hyprismData
dotnet run --project Sources/Hyprism.Desktop/Hyprism.Desktop.csproj
The directory must exist before startup. It is retained after exit so you can inspect logs and state
Build a release configuration
dotnet build Hyprism.slnx --configuration Release
A build creates development binaries. Use Packaging and releases for self-contained applications and installable artifacts
Verify a change
Run the relevant test suite, then validate documentation when behavior or contributor workflows change
cd Docs
npm run check
PAGES_BASE_PATH=/Hyprism/docs npm run build
The documentation export is written to Docs/out