docs: add README with setup guide
This commit is contained in:
@@ -0,0 +1,67 @@
|
|||||||
|
# VFSUnity
|
||||||
|
|
||||||
|
基于 Unity 2022.3.62f3c1 (URP) 的项目。
|
||||||
|
|
||||||
|
## 环境要求
|
||||||
|
|
||||||
|
| 工具 | 版本 |
|
||||||
|
|------|------|
|
||||||
|
| Unity Editor | **2022.3.62f3c1**(必须一致,建议通过 Unity Hub 安装) |
|
||||||
|
| Unity Hub | 3.x+ |
|
||||||
|
| 渲染管线 | Universal Render Pipeline (URP) 14.0.12 |
|
||||||
|
|
||||||
|
## 快速开始
|
||||||
|
|
||||||
|
### 1. 克隆仓库
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone http://199.68.217.153:3000/yangbear/VFSUnity.git
|
||||||
|
```
|
||||||
|
|
||||||
|
> 如果 Gitea 要求认证,用户名为 `yangbear`,密码中的 `/` 需要替换为 `%2F`:
|
||||||
|
> ```
|
||||||
|
> http://yangbear:yangbear240617..%2F@199.68.217.153:3000/yangbear/VFSUnity.git
|
||||||
|
> ```
|
||||||
|
|
||||||
|
### 2. 用 Unity Hub 打开
|
||||||
|
|
||||||
|
1. 打开 **Unity Hub**
|
||||||
|
2. 确保已安装 **Unity 2022.3.62f3c1**(在 Installs → Install Editor 中选择此版本)
|
||||||
|
3. 点击 **Open** → 选择 clone 下来的 `VFSUnity` 文件夹
|
||||||
|
4. Unity 会自动加载并解析 `Packages/manifest.json` 中的依赖包
|
||||||
|
|
||||||
|
### 3. 首次打开等待
|
||||||
|
|
||||||
|
- Unity 首次打开会下载项目依赖(URP、TextMeshPro 等),可能需要几分钟
|
||||||
|
- 等待编辑器完全加载后,在 **Project** 窗口中双击 `Assets/Scenes/SampleScene.unity` 打开主场景
|
||||||
|
|
||||||
|
### 4. 运行
|
||||||
|
|
||||||
|
- 点击顶部工具栏的 ▶ **Play** 按钮即可运行
|
||||||
|
|
||||||
|
## 项目结构
|
||||||
|
|
||||||
|
```
|
||||||
|
VFSUnity/
|
||||||
|
├── Assets/
|
||||||
|
│ ├── Scenes/ # 场景文件
|
||||||
|
│ └── Settings/ # URP 渲染管线配置
|
||||||
|
├── Packages/ # Unity 包依赖清单
|
||||||
|
├── ProjectSettings/ # 项目全局设置
|
||||||
|
└── README.md
|
||||||
|
```
|
||||||
|
|
||||||
|
## 依赖包
|
||||||
|
|
||||||
|
核心依赖已在 `Packages/manifest.json` 中锁定版本,Unity 打开时会自动恢复:
|
||||||
|
|
||||||
|
- **Universal RP** 14.0.12 — 渲染管线
|
||||||
|
- **TextMeshPro** 3.0.7 — 文字渲染
|
||||||
|
- **Timeline** 1.7.7 — 过场动画
|
||||||
|
- **UGUI** 1.0.0 — UI 系统
|
||||||
|
|
||||||
|
## 注意事项
|
||||||
|
|
||||||
|
- **不要删除 `.meta` 文件** — Unity 用它们追踪资源和 GUID
|
||||||
|
- 如果报错缺少模块,检查 Unity Hub 安装该版本时是否勾选了 **Windows Build Support (IL2CPP)**(当前配置了 Burst AOT for Windows)
|
||||||
|
- 建议在 Unity Hub → Installs → 对应版本 → Add Modules 中补充缺失平台支持
|
||||||
Reference in New Issue
Block a user