ZOA ModKit

IModExporter

interface

Builds a package from a manifest and a set of asset paths, and validates the manifest before you do.

• ModExportPackage Export(ModManifest manifest, IEnumerable<string> assetPaths)
• ModValidationResult ValidateForExport(ModManifest manifest)

IModImporter

interface

Installs a package to a target path, and validates it first. Validate before you import, not after.

• ModImportResult Import(ModExportPackage package, string targetPath)
• ModValidationResult ValidateForImport(ModExportPackage package)

IModSigningService

service

RSA key generation, signing over a deterministic package payload, and verification against a public key you supply.

• ModSignature Sign(ModExportPackage package, string privateKey)
• bool Verify(ModExportPackage package, ModSignature signature, string publicKey)
• (string publicKey, string privateKey) GenerateKeyPair()

ISandboxValidator

interface

Applies a policy to a whole package or a single asset, and supplies the default policy for untrusted content.

• ModValidationResult ValidateMod(ModExportPackage package, SandboxPolicy policy)
• ModValidationResult ValidateAsset(ModAssetEntry asset, SandboxPolicy policy)
• SandboxPolicy GetDefaultPolicy()

ModManifest

class

The mod's identity and compatibility metadata, including its dependency list and tags.

• ModManifest(ModId id, string displayName, string version, string author)
• ModId Id { get; set; }
• string DisplayName, Version, Author, Description { get; set; }
• string GameVersionCompatibility { get; set; }
• List<ModDependency> Dependencies { get; set; }
• List<string> Tags { get; set; }
• DateTime CreatedUtc { get; set; }

ModId

struct

Readonly identifier with implicit conversions to and from string. Its default has a null Value, so check Id.Value rather than comparing the struct against null.

• string Value { get; }

ModDependency

struct

A required mod and the minimum version that satisfies it.

• ModId ModId { get; }
• string MinVersion { get; }

ModExportPackage

class

What travels between machines: manifest, assets, optional signature, total size and export time. AddAsset keeps the total correct.

• ModManifest Manifest { get; set; }
• List<ModAssetEntry> Assets { get; set; }
• ModSignature Signature { get; set; }
• long TotalSizeBytes { get; set; }
• DateTime ExportedAtUtc { get; set; }
• void AddAsset(ModAssetEntry asset)

ModAssetEntry

class

One file in the package: its path inside the mod, its type, its content hash, its size, and where it came from.

• ModAssetEntry(string relativePath, string assetType, string hash, long sizeBytes, string sourcePath = null)
• string RelativePath { get; set; }
• string AssetType { get; set; }
• string Hash { get; set; }
• long SizeBytes { get; set; }
• string SourcePath { get; set; }

ModSignature

class

The signature over a package. SignedByPublicKey is the key Verify checks against the one you supply; IsValid is a local flag, not proof.

• ModId ModId { get; set; }
• string SignatureHash { get; set; }
• string SignedByPublicKey { get; set; }
• DateTime SignedAtUtc { get; set; }
• string Algorithm { get; set; }
• bool IsValid { get; set; }

SandboxPolicy

class

What a mod is allowed to contain. Three factories: Strict denies everything at 50MB, Default permits networking only at 200MB, Permissive allows everything at 500MB.

• bool AllowFileSystem, AllowNetworking, AllowReflection, AllowNativePlugins { get; set; }
• int MaxAssetSizeMb { get; set; }
• List<string> AllowedNamespaces { get; set; }
• List<string> BlockedNamespaces { get; set; }
• static SandboxPolicy Strict()
• static SandboxPolicy Default()
• static SandboxPolicy Permissive()

ModValidationResult

class

Accumulated findings with an IsValid flag. AddIssue is how implementations report; codes make failures diagnosable.

• bool IsValid { get; set; }
• List<ModValidationIssue> Issues { get; set; }
• void AddIssue(ValidationSeverity severity, string code, string message, string assetPath = null)

ModValidationIssue

class

One finding: severity, a stable code such as ASSET_TOO_LARGE, a message, and the asset it concerns.

• ValidationSeverity Severity { get; set; }
• string Code { get; set; }
• string Message { get; set; }
• string AssetPath { get; set; }

ModImportResult

class

Outcome of an install: whether it succeeded, where it landed, and what went wrong.

• bool Success { get; set; }
• string InstalledPath { get; set; }
• List<ModValidationIssue> Issues { get; set; }

ModCompatibilityResult

class

Compatibility findings separate from validation findings, carrying ModCompatibilityIssue values with their own severity scale.

• bool IsCompatible { get; set; }
• List<ModCompatibilityIssue> Issues { get; set; }

ModExporter

class

The shipped exporter. Hashes each asset, derives its type from the file extension, and builds the package.

ModImporter

class

The shipped importer. Installs a validated package to a target path and reports where it landed.

ModSigningService

class

The shipped signing service. RSA with SHA256 and PKCS1 padding over a deterministic package payload; keys carry ZOA-RSA-PUBLIC and ZOA-RSA-PRIVATE prefixes.

SandboxValidator

class

The shipped validator. Checks size, blocked namespaces against both asset type and path, an optional whitelist, and native plugins.

ModKitWorkbenchPackageFileUtility

class

The editor adapter between the runtime services and files on disk. Writes and reads zoamod.json packages with a payload directory alongside.

• const string PackageExtension = "zoamod.json"
• static IReadOnlyList<string> CollectAssetFiles(string sourceDirectory)
• static ModExportPackage ExportDirectoryToPackageFile(ModManifest manifest, string sourceDirectory, string packageFilePath, bool copyPayload = true)
• static ModExportPackage ExportToPackageFile(ModManifest manifest, IEnumerable<string> assetPaths, string packageFilePath, string sourceRoot = null, bool copyPayload = true)
• static void SavePackage(ModExportPackage package, string packageFilePath)
• static ModExportPackage LoadPackage(string packageFilePath)
• static string GetPayloadDirectory(string packageFilePath)
• static string FormatPackageSummary(ModExportPackage package)