# ArcaneLab

**Repository Path**: sxyis/arcane-lab

## Basic Information

- **Project Name**: ArcaneLab
- **Description**: No description available
- **Primary Language**: TypeScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-12
- **Last Updated**: 2026-07-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Arcane Lab

禁术研究所 / Arcane Lab 是一个以“法术研究”为核心的单机增量构筑小游戏项目。

当前仓库不是完整可发布版本，而是 Cocos Creator 3.x + TypeScript 的可玩原型，包含核心数据结构、系统模块、默认配置、Cocos 场景入口和运行时生成的 2D 战斗沙盒。

## 当前状态

- 正式项目目录：`arcane-lab/`
- 产品与技术文档：`docs/`
- 当前实现范围：菜单、实验室页、战斗沙盒、角色移动、敌人生成、自动施法、升级选择、结算、研究/图鉴/存档系统
- 当前表现方式：运行时生成的 2D 占位美术和 UI
- 暂未完成：正式 Sprite/Prefab 资产、完整 UI 组件化、完整战斗反馈、更多内容关卡

## 环境要求

必须安装：

- Cocos Dashboard
- Cocos Creator 3.x，当前使用版本为 `3.8.8`

推荐安装：

- VS Code，用于编辑 TypeScript、文档和配置
- Node.js LTS，用于后续工具脚本和包管理
- Git

说明：VS Code 可以写代码，但不能替代 Cocos Creator 的场景编辑、资源管理、预览和构建能力。

## 如何启动

当前项目应通过 Cocos Creator 打开，不通过 `npm run dev` 启动。

1. 打开 Cocos Dashboard。
2. 选择“导入”或“打开项目”。
3. 选择本仓库下的项目目录：

   ```text
   /Users/zhangyu/Code/arcane-lab/arcane-lab
   ```

4. 等待 Cocos Creator 生成或补齐 `.meta`、`library`、`temp` 等工程文件。
5. 打开 `assets/Main.scene`。
6. 确认层级中 `GameRoot` 上挂载了 `MainSceneController`，并且组件启用。
7. 点击预览。

如果入口脚本加载成功，会进入运行时生成的菜单界面，可以开始普通试炼。

## 目录结构

```text
.
├─ arcane-lab/
│  ├─ assets/
│  │  ├─ scripts/
│  │  │  ├─ core/      # 类型定义、事件总线
│  │  │  ├─ data/      # 默认配置和默认存档
│  │  │  ├─ systems/   # 法术、符文、融合、研究、图鉴、存档系统
│  │  │  ├─ scenes/    # Cocos 场景入口脚本
│  │  │  └─ ui/        # 后续 UI 组件目录
│  │  └─ resources/
│  │     └─ configs/   # 后续 JSON/资源配置目录
│  ├─ project.json
│  └─ package.json
├─ docs/               # PRD、技术架构、数据结构、开发与运行说明
├─ package.json        # 仓库级元信息
└─ README.md
```

## 文档索引

1. `docs/设计总纲.md`：设计总纲 / 长期记忆锚点
2. `docs/产品总览.md`：产品总览
3. `docs/核心系统.md`：核心系统设计
4. `docs/MVP版本.md`：MVP 范围与验收
5. `docs/开发任务拆分.md`：开发任务拆分
6. `docs/待确认决策清单.md`：待确认决策
7. `docs/技术架构.md`：技术架构
8. `docs/数据结构草案.md`：数据结构草案
9. `docs/MVP数据表.md`：MVP 可开发数据表
10. `docs/项目命名.md`：命名说明
11. `docs/项目结构说明.md`：项目结构说明
12. `docs/开发环境说明.md`：开发环境说明
13. `docs/运行Demo.md`：旧 Web demo 运行说明，当前 demo 文件已不在仓库中
14. `docs/CocosCreator运行说明.md`：Cocos Creator 运行说明
15. `docs/迭代开发计划.md`：后续分阶段开发计划

## 注意事项

- Cocos 场景编辑器中只会看到持久化节点；当前大部分 UI 和战斗对象仍由脚本在预览时生成。
- 下一步应优先提升 2D 占位表现、战斗反馈和 UI 组件化。