Interface Mod

🏷️ Properties

allowModDistribution

allowModDistribution: null | boolean

Is mod allowed to be distributed

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

authors

authors: Author[]

The list of authors

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

categories

categories: ModCategory[]

List of categories that this mod is related to

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

classId

classId: null | number

The class id this mod belongs to

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

dateCreated

dateCreated: string

The creation date of the mod

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

dateModified

dateModified: string

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

dateReleased

dateReleased: string

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

defaultFileId

defaultFileId: number

The default download file id

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

downloadCount

downloadCount: number

Number of downloads for the mod

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

gameId

gameId: number

Game id. Minecraft is 432.

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

gamePopularityRank

gamePopularityRank: number

The mod popularity rank for the game

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

id

id: number

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

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

isAvailable

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:140

isFeatured

isFeatured: boolean

Whether the mod is included in the featured mods list

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

latestFiles

latestFiles: File[]

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

latestFilesIndexes

latestFilesIndexes: FileIndex[]

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

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

links

links: { issuesUrl: string; sourceUrl: string; websiteUrl: string; wikiUrl: string }

Relevant links for the mod such as Issue tracker and Wiki

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

logo

logo: ModAsset

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

mainFileId

mainFileId: number

The id of the main file of the mod

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

name

name: string

The display name of the addon

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

primaryCategoryId

primaryCategoryId: number

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

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

screenshots

screenshots: ModAsset[]

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

slug

slug: string

The mod slug that would appear in the URL

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

status

status: ModStatus

Current mod status

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

summary

summary: string

One line summery

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

thumbsUpCount

thumbsUpCount: number

The mod's thumbs up count

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