Table of Contents

Class Mod

Namespace
PolyMod
Assembly
PolyMod.dll

A mod that PolyMod found in the mods directory, or the base game entry with the id polytopia.

public class Mod
Inheritance
Mod
Inherited Members

Constructors

Mod(Manifest, Status, List<File>)

Makes a mod from a manifest.

public Mod(Mod.Manifest manifest, Mod.Status status, List<Mod.File> files)

Parameters

manifest Mod.Manifest

The manifest that gives the id, name, description, version, authors, dependencies and client value.

status Mod.Status

The initial load status of the mod.

files List<Mod.File>

The files of the mod.

Fields

authors

The names of the authors of the mod.

public string[] authors

Field Value

string[]

checksum

The SHA-256 checksum of the mod, as a hexadecimal string. PolyMod makes it from the id, the version, and the name and contents of each file. It stays empty for client-side mods, for the base game entry, and for mods that do not have the status Success.

public string checksum

Field Value

string

client

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

public bool client

Field Value

bool

dependencies

The dependencies of the mod, or null.

public Mod.Dependency[]? dependencies

Field Value

Dependency[]

description

The description of the mod, or null.

public string? description

Field Value

string

files

The files of the mod. This list does not contain manifest.json.

public List<Mod.File> files

Field Value

List<Mod.File>

id

The id of the mod.

public string id

Field Value

string

name

The name of the mod to show. If the manifest has no name, this is the id.

public string? name

Field Value

string

status

The load status of the mod.

public Mod.Status status

Field Value

Mod.Status

version

The version of the mod.

public Version version

Field Value

Version