From f2da6fda10bbb231868c23d90f1d450a72ddbf66 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Mon, 2 Feb 2026 01:00:50 +0000 Subject: [PATCH] Update README.md --- README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/README.md b/README.md index e69de29..58563ba 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,59 @@ + + +# Final Core (Final Framework) + +## 项目简介 + +**Final Core** 是一个专为 Unity 游戏开发设计的编辑器框架。该项目主要包含了编辑器扩展工具、UI 资源管理流程以及集成的常用第三方库。它的核心目标是优化 UI 制作流程,特别是结合了 Unity 的 **Addressable Asset System**(可寻址资源系统)来自动化资源管理。 + +## 功能特性 + +1. **UI Packer 工具 (`FFW/Packer`)** + * **版本管理**:可视化界面管理项目版本号(格式:`A.B.C`)。 + * **Addressable 集成**:内置 `AddressableGroupSetter`,可以自动化将 UI 资源添加到 Addressable Groups 并设置地址(Address)。 + * **模板生成**:提供标准化的 UI Panel 和 PopWindow 模板,支持一键生成目录结构、预制体(Prefab)和脚本框架。 + * **快捷键**:使用 `Ctrl/Cmd + L` 快速打开打包工具窗口。 + +2. **编辑器基础库** + * 提供了 `UIPanelBaseEditor` 等基础编辑器类,用于扩展 Unity Inspector UI。 + * 包含针对 UI 面板的基础编辑功能。 + +3. **第三方插件集成** + * **DOTween**:强大的 Unity 动画库,用于处理平滑的动画效果。 + * **UniRx**:响应式编程(Reactive Extensions)库,用于简化异步操作、事件流和游戏逻辑。 + +## 项目结构 + +项目目录结构清晰,区分了编辑器代码和运行时依赖: + +* `Editor/`:包含所有编辑器扩展脚本。 + * `FFW/`:核心框架的编辑器代码。 + * `Packer/`:**核心工具目录**,包含 `PackerWindow`(打包窗口)、资源模板 (`UITempletes/`) 和 Addressable 设置逻辑。 +* `Plugins/`:第三方依赖库。 + * `Demigiant/`:DOTween 动画引擎。 + * `UniRx/`:UniRx 响应式库。 + +## 快速开始 + +### 安装 + +1. 将仓库克隆或下载到本地。 +2. 将 `Assets` 目录下的 `Editor` 和 `Plugins` 文件夹复制到你的 Unity 项目的 `Assets` 目录中。 + +### 使用 Packer 工具 + +1. 在 Unity 编辑器菜单栏中点击 **FFW -> Packer**。 +2. 或者使用快捷键 **`Ctrl + L`** (Windows) / **`Cmd + L`** (Mac) 打开。 +3. **配置**: + * 选择你的 UI 目录(UI Dir)。 + * 设置版本号(Version A/B/C)。 +4. **操作**: + * 点击 **Create UIPanel** 或 **Create PopWindow** 根据模板快速生成新的 UI 界面。 + * 修改完配置后,保存配置(On Save Config)或写入 Addressable 设置。 + +## 许可证 + +本项目遵循 `LICENSE.md` 中规定的开源许可证。 + +* **DOTween**: 使用 Demigiant 许可。 +* **UniRx**: 使用相应许可。 \ No newline at end of file -- Gitee