本项目目前使用 monorepo 划分和管理包，共有如下包：
- 核心部分
@gi-tcg/core核心逻辑与游戏流程@gi-tcg/data官方卡牌数据表示
- 界面部分
@gi-tcg/webui-core基于 Solid 的 Web 用户界面组件@gi-tcg/webui基于 Web Component 的用户界面包装@gi-tcg/deck-builderWeb 端组牌器组件@gi-tcg/detail-log-viewerWeb 端核心结算细节日志查看组件@gi-tcg/standalone用于调试的集成 Web 用户界面
- 对战平台相关
@gi-tcg/server对战平台服务器实现@gi-tcg/web-client对战平台客户端（Web 版）实现
- 跨语言绑定
@gi-tcg/cbinding提供核心模拟器+官方卡牌数据的 C 接口@gi-tcg/pybinding基于 C 接口的 Python 接口实现
- 其它
@gi-tcg/static-data官方静态数据源@gi-tcg/typings定义基本数据类型前后端通信格式@gi-tcg/utils实用工具集合@gi-tcg/test核心与卡牌数据测试框架
下一步……
- 如果你需要在你的程序中使用这些项目组件，请参阅下方使用接口以及对应包的
README.md了解使用方式； - 如果你需要参与本项目的开发，请参阅下方参与开发，其中的例子可供参考；如有疑问可邮件联系或在 Discussion 中发起讨论。
核心库暴露了 Game 类代表对局。其构造参数大致为：
import getData from "@gi-tcg/data";
import { Game } from "@gi-tcg/core";
// 1. 从双方牌组构建初始状态
// ==========================
// - data() 从 @gi-tcg/data 包获取官方的卡牌代码
// - decks 为双方的初始牌组 id 列表，格式为 { characters: number[], cards: number[] }
// deck0，即 0 号玩家总是先手
const state = Game.createInitialState({
data: getData(),
decks: [deck0, deck1],
});
// 2. 构造 Game 实例，并设置 IO 方式
// =================================
// - 游戏会在部分结算完成节点执行 onPause，设置此钩子函数以进行调试
// - 通过 players[x].io 设置双方玩家如何与核心交互（参见下文）
const game = new Game(state);
game.onPause = async () => { /* ... */ },
game.players[0].io = /* ... */;
game.players[1].io = /* ... */;
// 3. 开始游戏！
// ============
// Promise 返回 0 | 1 | null 表明本场游戏的胜利方。
const winner = await game.start();interface PlayerIO {
notify: (notification: NotificationMessage) => void;
rpc: (request: RpcRequest) => Promise<RpcResponse>;
}玩家的交互行为在 io.players 中定义。其中：
- 在合理的时机游戏会调用玩家的
notify函数以通知玩家有某些牌局的变化； - 在需要玩家操作（指重投骰子、切换手牌、选择出战角色、选择行动）的时刻，会调用
rpc获取玩家的选择。也可通过实现此接口接入 AI 智能体。
详细说明请参见 io。
配置开发环境。安装 Bun，随后在仓库根目录下执行下述命令既可：
bun install
bun run build随后即可调试修改数据定义包、核心包或者其它代码。
cd packages/standalone
bun dev
定义卡牌数据被设计为“应当”非常简单的操作。请查阅 @gi-tcg/data 包的代码。参考文档位于 data。
编辑完成后，可使用 @gi-tcg/webui-core 库测试修改。具体来说，可以修改 webui-core 库的 src/dev.tsx 的 PlayerConfig 以包含需要测试的卡牌，并使用 Vite 预览对局。
cd packages/webui-core
# 编辑 src/dev.tsx
bun dev # 查看效果在阅读 @gi-tcg/core 的源码之前，可以先参阅下述文档：
同样地，可以使用 @gi-tcg/webui-core 来测试核心的修改情况，流程与上节相同。
修改 @gi-tcg/typings 中定义的数据结构后，请使用 bun run build 生成对应的 JSON Schema 文件。（否则核心可能会校验失败，切记！）
核心库中的 src/io.ts 中存在翻译 GameState 到对应数据格式的代码，你可能也要一并修改。