OS Cobblemon Library

关于

OS Cobblemon Library 是一个供 Cobblemon 模组使用的共享 API 和兼容层。

它将常用的宝可梦、存储、实体、事件、对战和宝可梦图鉴集成功能集中到一个精简的公共 API 中，让不同项目能够在 Fabric 和 NeoForge 上共用同一套实现，而无需重复维护 Cobblemon 集成代码。

该前置库专注于提供基础设施，不会单独添加游戏玩法系统。

主要功能

• 宝可梦身份、形态、特征和标记
• 可复用的宝可梦属性匹配
• 支持命名空间的宝可梦种类解析
• 无需命令即可创建和生成宝可梦
• 持久化的命名空间宝可梦数据
• 检查自然 IV 和有效 IV
• 特性分类和属性类型辅助工具
• 原生宝可梦体型工具
• 队伍和 PC 存储查询
• 宝可梦实体身份、归属和状态
• 可复用的 Cobblemon 事件钩子
• 对战检查和分类
• 宝可梦图鉴进度和完成情况查询
• Fabric 和 NeoForge 共享集成层

运行要求

Minecraft： 1.21.1
Cobblemon： 1.8.1 至 <1.9.0
Java： 21
加载器： Fabric 和 NeoForge

请下载与你使用的加载器相匹配的文件。

Fabric

• Fabric Loader 0.17.2+
• Fabric API
• Fabric Language Kotlin
• Cobblemon 1.8.1 至 <1.9.0

NeoForge

• NeoForge 21.1.182+
• Cobblemon 1.8.1 至 <1.9.0

玩家须知

OS Cobblemon Library 主要是一个依赖前置库。

它本身不会添加独立的游戏内容。

当其他模组将 OS Cobblemon Library 列为必需依赖时，请安装本前置库，并确保下载与你的加载器相匹配的 JAR 文件。

如果你安装的模组都不需要 OS Cobblemon Library，单独安装它不会增加新的游戏功能。

开发者须知

OS Cobblemon Library 提供的精简公共 API 位于：

com.ourstory.oscobblemon

该 API 按可复用的 Cobblemon 专属功能领域进行组织：

• pokemon – 身份、匹配、创建、持久化数据、个体值、能力、属性、标签和体型
• entity – Pokémon 实体的身份、所有权和状态
• storage – 队伍和电脑的访问、查询、匹配和计数
• event – 可重复使用的 Cobblemon 事件订阅和生命周期处理
• battle – 对战检查和分类
• pokedex – 宝可梦种类、形态、变体和完成度查询

共享功能在可能的情况下均设计为与加载器无关，Fabric 和 NeoForge 模块则负责处理平台专属集成。

Pokémon API

Pokémon API 提供以下辅助功能：

• 稳定的带命名空间宝可梦种类标识
• 形态、特征和标记
• 兼容 Alpha 宝可梦
• 不可变的身份快照
• 可重复使用的 PokemonMatcher 谓词
• 跨命名空间解析宝可梦种类
• 创建 Pokémon 和 PokémonEntity
• 直接在服务端生成 Pokémon
• 带命名空间的持久化模组数据
• 自然个体值和超级训练个体值
• 完美个体值的数量和总和
• 普通、隐藏、强制和未知能力分类
• 检查当前形态的属性
• 数据驱动的标签
• 原生体型类别和安全的缩放值

持久化数据使用由使用该库的模组拥有的带命名空间键，让项目能够为 Pokémon 添加自身状态，而无需复制 Cobblemon 集成逻辑。

存储、实体与对战

PokemonStorage 提供对玩家队伍和电脑存储的通用访问方式，包括：

• 按 UUID 查询
• 按队伍栏位查询
• 成员关系快照
• 基于谓词的搜索
• 基于谓词的计数

PokemonEntities 提供以下只读辅助功能：

• 访问底层 Pokémon
• Pokémon UUID
• 所有者 UUID
• 对战状态
• 忙碌状态
• 进化状态
• 存在状态和存活检查

BattleInspector 提供可重复使用的对战信息，包括：

• 野生对战
• 训练家对战
• PvP 对战
• 对战参与者
• 玩家 UUID
• 参与对战的 Pokémon
• 昏厥的 Pokémon
• 胜者和败者

事件 API

1.1 版通过适用于 Java 的 Cobblemon 事件钩子扩展了前置库。

支持的事件类别包括：

• 捕获计算和捕获完成
• 进化
• 对战开始和获胜
• 昏厥和逃跑
• 对战 gimmick 指令
• 派出和收回 Pokémon
• 治疗
• Pokémon 特征
• 宝可梦图鉴更新
• 生成 Pokémon
• 实体保存和加载事件
• 孵化
• 交易
• 释放
• 昵称
• 等级变化
• 经验值变化

EventSubscriptionGroup 还可以追踪多个订阅，并一次性取消订阅，适用于可重新加载或可选的系统。

宝可梦图鉴 API

PokedexQueries 提供以下只读辅助功能：

• 已见和已捕获的宝可梦种类
• 形态进度
• 特征进度
• 闪光宝可梦发现记录
• 全局宝可梦图鉴计数
• 单个宝可梦图鉴计数
• 完成百分比

文档

完整的 API 文档、集成指南和兼容性信息可在线查阅。

文档

GitHub 仓库

文档内容包括：

• 入门指南
• 公共 API 概览
• 集成模式
• 宝可梦 API
• 存储 API
• 事件 API
• 战斗 API
• 宝可梦图鉴 API
• API 稳定性政策
• Cobblemon 更新策略
• 本地开发与 Maven 使用

许可与 API 使用

OS Cobblemon Library 本身保留所有权利，并根据 OS Cobblemon Library 专有 API 许可证进行分发。

开发者可以使用文档中说明的公共 API 构建和分发独立模组。

使用此 API 不要求依赖它的模组公开或披露其自身源代码。

除非另行获得授权，否则不得重新分发、修改构建版本、重新命名或复制 Library 源代码。

支持项目

正在项目中使用 OS Cobblemon Library 吗？

通过 Patreon 支持持续维护、兼容性更新以及即将推出的 Our Story 项目。

如需集成帮助、API 建议、兼容性反馈或错误报告，请加入 Our Story 的 Discord 社区。

游戏托管

需要为 Cobblemon 项目租用服务器吗？

使用 BisectHosting 托管服务器，并输入代码 OURSTORY 即可享受 25% 折扣。

每笔购买都有助于支持 Our Story 项目的开发。