Gondwana.Templates 2.5.2

Gondwana Templates

dotnet new templates for the Gondwana Game Engine.

Install

dotnet new install Gondwana.Templates

Available Templates

Usage

WinForms (Windows only)

dotnet new gondwana-winforms -n MyGame
cd MyGame
dotnet run

This scaffolds a ready-to-run WinForms project containing:

• MyGame.csproj — targets net8.0-windows with the four Gondwana packages pre-referenced
• Program.cs — [STAThread] WinForms entry point
• GameWindow.cs — Form wired to the engine lifecycle (OnLoad → host, OnShown → Initialize, OnFormClosed → Dispose)
• MyGameHost.cs — WinFormsGameHostBase subclass with // TODO override stubs for loading tilesheets, building the scene, and handling keyboard input
• assets/README.txt — instructions for adding sprites and other asset files

Avalonia (Windows, macOS, Linux)

dotnet new gondwana-avalonia -n MyGame
cd MyGame
dotnet run

This scaffolds a ready-to-run Avalonia project containing:

• MyGame.csproj — targets net8.0 with the Gondwana and Avalonia.Desktop packages pre-referenced
• Program.cs — Avalonia AppBuilder entry point using UsePlatformDetect()
• App.cs — Application subclass that creates the main window on startup
• GameWindow.cs — Window wired to the engine lifecycle (OnOpened → host + Initialize, OnClosed → Dispose)
• MyGameHost.cs — AvaloniaGameHost subclass with // TODO override stubs for loading tilesheets, building the scene, and handling keyboard input
• assets/README.txt — instructions for adding sprites and other asset files

Choosing a backbuffer

Both templates accept a --Backbuffer parameter to choose the rendering backend:

# GPU-accelerated WinForms project
dotnet new gondwana-winforms -n MyGame --Backbuffer gpu

# GPU-accelerated Avalonia project
dotnet new gondwana-avalonia -n MyGame --Backbuffer gpu

Omitting --Backbuffer is equivalent to passing --Backbuffer bitmap.

When --Backbuffer gpu is used:

• GameWindow.cs uses WinFormGpuRenderSurfaceControl / AvaloniaGpuRenderSurfaceControl instead of the bitmap variant.
• MyGameHost.cs derives from WinFormsGpuGameHost / AvaloniaGpuGameHost instead of WinFormsBitmapGameHost / AvaloniaGameHost.

Blazor WebAssembly (browser-based)

dotnet new gondwana-blazor -n MyGame
cd MyGame
dotnet run                                    # run on desktop

Build and publish for browser:

dotnet workload install wasm-tools            # one-time per machine
dotnet publish -f net8.0-browser -c Release
# Output: bin/Release/net8.0-browser/publish/wwwroot/

This scaffolds a Blazor WebAssembly project containing:

• MyGame.csproj — targets net8.0-browser with Blazor WebAssembly and Gondwana packages
• Program.cs — Blazor WebAssembly entry point with audio module import
• App.razor — Root Blazor Router component
• Pages/Index.razor — Main page (routed to "/") containing the game
• GameRenderSurface.razor — Blazor component wrapping BlazorBitmapRenderSurfaceComponent
• MyGameHost.cs — BlazorGameHost subclass with // TODO stubs for loading assets and building the scene
• wwwroot/index.html — HTML host page with loading indicator
• assets/README.txt — instructions for adding sprites and other assets

Note: The gondwana-audio.js file is automatically included via the Gondwana.Audio.Browser NuGet package.

Documentation

• Source Code
• Architecture & Guides
• API Reference (Doxygen)
• Release History

Related Packages

• Gondwana --- Core engine
• Gondwana.Audio.Browser --- Browser-based audio playback support
• Gondwana.Audio.Midi --- MIDI playback and sequencing support
• Gondwana.Avalonia --- Avalonia rendering and input adapters
• Gondwana.Avalonia.Hosting --- Avalonia-specific game host that integrates rendering and input into the Gondwana lifecycle
• Gondwana.Blazor --- Web assembly rendering and input adapters
• Gondwana.Blazor.Hosting --- Blazor-specific game host that integrates rendering and input into the Gondwana lifecycle
• Gondwana.Hosting --- Standard platform-agnostic scaffolding for initializing and running Gondwana games
• Gondwana.Input.SDL2 --- SDL2-based input handling
• Gondwana.Video --- Video playback support
• Gondwana.Widgets --- UI widget library for creating in-game menus, HUDs, and overlays
• Gondwana.WinForms --- WinForms rendering and input adapters
• Gondwana.WinForms.Hosting --- WinForms-specific game host that integrates rendering and input into the Gondwana lifecycle
• Gondwana.Cli --- Command-line interface for scaffolding and managing Gondwana projects

License

MIT