Interface ForgeModMcmodInfo

Represent the forge mcmod.info format.

🏷️ Properties

authorList

authorList: string[]

A list of authors to this mod.

Defined in: packages/mod-parser/forge.ts:104

credits

credits: string

A string that contains any acknowledgements you want to mention.

Defined in: packages/mod-parser/forge.ts:108

dependants

dependants: string[]

A list of modids. All of the listed mods will load after this one. If one is not present, nothing happens.

Defined in: packages/mod-parser/forge.ts:136

dependencies

dependencies: string[]

A list of modids. All of the listed mods will load before this one. If one is not present, nothing happens.

Defined in: packages/mod-parser/forge.ts:132

description

description: string

A description of this mod in 1-2 paragraphs.

Defined in: packages/mod-parser/forge.ts:80

logoFile

logoFile: string

The path to the mod’s logo. It is resolved on top of the classpath, so you should put it in a location where the name will not conflict, maybe under your own assets folder.

Defined in: packages/mod-parser/forge.ts:112

mcversion

mcversion: string

The Minecraft version.

Defined in: packages/mod-parser/forge.ts:88

modid

modid: string

The modid this description is linked to. If the mod is not loaded, the description is ignored.

Defined in: packages/mod-parser/forge.ts:72

name

name: string

The user-friendly name of this mod.

Defined in: packages/mod-parser/forge.ts:76

parent

parent: string

The modid of a parent mod, if applicable. Using this allows modules of another mod to be listed under it in the info page, like BuildCraft.

Defined in: packages/mod-parser/forge.ts:120

requiredMods

requiredMods: string[]

A list of modids. If one is missing, the game will crash. This does not affect the ordering of mod loading! To specify ordering as well as requirement, have a coupled entry in dependencies.

Defined in: packages/mod-parser/forge.ts:128

screenshots

screenshots: string[]

A list of images to be shown on the info page. Currently unimplemented.

Defined in: packages/mod-parser/forge.ts:116

updateJSON

updateJSON: string

The URL to a version JSON.

Defined in: packages/mod-parser/forge.ts:100

updateUrl

updateUrl: string

Defined but unused. Superseded by updateJSON.

Defined in: packages/mod-parser/forge.ts:96

url

url: string

A link to the mod’s homepage.

Defined in: packages/mod-parser/forge.ts:92

useDependencyInformation

useDependencyInformation: boolean

If true and Mod.useMetadata, the below 3 lists of dependencies will be used. If not, they do nothing.

Defined in: packages/mod-parser/forge.ts:124

version

version: string

The version of the mod.

Defined in: packages/mod-parser/forge.ts:84