classProject#

class Project(
platform: str,
id: str,
slug: str,
name: str,
summary: str = '',
project_type: str = 'modpack',
icon_url: str | None = None,
url: str | None = None,
downloads: int = 0,
author: str | None = None,
categories: tuple[str, ...] = (),
updated: str = '',
follows: int | None = None,
game_versions: tuple[str, ...] = (),
)#

A mod, modpack or other project on a platform.

platform#

The platform’s name.

Type:

str

id#

The project’s id on that platform.

Type:

str

slug#

The project’s short name.

Type:

str

name#

The display name.

Type:

str

summary#

A short description.

Type:

str

project_type#

The kind of project, such as modpack.

Type:

str

icon_url#

The icon’s URL, or None.

Type:

str | None

url#

The project’s web page, or None.

Type:

str | None

downloads#

The number of downloads.

Type:

int

author#

The author’s name, or None if the platform did not say, as Modrinth’s project lookups do not.

Type:

str | None

categories#

Its categories, as readable names such as Optimization.

Type:

tuple[str, …]

updated#

When it last changed, in ISO 8601 format, or empty.

Type:

str

follows#

How many people follow it, or None if unknown. CurseForge calls these favourites.

Type:

int | None

game_versions#

The game releases it supports, newest first. Snapshots and pre-releases are left out.

Type:

tuple[str, …]

property folder: str | None#

The folder the game loads this kind of project from, such as mods.

None for modpacks and for kinds that do not go in a game directory’s top level, such as datapacks, which belong to a single world.