GWGUI.Emulation.SDK 1.0.1

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher. 
dotnet add package GWGUI.Emulation.SDK --version 1.0.1
                    


                    

                
NuGet\Install-Package GWGUI.Emulation.SDK -Version 1.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="GWGUI.Emulation.SDK" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="GWGUI.Emulation.SDK" Version="1.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="GWGUI.Emulation.SDK" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add GWGUI.Emulation.SDK --version 1.0.1
                    


                    

                
#r "nuget: GWGUI.Emulation.SDK, 1.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package GWGUI.Emulation.SDK@1.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=GWGUI.Emulation.SDK&version=1.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=GWGUI.Emulation.SDK&version=1.0.1
                    


                            Install as a Cake Tool

GWGUI.Emulation.SDK

GWGUI.Emulation.SDK provides the public contracts used to develop independent emulation modules for GW GUI. A module can define machines, settings, runtimes, media, input, video, audio, saved states and its own update source without referencing GWGUI.App.

Install

<PackageReference Include="GWGUI.Emulation.SDK" Version="1.0.1" />

The package targets .NET 10. The current host API is 1.0, and the current module.json schema is 2.

Start a module

  1. Copy the sdk/module-template directory into a new repository.
  2. Replace the example project identity, namespace, assembly name and values in module.json.
  3. Implement IEmulationModuleFactory and return an IEmulationModule from Create.
  4. Keep hostApiMinimum and hostApiMaximum at 1.0 while targeting this SDK API.
  5. Set updateCatalogUrl to the stable HTTPS JSON catalogue published by the module repository.
  6. Package the result with this structure:
Modules/<module-id>/
  module.json
  gwgui.emulation.<module-id>.dll
  <private dependencies>

GW GUI validates the manifest, API range, identity, archive paths and checksum before installation. Adding, updating or removing a module takes effect after restarting GW GUI.

Main contracts

  • IEmulationModuleFactory is the module entry point.
  • IEmulationModule describes machines, settings, configurations and runtime creation.
  • IEmulatedMachine exposes lifecycle, input, media, video, audio and saved-state services.
  • IEmulationEmulatorManager, IEmulationFirmwareManager, IEmulationInputSettingsManager and IEmulationStorageSettingsManager add optional capabilities.
  • IEmulationModuleLocalization supplies translations embedded in the module.

The complete contract, manifest rules, packaging format and publication workflow are documented in the module authoring guide. SDK compatibility and version changes are documented in the versioning policy.

Version compatibility

The NuGet package follows semantic versioning. Every module declares an inclusive host API range in module.json; compatibility beyond that range is never assumed. A package revision can improve documentation or internal implementation while retaining host API 1.0.

License

MIT

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.1 48 9/9/2026
1.0.0 49 9/9/2026