Skip to content

Interface Mod

🏷️ Properties

allowModDistribution

ts
allowModDistribution: null | boolean

Is mod allowed to be distributed

Defined in: packages/curseforge/index.ts:131

authors

ts
authors: Author[]

The list of authors

Defined in: packages/curseforge/index.ts:106

categories

ts
categories: ModCategory[]

List of categories that this mod is related to

Defined in: packages/curseforge/index.ts:98

classId

ts
classId: null | number

The class id this mod belongs to

Defined in: packages/curseforge/index.ts:102

dateCreated

ts
dateCreated: string

The creation date of the mod

Defined in: packages/curseforge/index.ts:123

dateModified

ts
dateModified: string

Defined in: packages/curseforge/index.ts:125

dateReleased

ts
dateReleased: string

Defined in: packages/curseforge/index.ts:126

defaultFileId

ts
defaultFileId: number

The default download file id

Defined in: packages/curseforge/index.ts:144

downloadCount

ts
downloadCount: number

Number of downloads for the mod

Defined in: packages/curseforge/index.ts:86

gameId

ts
gameId: number

Game id. Minecraft is 432.

Defined in: packages/curseforge/index.ts:59

gamePopularityRank

ts
gamePopularityRank: number

The mod popularity rank for the game

Defined in: packages/curseforge/index.ts:135

id

ts
id: number

The addon id. You can use this in many functions required the addonID

Defined in: packages/curseforge/index.ts:55

isAvailable

ts
isAvailable: boolean

Is the mod available for search. This can be false when a mod is experimental, in a deleted state or has only alpha files

Defined in: packages/curseforge/index.ts:139

isFeatured

ts
isFeatured: boolean

Whether the mod is included in the featured mods list

Defined in: packages/curseforge/index.ts:90

latestFiles

ts
latestFiles: File[]

Defined in: packages/curseforge/index.ts:115

latestFilesIndexes

ts
latestFilesIndexes: FileIndex[]

List of file related details for the latest files of the mod

Defined in: packages/curseforge/index.ts:119

ts
links: Object

Relevant links for the mod such as Issue tracker and Wiki

Defined in: packages/curseforge/index.ts:69

ts
logo: ModAsset

Defined in: packages/curseforge/index.ts:108

mainFileId

ts
mainFileId: number

The id of the main file of the mod

Defined in: packages/curseforge/index.ts:114

name

ts
name: string

The display name of the addon

Defined in: packages/curseforge/index.ts:63

primaryCategoryId

ts
primaryCategoryId: number

The main category of the mod as it was chosen by the mod author

Defined in: packages/curseforge/index.ts:94

screenshots

ts
screenshots: ModAsset[]

Defined in: packages/curseforge/index.ts:110

slug

ts
slug: string

The mod slug that would appear in the URL

Defined in: packages/curseforge/index.ts:67

status

ts
status: ModStatus

Current mod status

Defined in: packages/curseforge/index.ts:82

summary

ts
summary: string

One line summery

Defined in: packages/curseforge/index.ts:78

thumbsUpCount

ts
thumbsUpCount: number

The mod's thumbs up count

Defined in: packages/curseforge/index.ts:148

Released under the MIT License.