2dog 4.7.2.122

2dog

Command-line tool and project templates for 2dog – run Godot as a library from your own .NET entry point. It scaffolds host projects, checks and repairs them (2dog doctor), and updates them (2dog update). The engine library itself is the 2dog.engine package.

This one package is both a dotnet tool and a dotnet new template package.

Run it

One-shot (no install, .NET 10+):

dnx 2dog add         # add hosts to the Godot project here
dnx 2dog new MyGame  # a new Godot project with 2dog hosts
dnx 2dog doctor      # check the project and this machine, fix what it can
dnx 2dog update      # bring the 2dog packages to this tool's versions

Or install the 2dog command globally:

dotnet tool install -g 2dog
2dog add

With no host options the tool prompts: a checkbox list of hosts, editable folder names, the plan, and a confirmation. Naming any host option (or passing --yes) skips that wizard. On terminals, a missing workload (wasm-tools, android) can still be offered for newly selected hosts before restore; --yes skips the offer. Use --install-wasm-tools or --install-android-workload for explicit installation. The dotnet new template produces the same output: dotnet new install 2dog && dotnet new 2dog -n MyGame.

Browser, Android, and MAUI hosts are excluded from ordinary solution builds. Install their workloads when building or publishing those hosts. Package updates and desktop/test builds do not require them. Doctor only requires them for its selected --build target, or installs them when explicitly requested with an install flag. Failed restores return exit code 2, preserve the created files, and explain recognized failures; fix the cause and run dotnet restore again.

What it does

Creates the host projects in place: it creates files and edits *.csproj, project.godot, the solution and Directory.Build.props; no file is ever moved, renamed or deleted (two announced opt-ins aside: the .sln to .slnx migration and --rename). Solution migration first saves a .sln.old backup, using .sln.old.1, .sln.old.2, and so on if needed, and removes the .sln only after conversion succeeds. Existing backups are kept. The Godot project directory becomes the solution root, and host projects are scaffolded as nested subfolders that the Godot editor ignores (each carries a .gdignore):

MyGame/                      <- your existing Godot project (unchanged)
  project.godot
  MyGame.csproj              <- created or minimally patched
  MyGame.slnx                <- created, or an existing .sln is migrated
  Directory.Build.props      <- the package versions every host references
  MyGame.2dog/   (.gdignore) <- generic .NET host (your Main entry point)
  MyGame.web/    (.gdignore) <- browser (WebAssembly) host (holds TwoDogWebBoot.cs)
  MyGame.webxr/  (.gdignore) <- WebXR browser host (opt-in: --webxr; page ships the WebXR Layers polyfill)
  MyGame.xunit/  (.gdignore) <- xUnit test project (opt-in: --xunit)
  MyGame.repl/   (.gdignore) <- interactive C# prompt in the running game (opt-in: --repl)
  MyGame.gdunit/ (.gdignore) <- GDScript test host using MTP (opt-in: --gdunit)
  MyGame.nunit/  (.gdignore) <- NUnit test project (opt-in: --nunit)
  MyGame.winforms/ (.gdignore) <- WinForms host (opt-in: --winforms; Windows-only at runtime)
  MyGame.winui/  (.gdignore) <- WinUI 3 host (opt-in: --winui; Windows-only, builds only on Windows)
  MyGame.avalonia/ (.gdignore) <- Avalonia host (opt-in: --avalonia; cross-platform GUI)
  MyGame.blazor/ (.gdignore) <- Blazor Web App host (opt-in: --blazor; server + Client/ WebAssembly page)
  MyGame.maui/ (.gdignore)    <- MAUI host (opt-in: --maui; Windows and Android)
  MyGame.android/ (.gdignore) <- Android host (opt-in: --android; dotnet publish makes an APK)

Run it again whenever you want another host – hosts that exist are recognized and left alone, and a kind you already have is added a second time under a free folder name (2dog add --generic MyGame.editor).

Commands:

Options:

Exit codes: 0 ok, 1 usage error, 2 tool error, 3 doctor findings remain or a repl exec submission failed, 124 repl exec timed out, 130 cancelled. The report goes to stdout, diagnostics to stderr; nothing prompts in a pipe or in CI. Full reference: https://2dog.dev/dnx-2dog

Using the library directly

This package cannot be referenced from a project (it is a tool package); reference the engine instead:

dotnet add package 2dog.engine

MAUI: dnx 2dog add --maui creates a Windows/Android host using 2dog.maui. Install maui-windows and maui-android with dotnet workload install. Windows prefers GPU sharing and falls back to CPU readback; Android renders directly to Godot's native surface. MAUI controls can overlap the game. --no-maui omits this opt-in host. See https://2dog.dev/hosts/maui.