PolyhydraGames.Api.SystemDefinitions 1.0.5.170

PolyhydraGames.Api.SystemDefinitions

Typed system definition helpers for game platform slugs, folders, emulator cores, file extensions, and IGDB identifiers.

The library wraps a curated platform dataset and normalizes common aliases such as mastersystem → sms, pce → pcengine, and arcade variants → arcade.

Tags

• api
• dotnet
• api-system-definitions
• system
• definitions
• streaming

Install

dotnet add package PolyhydraGames.Api.SystemDefinitions

Package id PolyhydraGames.Api.SystemDefinitions, targets net10.0. The platform dataset ships embedded in the assembly, so no network or file access is needed by default.

Usage

// Loads the embedded dataset. Pass dataSource (file path or http/https URL) to override.
await SystemsDatabase.Setup(logger);

var system = SystemsDatabase.Instance.GetSystem("SMS");
var folder = "mastersystem".ToFolder();
var core = "SMS".GetCoreFromSlug();
var slug = SystemsDatabase.Instance.GetSystemFromExtension(".gba");
var inventorySlug = SystemsDatabase.Instance.GetSystemFromPath("/roms/snes/Chrono Trigger.sfc");
var igdbPlatformId = SystemsDatabase.Instance.GetProviderIdFromSlug("snes", "igdb");

Setup publishes a replacement database only after its definitions load and validate. It throws InvalidOperationException when the selected source is missing, malformed, unreadable, or empty; callers that reconfigure an already initialized database can catch that exception and continue using the prior initialized SystemsDatabase.Instance. Unknown slugs throw SystemDefinitionNotFoundException. SystemsDatabase.Systems is a read-only view.

Development

All build, test and quality steps go through the Makefile; CI runs the same targets.

make ci        # restore, lint (format check + warnings-as-errors Release build), test, coverage
make test      # tests with hang protection (timeout + --blame-hang-timeout)
make mutate    # Stryker mutation tests; fails below the threshold in stryker-config.json
make format    # apply dotnet format

Default tests use local fixtures and need no network access. Use python scripts/refresh-platform-fixture.py to regenerate API.SystemDefinitions.Test/TestData/platform.fixture.json from the upstream dataset.

Pack:

dotnet pack Api.SystemDefinitions/PolyhydraGames.Api.SystemDefinitions.csproj --configuration Release

Roadmap

• v1 roadmap
• Platform fixture refresh guide
• Release checklist

Docs

• Docs Index
• Feature Index
• Roadmap Index

License

This project is licensed under the MIT License.

Core.Interfaces.Gaming 3 compatibility

System definitions consume the published Core.Interfaces.Gaming 3.0.0.26 contracts package. Platform lookup, alias normalization, fixture data, and provider identifiers retain their existing behavior. Run the offline native validation script before packaging; live consumers and package publication remain separate validation and release gates.