LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

This reference documents the current beta SDK. Beta APIs can change before stable.

GameDataSourceDescriptor14.1 Beta

C#
public sealed class Unbroken.LaunchBox.Plugins.GameData.GameDataSourceDescriptor
Names a logical source; replacement implementations must preserve its game ID conventions.

Constructors

GameDataSourceDescriptor 14.1 Beta

C#
public GameDataSourceDescriptor(string sourceId, Unbroken.LaunchBox.Plugins.PluginText displayName)
Creates source metadata without performing I/O.
sourceId 14.1 Beta
Canonical lowercase ID, at most 128 ASCII letters, digits, dots, underscores, or hyphens; starts with a letter or digit.
displayName 14.1 Beta
Plugin-owned translatable name.

Properties

DisplayName 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.PluginText DisplayName { get; }
Gets the translatable name.

GameIdNamespace 14.1 Beta

C#
public string? GameIdNamespace { get; init; }
Gets or initializes the namespace whose external identifier values are also this source's local game IDs.

Remarks

Optional; omission preserves the conventional storefront.<source ID> association. Namespaces are compared ordinally. LaunchBox supplies storefront identities as storefront.<logical storefront ID>, and Games Database IDs as gamesdb. Declaring a namespace enables exact ID-based retrieval without title matching; it does not assign library ownership.

IconResourceId 14.1 Beta

C#
public string? IconResourceId { get; init; }
Gets or initializes an optional package image resource ID.

MaximumBatchSize 14.1 Beta

C#
public int MaximumBatchSize { get; init; }
Gets or initializes the maximum game IDs requested in one metadata or media callback. Defaults to 100; the host may use smaller batches.

Remarks

Use 1 for a service that retrieves one game at a time so each callback remains within the host timeout. Must be positive.

SourceId 14.1 Beta

C#
public string SourceId { get; }
Gets the implementation-independent source ID.