ModInfo class

Namespace Lustral · Assembly Lustral.Api

A mod's identity, as declared in its manifest (mod.toml).

public sealed class ModInfo

Properties

Authors

public IReadOnlyList<string> Authors { get; }

The mod's authors, as listed in its manifest; empty if none are listed.

DataDirectory

public string DataDirectory { get; }

The absolute path of a folder for files the mod writes at runtime, such as caches and saved data: Lustral/data/<id>/. The folder is preserved when the mod is updated and is created on first access. Settings belong in Mod.Config.

Description

public string? Description { get; }

The mod's description, or null if its manifest has none.

Directory

public string Directory { get; }

The absolute path of the mod's folder, Mods/<id>/, which contains its assemblies and the files it ships. The folder is replaced when the mod is updated; files written at runtime belong in DataDirectory.

Id

public string Id { get; }

The mod's ID, for example sxxr0.betterhud.

Name

public string Name { get; }

The mod's display name.

Version

public string Version { get; }

The mod's version, for example 1.2.0.

Methods

ToString()

public override string ToString();

Returns the name, version and ID as written in Lustral's log: Better HUD 1.2.0 (sxxr0.betterhud).