Building

Building

This page describes how to build SimpleXisoDrive from source.

---

Prerequisites

Requirement	Notes
Windows 10/11	Required; the project targets net10.0-windows.
.NET 10 SDK	Version 10.0.0 or later. The repository pins the SDK in global.json.
Git	To clone the repository.
Dokan	Not required to build. Required to run the built executable.

Verify the SDK:

dotnet --version

The global.json file specifies:

{
  "sdk": {
    "version": "10.0.0",
    "rollForward": "latestMajor",
    "allowPrerelease": false
  }
}

rollForward: latestMajor allows a newer major SDK to build the project.

---

Repository layout

Path	Contents
CSharp_SimpleXisoDrive.sln	Solution with both projects
SimpleXisoDrive/	Application project (WinExe)
SimpleXisoDrive.Tests/	xUnit test project
docs/	This documentation

---

Common commands

Run all commands from the repository root.

# Restore packages
dotnet restore CSharp_SimpleXisoDrive.sln

# Debug build
dotnet build CSharp_SimpleXisoDrive.sln

# Release build
dotnet build CSharp_SimpleXisoDrive.sln -c Release

# Run the tests
dotnet test CSharp_SimpleXisoDrive.sln

# Run the application from source
dotnet run --project SimpleXisoDrive/SimpleXisoDrive.csproj -- "D:\Games\Halo.iso" Z:

Build output defaults to SimpleXisoDrive/bin/<Configuration>/net10.0-windows/.

---

Publishing standalone builds

The project targets Windows x64 and ARM64. Publish with a runtime identifier:

# Framework-dependent (requires .NET 10 Desktop Runtime installed)
dotnet publish SimpleXisoDrive/SimpleXisoDrive.csproj -c Release -r win-x64

# Self-contained (bundles the runtime)
dotnet publish SimpleXisoDrive/SimpleXisoDrive.csproj -c Release -r win-x64 --self-contained true

# Single-file self-contained executable
dotnet publish SimpleXisoDrive/SimpleXisoDrive.csproj -c Release -r win-x64 --self-contained true -p:PublishSingleFile=true

# Windows on ARM
dotnet publish SimpleXisoDrive/SimpleXisoDrive.csproj -c Release -r win-arm64 --self-contained true

Published output lands in SimpleXisoDrive/bin/Release/net10.0-windows/<rid>/publish/.

If you plan to upload a release, the release notes convention uses archive suffixes win-x64 and win-arm64 (see Installation).

---

Versioning

The version is defined in two places and both must be updated together:

File	Property
SimpleXisoDrive/SimpleXisoDrive.csproj	<AssemblyVersion> and <FileVersion>
SimpleXisoDrive.Tests/SimpleXisoDrive.Tests.csproj	<AssemblyVersion> and <FileVersion>

The current version is 1.2.0. The update checker parses the three-part (major.minor.patch) portion of GitHub release tags, so release tags should follow that pattern (for example, release_1.2.0).

---

Project configuration highlights

Setting	Value
Target framework	net10.0-windows
Language version	14
Nullable	Enabled
Implicit usings	Enabled
Output type	Exe (console)
Debug symbols	Embedded
Application icon	icon\xiso.ico

The application intentionally builds as a console executable: the console serves as the UI for mount status and unmount instructions.

---

Analyzers

Both projects reference the same analyzers:

Analyzer	Purpose
Meziantou.Analyzer 3.0.257	Best-practice and performance rules
Roslynator.Analyzers 5.0.0	Code quality and style rules

Three rules are disabled in .editorconfig:

Rule	Description
MA0004	Use ConfigureAwait
MA0051	Method is too long
MA0015	Specify the parameter name in ArgumentException

Warnings are not treated as errors, but new code should be clean. See Contributing.

---

Continuous integration

The repository currently contains no CI workflow files. Builds and releases are produced manually. If you add CI, the two commands that must succeed are:

dotnet build CSharp_SimpleXisoDrive.sln -c Release
dotnet test CSharp_SimpleXisoDrive.sln -c Release

---

Troubleshooting the build

Symptom	Cause / fix
SDK '10.0.0' not found	Install the .NET 10 SDK. rollForward allows newer major versions, but the SDK must be at least 10.
Package restore failures	Check network/proxy access to NuGet.
MSB3644 reference assemblies not found	Install the .NET 10 SDK; do not rely on an older Visual Studio.
Build succeeds but the app exits immediately	Dokan is missing at runtime; see Installation.