diff --git a/README.md b/README.md new file mode 100644 index 000000000..59ccacd3f --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +## 前置条件 + +- Unity 版本:请确认与项目一致的 Unity 版本 +- Git 已安装并配置好 SSH 密钥 +- **必须安装 Git LFS**:本项目使用 Git LFS 管理大型文件(fbx、png、wav 等图片/音视频/3D模型文件)。未安装 LFS 会导致这些文件只下载到指针文件,Unity 打开会全部报错。 + +安装 Git LFS: +```bash +# 或通过命令行安装后初始化 +git lfs install +``` + +## 拉取步骤 + +### 1. 克隆仓库 + +HTTPS 方式: +```bash +git clone https://git.bamboogames.top/Fishing-Travel/FT-Mini.git +``` + +SSH 方式: +```bash +git clone ssh://git@git.bamboogames.top:2222/Fishing-Travel/FT-Mini.git +``` + +进入项目目录: +```bash +cd FT-Mini +``` + +### 2. 确认 LFS 文件是否正常拉取 + +克隆完成后,检查 LFS 文件是否下载成功: +```bash +git lfs ls-files | head -20 +``` + +如果输出显示文件大小为 0 或显示指针内容(如 `version https://git-lfs...`),说明 LFS 没有正常工作,执行: +```bash +git lfs pull +``` + +### 3. 打开 Unity 项目 + +1. 打开 Unity Hub,点击 **Add**(添加项目) +2. 选择克隆下来的 `FT-Mini/Client` 目录(注意是 Client 子目录) +3. 等待 Unity 首次导入资源(时间较长,请耐心等待) + +### 4. 首次导入完成后的确认 + +Unity 导入完成后,检查 Console 窗口是否有 **Missing Prefab** 相关的红色报错。如果有,请联系项目维护者确认 meta 文件是否完整。 + +## 注意事项 + +- **不要让 Unity 重新生成 .meta 文件**:如果 .meta 文件丢失或被 Unity 重新生成,会导致所有资源引用断裂(Prefab 变成 Missing)。拉取时确保所有 .meta 文件都已正确下载。 +- **切换分支前先提交或暂存**:未提交的修改直接切换分支可能导致 Unity 资源状态异常。 +- **Library 目录**:`Client/Library` 目录不会提交到 Git,首次打开 Unity 会自动生成,属于正常现象 +- 内容比较多,clone 可能耗时比较长