PolyhydraGames.Core.Models 1.0.2.18

Core.Models

A .NET utility library providing common models, helpers, and reactive extensions for the PolyhydraGames ecosystem.

Tags

• dotnet
• core
• core-models
• auth
• docs
• models

Related Repos

What This Library Provides

PolyhydraGames.Core.Models is a shared utility library containing common DTOs, caching, serialization helpers, and reactive extensions used across multiple projects. It eliminates duplication by centralizing frequently-needed model types and helpers.

Key Types

Common Use Cases

1. Caching Data

var cache = new Cache<MyData>(myData, TimeSpan.FromMinutes(5));
var result = cache.Value; // null/default if expired

2. Watching Files Reactively

var monitor = new ObservableFileMonitor("path/to", "file.txt");
monitor.Observable.Subscribe(path => Console.WriteLine($"File changed: {path}"));
monitor.Initialize();

3. Enum Descriptions

var description = new EnumDescription<MyEnum>(
 MyEnum.SomeValue,
 "Some Value",
 "Display description");

4. CSV Parsing

var records = csvContent.FromCSV<MyRecord>();
var output = records.ToCSV();

5. JSON Helpers

var json = myObject.ToJson();
var obj = json.FromJson<MyType>();

Integration Instructions

Install via NuGet

<PackageReference Include="PolyhydraGames.Core.Models" Version="1.0.2.10" />

The package is published publicly on nuget.org. New main builds publish 1.0.2.<run_number> when the repository has a valid NUGET_API_KEY secret.

Target Frameworks

• Main package: net8.0 and net9.0 (multi-target)
• Test project: net10.0

Prerequisites

• .NET 10.0 SDK or later for the current test project
• .NET 8.0 and .NET 9.0 targeting packs for the library targets
• The following NuGet packages are automatically resolved:
  • PolyhydraGames.Core.Interfaces (v2.0.0.45)
  • PolyhydraGames.Extensions (v2.1.1.78)
  • System.Reactive (v6.1.0)

Building

# Build the solution
dotnet build PolyhydraGames.Core.Models.sln

# Run tests
dotnet test Tests/PolyhydraGames.Core.Models.Test.csproj

Typical Usage

using PolyhydraGames.Core.Models;
using PolyhydraGames.Core.Models.Identifiers;
using PolyhydraGames.Core.Models.Media;

// Now use any of the types listed above

Projects That Use This Library

• OAuth.Core
• All API projects
• Spotabot
• Channel Cheevos

📖 Documentation

Detailed documentation can be found in the following sections: