Table of Contents

Class Mod.Manifest

Namespace
PolyMod
Assembly
PolyMod.dll

The data from the manifest.json file of a mod.

public record Mod.Manifest : IEquatable<Mod.Manifest>
Inheritance
Mod.Manifest
Implements
Inherited Members

Constructors

Manifest(string, string?, string?, Version, string[], Dependency[]?, bool)

The data from the manifest.json file of a mod.

public Manifest(string id, string? name, string? description, Version version, string[] authors, Mod.Dependency[]? dependencies, bool client = false)

Parameters

id string

The id of the mod. It must contain only lowercase letters and underscores, and it must not be polytopia.

name string

The name of the mod to show, or null to use the id.

description string

The description of the mod, or null.

version Version

The version of the mod.

authors string[]

The names of the authors of the mod. The array must not be empty.

dependencies Dependency[]

The dependencies of the mod, or null for no dependencies.

client bool

If true, the mod is client-side only and PolyMod does not include it in the mod checksum.

Properties

authors

The names of the authors of the mod. The array must not be empty.

public string[] authors { get; init; }

Property Value

string[]

client

If true, the mod is client-side only and PolyMod does not include it in the mod checksum.

public bool client { get; init; }

Property Value

bool

dependencies

The dependencies of the mod, or null for no dependencies.

public Mod.Dependency[]? dependencies { get; init; }

Property Value

Dependency[]

description

The description of the mod, or null.

public string? description { get; init; }

Property Value

string

id

The id of the mod. It must contain only lowercase letters and underscores, and it must not be polytopia.

public string id { get; init; }

Property Value

string

name

The name of the mod to show, or null to use the id.

public string? name { get; init; }

Property Value

string

version

The version of the mod.

public Version version { get; init; }

Property Value

Version