Modinfo

The modinfo file contains information (name, version, etc) and configuration data of a mod. As such, it is important when you want to release a mod.

It should be placed in the mods root folder.

Variables

API Version

This is the game’s version of the API. It should rarely change. When it does, your mod gets labeled “outdated”, but still works.

Mod Configuration Options

The configuration_options variable can contain config data that the user can change in-game through the mod menu. An options spinner will be provided to the user for each element of configuration_options, which can be used to cycle through the selections.

Syntax of configuration_options

Data from the options can later be retrieved from modmain.lua using the GetModConfigData function.

Sample modinfo

 

 

Relevant forum post. (remove when this page is complete)