GameFrameX.Foundation

All-in-One Solution for Indie Game Development · Empowering Indie Developers' Dreams

Documentation · Quick Start · QQ Group: 467608841 / 233840761

English | 简体中文 | 繁體中文 | 日本語 | 한국어

Project Overview

GameFrameX.Foundation is a modular collection of .NET 10 class libraries that deliver cross-cutting infrastructure for GameFrameX server projects — covering localization, JSON, options parsing, ORM attributes, extensions, encryption, hashing, utilities, logging, HTTP helpers, response normalization, ORM base entities, and idempotency.

Features

Package	Description	Version	Downloads
GameFrameX.Foundation.Localization	Lightweight localization support
GameFrameX.Foundation.Json	Unified JSON serialization
GameFrameX.Foundation.Options	CLI argument parser
GameFrameX.Foundation.Orm.Attribute	ORM attribute definitions
GameFrameX.Foundation.Extensions	Extension methods and helpers
GameFrameX.Foundation.Encryption	Encryption algorithms
GameFrameX.Foundation.Hash	Hash algorithms
GameFrameX.Foundation.Utility	General utilities
GameFrameX.Foundation.Logger	Unified logging
GameFrameX.Foundation.Http.Extension	HTTP client extensions
GameFrameX.Foundation.Http.Normalization	HTTP response normalization
GameFrameX.Foundation.Orm.Entity	ORM entity base classes
GameFrameX.Foundation.Idempotency	Idempotency and event envelope

Quick Start

Installation

Install the packages you need:

dotnet add package GameFrameX.Foundation.Extensions
dotnet add package GameFrameX.Foundation.Encryption
dotnet add package GameFrameX.Foundation.Logger

Usage Examples

using GameFrameX.Foundation.Extensions;
using GameFrameX.Foundation.Encryption;
using GameFrameX.Foundation.Hash;

// Extension methods
var bytes = "Hello World".ToBytes();
var hex = bytes.ToHexString();

// Encryption
var encrypted = AesHelper.Encrypt(Encoding.UTF8.GetBytes("secret"), key, iv);
var decrypted = AesHelper.Decrypt(encrypted, key, iv);

// Hash
var md5 = Md5Helper.ComputeHash("Hello World");
var sha256 = ShaHelper.ComputeSha256("Hello World");

Architecture

See the full architecture documentation for design principles and dependency graph.

Platform Support

• .NET 8.0 / 9.0 / 10.0
• Supported OS: Windows, macOS, Linux

Dependencies

Module	Package	Description	Dependencies	Docs
Localization	GameFrameX.Foundation.Localization	Lightweight localization with lazy-loading mechanism	Zero dependencies	Docs
JSON	GameFrameX.Foundation.Json	Unified JSON serialization/deserialization interfaces	Zero dependencies	Docs
Options	GameFrameX.Foundation.Options	Command-line option/configuration builder	Zero dependencies	Docs
ORM Attribute	GameFrameX.Foundation.Orm.Attribute	ORM attribute definitions for audit, cache, soft-delete, tenant, data scope, sensitive masking, tree, import/export	Zero dependencies	Docs
Extensions	GameFrameX.Foundation.Extensions	Core extension methods and collection helpers	→ Localization	Docs
Encryption	GameFrameX.Foundation.Encryption	AES, RSA, DSA, SM2/SM4, XOR encryption	→ Localization	Docs
Hash	GameFrameX.Foundation.Hash	CRC32/64, MD5, SHA, HMAC, MurmurHash3, xxHash	→ Localization	Docs
Utility	GameFrameX.Foundation.Utility	Console, environment, time, Snowflake ID utilities	→ Localization	Docs
Logger	GameFrameX.Foundation.Logger	Unified logging with Serilog, Loki, MongoDB sinks	→ Extensions + JSON	Docs
HTTP Extension	GameFrameX.Foundation.Http.Extension	HTTP client extension methods	→ JSON	Docs
HTTP Normalization	GameFrameX.Foundation.Http.Normalization	Standardized HTTP JSON response structures	→ Logger	Docs
ORM Entity	GameFrameX.Foundation.Orm.Entity	ORM entity base classes with enterprise features	→ Utility	Docs
Idempotency	GameFrameX.Foundation.Idempotency	Idempotency occupation/replay decisions and universal event envelope	→ Utility	Docs

Documentation & Resources

• Documentation
• GitHub Repository
• Issue Tracker
• GameFrameX Official Site

Community & Support

Changelog

See CHANGELOG.md for the version history of GameFrameX.Foundation.

License

See LICENSE.md for license information.