包参考
包参考
全部 @overworld-engine/* 包的定位、API 与示例
Overworld 由 27 个独立发布的包组成。大多数领域系统只依赖
@overworld-engine/core,跨系统协作走事件总线、注册表与结构类型。工具与适配器
会明确组合它所服务的低层包(例如 content → devtools、
adapters-weapp → input + platform)。真实依赖图见架构说明。
第一次使用不必从本页逐个阅读。先按目标查看包选择指南， 再进入需要的参考页。
基础层
| 包 | 说明 |
|---|---|
| @overworld-engine/core | 类型化事件总线、条件/效果注册表、持久化辅助、存档原语(槽位 + 硬化的原子文件)、可注入种子 RNG |
3D 世界层
| 包 | 说明 |
|---|---|
| @overworld-engine/scene | 场景外壳、玩家控制器、碰撞、邻近检测、模型加载与传送门 |
| @overworld-engine/environment | 昼夜循环与天气系统(无头引擎 + R3F 组件) |
| @overworld-engine/minimap | 通用俯视小地图:标记注册表 + DOM canvas 组件 |
无头引擎层
| 包 | 说明 |
|---|---|
| @overworld-engine/dialogue | 对话树引擎,条件/效果声明式解析 |
| @overworld-engine/quest | 事件驱动的任务状态机 |
| @overworld-engine/inventory | 物品/背包引擎(堆叠、容量、使用效果) |
| @overworld-engine/achievements | 由事件总线驱动的成就引擎 |
| @overworld-engine/tutorial | 教程步骤引擎(手动/事件自动推进) |
AI 层
| 包 | 说明 |
|---|---|
| @overworld-engine/ai | 网格 A*/HPA* 寻路、NPC 行为、行为树、日程系统与动态避障 |
基础设施层
| 包 | 说明 |
|---|---|
| @overworld-engine/input | 键盘输入优先级层级 + 移动端虚拟摇杆 |
| @overworld-engine/audio | BGM/音效管理器:场景-曲目映射与自动播放策略处理 |
| @overworld-engine/notifications | 无头 Toast 与 Alert/Confirm 队列 |
| @overworld-engine/loading | 资源加载进度与资产清单预加载 |
| @overworld-engine/analytics | 可插拔埋点 Provider(GA4、Clarity、console) |
| @overworld-engine/net | Transport 无关的多人同步:presence 复制/插值、事件中继、输入预测对账 |
| @overworld-engine/relay | 参考 WebSocket 中继服务器(房间广播、心跳收割),配合 net 的 WebSocket transport |
| @overworld-engine/ui | 无头游戏 UI:HUD 原语、引擎绑定组件(结构类型接入)、四套 CSS 主题皮肤 |
平台层
| 包 | 说明 |
|---|---|
| @overworld-engine/platform | 运行时平台检测、能力快照与端能力桥(web/telegram/tauri/capacitor/weapp) |
| @overworld-engine/adapters-weapp | 微信小游戏适配:wx 存储/socket/音频、R3F canvas root、指针拾取、触摸摇杆 |
| @overworld-engine/adapters-steam | Steam 适配:Tauri 桌面壳的成就、云存档与 Rich Presence 桥 |
| @overworld-engine/adapters-savefile | Tauri 桌面存档适配:真正调用 fsync 的原子写 + 轮换备份原语(core 的 AtomicFileBackend) |
工具层
| 包 | 说明 |
|---|---|
| @overworld-engine/devtools | 开发期内容校验、JSON Schema(含场景/项目)与事件总线剖析/日志 |
| @overworld-engine/editor | 游戏内场景/多关卡编辑器:摆放/移动实体、多场景管理、导出项目 JSON |
| @overworld-engine/inspector | 开发调试覆盖层:实时事件总线面板 + zustand store 快照 |
| @overworld-engine/content | 内容包:校验门控后把对话/任务/物品/成就热更新注入引擎 |
| @overworld-engine/test-kit | App 层集成测试原语:确定性事件录制 + React hook 接线检查(配合 core 的可注入种子 RNG) |