Table of Contents

Class ModInfoAttribute

Namespace
Vintagestory.API.Common
Assembly
VintagestoryAPI.dll

Applied to a mod assembly to provide additional meta data information about a code mod. Superseded by "modinfo.json" file, if available.

[AttributeUsage(AttributeTargets.Assembly)]
public sealed class ModInfoAttribute : Attribute
Inheritance
ModInfoAttribute
Inherited Members
Extension Methods

Constructors

ModInfoAttribute(string) 

public ModInfoAttribute(string name)

Parameters

name string

ModInfoAttribute(string, string) 

public ModInfoAttribute(string name, string modID)

Parameters

name string
modID string

Properties

Authors

Names of people working on this mod. (optional)

public string[] Authors { get; set; }

Property Value

string[]

Contributors

Names of people contributing to this mod. (optional)

public string[] Contributors { get; set; }

Property Value

string[]

CoreMod

Is this mod part of the core game, i.e. vanilla Vintage Story? (optional)
Only affects whether the player is given a warning when attempting to disable this mod.
Mods other than VSSurvival, VSEssentials, VSCreative should not use this, obviously...

public bool CoreMod { get; set; }

Property Value

bool

Description

A short description of what this mod does. (optional)

public string Description { get; set; }

Property Value

string

IconPath 

public string IconPath { get; set; }

Property Value

string

ModID

The mod ID (domain) of this mod. For example "myexamplemod".

public string ModID { get; }

Property Value

string

Name

The name of this mod. For example "My Example Mod".

public string Name { get; }

Property Value

string

NetworkVersion

The network version of this mod. Change this number when a user that has an older version of your mod should not be allowed to connected to server with a newer version. If not set, the version value is used.

public string NetworkVersion { get; set; }

Property Value

string

RequiredOnClient

If set to false and the mod is universal, clients don't need it to join. (Optional. True (required) by default.)

public bool RequiredOnClient { get; set; }

Property Value

bool

RequiredOnServer

If set to false and the mod is universal, the mod is not disabled if it's not present on the server. (Optional. True by default.)

public bool RequiredOnServer { get; set; }

Property Value

bool

Side

Which side(s) this mod runs on. Can be "Server", "Client" or "Universal". (Optional. Universal (both server and client) by default.)

public string Side { get; set; }

Property Value

string

Version

The version of this mod. For example "2.10.4". (optional)

public string Version { get; set; }

Property Value

string

Website

Location of the website or project site of this mod. (optional)

public string Website { get; set; }

Property Value

string

WorldConfig 

public string WorldConfig { get; set; }

Property Value

string