ModReleaser/docs/curseforge/all-schemas.md
2026-07-13 16:18:52 +08:00

13 KiB
Raw Permalink Blame History

Schema 定义

Pagination

分页信息。

字段 类型 说明
index int32 本次返回的起始索引(从 0 开始)
pageSize int32 请求的页大小
resultCount int32 本次实际返回数量
totalCount int64 符合条件的总数量

File

文件对象。

字段 类型 说明
id int32 文件 ID
gameId int32 所属游戏 ID
modId int32 所属项目 ID
isAvailable boolean 是否可下载
displayName string 显示名称
fileName string 文件名
releaseType FileReleaseType 发布类型
fileStatus FileStatus 文件状态
hashes FileHash[] 文件哈希列表
fileDate string(date-time) 文件时间戳
fileLength int64 文件大小(字节)
downloadCount int64 下载次数
fileSizeOnDisk int64 | null 磁盘占用
downloadUrl string 下载地址
gameVersions string[] 关联的游戏版本字符串列表
sortableGameVersions SortableGameVersion[] 排序用版本信息
dependencies FileDependency[] 依赖关系列表
exposeAsAlternative boolean | null 是否暴露为替代版本
parentProjectFileId int32 | null 父项目文件 ID
alternateFileId int32 | null 替代文件 ID
isServerPack boolean | null 是否为服务端包
serverPackFileId int32 | null 服务端包文件 ID
isEarlyAccessContent boolean | null 是否为抢先体验内容
earlyAccessEndDate string(date-time) | null 抢先体验结束日期
fileFingerprint int64 文件指纹
modules FileModule[] 文件模块列表

FileHash

文件哈希。

字段 类型 说明
value string 哈希值
algo HashAlgo 哈希算法1=Sha1, 2=Md5

HashAlgo

含义
1 Sha1
2 Md5

FileDependency

文件依赖关系。

字段 类型 说明
modId int32 依赖的项目 ID
relationType FileRelationType 关系类型

FileRelationType

含义
1 EmbeddedLibrary嵌入库
2 OptionalDependency可选依赖
3 RequiredDependency必需依赖
4 Tool工具
5 Incompatible不兼容
6 Include包含

FileModule

文件中的模块。

字段 类型 说明
name string 模块名
fingerprint int64 模块指纹

FileIndex

文件索引信息(用于最新文件列表)。

字段 类型 说明
gameVersion string 游戏版本
fileId int32 文件 ID
filename string 文件名
releaseType FileReleaseType 发布类型
gameVersionTypeId int32 | null 游戏版本类型 ID
modLoader ModLoaderType Mod Loader 类型

SortableGameVersion

用于排序的版本信息。

字段 类型 说明
gameVersionName string 原始版本名(如 1.5b
gameVersionPadded string 补齐版本号(如 0000000001.0000000005),用于排序
gameVersion string 清洗后的版本号(如 1.5
gameVersionReleaseDate string(date-time) 版本发布日期
gameVersionTypeId int32 | null 游戏版本类型 ID

Mod

项目对象。data 字段中返回的核心类型。

字段 类型 说明
id int32 项目 ID
gameId int32 所属游戏 ID
name string 项目名称
slug string URL Slug
links ModLinks 项目相关链接
summary string 简要说明
status ModStatus 项目状态
downloadCount int64 总下载次数
isFeatured boolean 是否精选
primaryCategoryId int32 主分类 ID
categories Category[] 所属分类列表
classId int32 | null 所属 class ID
authors ModAuthor[] 作者列表
logo ModAsset Logo 资源
screenshots ModAsset[] 截图列表
mainFileId int32 主文件 ID
latestFiles File[] 最新文件列表
latestFilesIndexes FileIndex[] 最新文件索引
latestEarlyAccessFilesIndexes FileIndex[] 最新抢先体验文件索引
dateCreated string(date-time) 创建日期
dateModified string(date-time) 最后修改日期
dateReleased string(date-time) 发布日期
allowModDistribution boolean | null 是否允许分发
gamePopularityRank int32 游戏内排名
isAvailable boolean 是否可搜索(实验性/已删除/仅有 alpha 文件时为 false
thumbsUpCount int32 点赞数
rating number | null 评分

项目相关链接。

字段 类型 说明
websiteUrl string 官网
wikiUrl string Wiki
issuesUrl string Issue 跟踪
sourceUrl string 源码仓库

ModAuthor

项目作者。

字段 类型 说明
id int32 作者 ID
name string 作者名
url string 作者主页

ModAsset

项目资源Logo / 截图)。

字段 类型 说明
id int32 资源 ID
modId int32 所属项目 ID
title string 标题
description string 描述
thumbnailUrl string 缩略图 URL
url string 原图 URL

Category

分类。

字段 类型 说明
id int32 分类 ID
gameId int32 所属游戏 ID
name string 分类名称
slug string URL Slug
url string 分类 URL
iconUrl string 分类图标 URL
dateModified string(date-time) 最后修改日期
isClass boolean | null 是否为顶层 class
classId int32 | null 所属 class ID
parentCategoryId int32 | null 父分类 ID
displayIndex int32 | null 显示顺序

Game

游戏对象。

字段 类型 说明
id int32 游戏 ID
name string 游戏名
slug string Slug
dateModified string(date-time) 最后修改日期
assets GameAssets 游戏资源
status CoreStatus 游戏状态
apiStatus CoreApiStatus API 访问状态

GameAssets

字段 类型 说明
iconUrl string 图标 URL
tileUrl string 卡片背景 URL
coverUrl string 封面 URL

CoreStatus

含义
1 Draft
2 Test
3 PendingReview
4 Rejected
5 Approved
6 Live

CoreApiStatus

含义
1 Private
2 Public

GameVersion

游戏版本V2 接口使用)。

字段 类型 说明
id int32 版本 ID
slug string Slug
name string 版本名

GameVersionType

游戏版本类型。

字段 类型 说明
id int32 类型 ID
gameId int32 游戏 ID
name string 类型名
slug string Slug
isSyncable boolean 是否可同步
status GameVersionTypeStatus 状态

GameVersionsByType / GameVersionsByType2

按类型分组的版本V1/V2

字段 类型 说明
type int32 版本类型
versions string[] / GameVersion[] 该类型下的版本列表V1 为字符串V2 为 GameVersion 对象)

FingerprintsMatchesResult

指纹匹配结果。

字段 类型 说明
isCacheBuilt boolean 缓存是否就绪
exactMatches FingerprintMatch[] 精确匹配
exactFingerprints int[] 精确匹配的指纹列表
partialMatches FingerprintMatch[] 部分匹配
partialMatchFingerprints object(dict) 部分匹配指纹(指纹 → 文件 ID 列表)
installedFingerprints int[] 已安装的指纹
unmatchedFingerprints int[] 未匹配的指纹

FingerprintMatch

单个指纹匹配结果。

字段 类型 说明
id int32 文件 ID
file File 匹配到的文件
latestFiles File[] 该项目的最新文件列表

FingerprintFuzzyMatch

模糊指纹匹配结果。

字段 类型 说明
id int32 文件 ID
file File 匹配到的文件
latestFiles File[] 该项目的最新文件列表
fingerprints int[] 匹配到的指纹列表

FolderFingerprint

按文件夹分组的指纹(用于模糊匹配请求体)。

字段 类型 说明
foldername string 文件夹名
fingerprints int[] 该文件夹下的指纹列表

MinecraftGameVersion

Minecraft 游戏版本信息。

字段 类型 说明
id int32 ID
gameVersionId int32 游戏版本 ID
versionString string 版本字符串
jarDownloadUrl string JAR 下载地址
jsonDownloadUrl string JSON 下载地址
approved boolean 是否已批准
dateModified string(date-time) 修改日期
gameVersionTypeId int32 版本类型 ID
gameVersionStatus GameVersionStatus 版本状态
gameVersionTypeStatus GameVersionTypeStatus 版本类型状态

MinecraftModLoaderIndex

Minecraft ModLoader 索引项。

字段 类型 说明
name string ModLoader 名称
gameVersion string 对应的游戏版本
latest boolean 是否最新版
recommended boolean 是否推荐版
dateModified string(date-time) 修改日期
type ModLoaderType ModLoader 类型

MinecraftModLoaderVersion

Minecraft ModLoader 版本详情。

字段 类型 说明
id int32 ID
gameVersionId int32 游戏版本 ID
minecraftGameVersionId int32 MC 游戏版本 ID
forgeVersion string Forge 版本号
name string 名称
type ModLoaderType ModLoader 类型
downloadUrl string 下载地址
filename string 文件名
installMethod ModLoaderInstallMethod 安装方式
latest boolean 是否最新
recommended boolean 是否推荐
approved boolean 是否已批准
dateModified string(date-time) 修改日期
mavenVersionString string Maven 版本字符串
versionJson string 版本 JSON
librariesInstallLocation string 库安装位置
minecraftVersion string MC 版本
additionalFilesJson string 额外文件 JSON
installProfileJson string 安装 Profile JSON

枚举值完整列表

FileReleaseType

含义
1 Release
2 Beta
3 Alpha

FileStatus完整

含义
1 Processing
2 ChangesRequired
3 UnderReview
4 Approved
5 Rejected
6 MalwareDetected
7 Deleted
8 Archived
9 Testing
10 Released
11 ReadyForReview
12 Deprecated
13 Baking
14 AwaitingPublishing
15 FailedPublishing
16 Cooking
17 Cooked
18 UnderManualReview
19 ScanningForMalware
20 ProcessingFile
21 PendingRelease
22 ReadyForCooking
23 PostProcessing

ModStatus

含义
1 New
2 ChangesRequired
3 UnderSoftReview
4 Approved
5 Rejected
6 ChangesMade
7 Inactive
8 Abandoned
9 Deleted
10 UnderReview

ModLoaderType

含义
0 Any
1 Forge
2 Cauldron
3 LiteLoader
4 Fabric
5 Quilt
6 NeoForge

ModsSearchSortField搜索排序字段

含义
1 Featured
2 Popularity
3 LastUpdated
4 Name
5 Author
6 TotalDownloads
7 Category
8 GameVersion
9 EarlyAccess
10 FeaturedReleased
11 ReleasedDate
12 Rating

SortOrder

含义
asc 升序
desc 降序

GameVersionStatus

含义
1 Approved
2 Deleted
3 New

GameVersionTypeStatus

含义
1 Normal
2 Deleted

ModLoaderInstallMethod

含义
1 ForgeInstaller
2 ForgeJarInstall
3 ForgeInstaller_v2
4 FabricInstaller
5 QuiltInstaller
6 NeoForgeInstaller