REVOLUTION · 文档总入口

Revolution 文档导航

17 个运行期模块 + 2 套编辑器工具的文档都在这一页。第一次来:先看 ①,再按需要往下跳。

17 个模块 · 每个模块都有《使用说明》= 手把手 · 多数另有《架构解析》= 设计论证
在线地址:yokino337088.github.io/Revolution · 本地预览:双击 预览文档.cmd
19 张卡片已显示

1第一次用:从这里开始

这三个模块是"完全没接触过框架也能照着做完"的手把手文档,也是最常用的三件事:打日志、写计时、每帧回调。

📝日志系统小白向

分级输出(Debug 正式包编译期删除)、模块标签静音、刷屏抑制、环形缓冲看现场、异步落盘。

⏱计时器系统小白向

一行创建(到点 / 每间隔 / 下一帧 / 服务器时刻)、四时间域、句柄代际失效、作用域一行全停。

🧵公共 Mono 模块小白向

让纯 C# 类也能每帧跑(Update / LateUpdate / FixedUpdate)与协程宿主;去重、上限、异常隔离。

推荐阅读顺序:日志 → 计时器 → 公共 Mono → 资源加载 → UI → 动作序列。 前三篇决定你"怎么观察、怎么排时序",后面三篇是业务天天要用的三件套。

2业务四件套:资源 · UI · 动作 · 场景

日常开发用得最多的四个模块。它们的《架构解析》里都带了完整数据流与失败处理说明。

📦资源加载系统

编辑器直读 + AB 两条后端、引用计数、自动卸载、失败原因可查;含 RevAB 打包工具的分包 / 依赖 / 体积 / 漏标 / 快照。

🎨UI 系统

面板声明式配置([RevUIPanel(root, layer)])、层级管理、与对象池联动、关闭即回收。

🎬动作序列

链式 DSL 表达"播放 → 等待 → 并行 → 嵌套",构建与播放分离,取消也有收尾契约。

🔊音效系统

一行播放(2D / 3D / BGM)、音量总线、作用域,音效表与路径常量由工具生成。

🎮状态机

轻量流程(GameFlow)与重量级 AI 两种形态,切换有明确生命周期回调。

📣事件系统

强类型事件 + 订阅句柄(取消订阅不用记委托);派发期间增删订阅的安全语义写在文档里。

🗺场景系统小白向

一行切场景(await 或挂事件)、进度永远 0~1(不卡 90%)、加载界面最短展示时长、切前按约定清理(默认清对象池)。

+扩展包:按需安装

不属于框架本体,单独一个包:导入即有、不导入零影响 —— 框架侧只多了两个默认为 null 的钩子,业务加载代码不用改。

🔄资源热更新(RevHotUpdate)

清单驱动版本比对与差量下载(只下变化过的包)、断点续传、多源降级、尺寸 + SHA-256 校验、版本目录原子切换与回滚;Android 首包落地、小游戏走版本化 URL + 引擎缓存。

⚡ 想先跑起来看:示例 Assets/Revolution.Demo/RevHotUpdate.Demo/(一键装配本地 CDN + 起本地假 CDN + 面板三步,不需要真云账号)。

4结构类与工具链

搭架子时用的模块,以及编辑器里的两套工具。

⌨️输入系统小白向

动作名绑定(键鼠 / 触屏 / 手柄)· 7 种手势(点击 / 双击 / 长按 / 拖动 / 八向滑动 / 捏合 / 旋转)· 屏蔽栈与作用域 · 输入缓冲与改键存档。

📦对象池

GameObject 池 + 纯 C# 对象池,与资源加载打通(池端着资源引用,不会被卸载掉)。

🧭服务定位器

把业务依赖挡在框架之外:三档取服务(必须有 / 可选 / TryGet)、生命周期可控。

🕹GM 指令

给方法加一个特性就注册好一条指令;游戏内控制台与编辑器面板共用同一套。

📊导表工具

Excel → C# 数据类 + txt 数据文件(WPF 独立工具,源码在 Revolution.ExcelTool/);仅数据 / 全量两种导出模式。

5进阶:为什么这么设计

想知道"框架为什么这样写、跟别的方案比差在哪"时读这几篇(不影响使用,纯设计论证)。

🔍动作序列架构解析设计向

从"为什么不用协程"讲到步骤库分层、取消收尾契约与异常隔离。

🧠状态机 Demo 示例讲解设计向

用 Boss AI / 游戏流程 / UI 栈三个例子讲两种状态机形态的分工。

⚖️依赖注入 vs 服务定位器设计向

为什么不引 DI 容器、服务定位器怎么避免变成"全局变量筐"。

🧾导表工具对比与设计说明设计向

跟主流导表方案(Luban 等)的取舍:表 = 资源、零依赖、生成物可读。

6还没写进这里的:模块级"3 分钟上手"

每个运行期模块的代码目录里都自带一份短 README(离代码最近,改代码时会顺手看到)。在 IDE 或 GitHub 里打开:

模块文件
音效系统RevolutionFrameWork_Unity/Assets/Revolution/Runtime/RevSoundSystem/README.md
计时器.../Runtime/RevTimer/README.md
日志.../Runtime/RevLog/README.md
公共 Mono.../Runtime/RevPublicMono/README.md
动作序列.../Runtime/RevActionSequence/README.md
GM 指令.../Runtime/RevGMCommand/README.md
还有个总览:仓库根目录的 README.md 里有模块一览表(每个模块多少代码、一句话能力)、 三种安装方式、目录结构与设计取向 —— 是给"准备接入的人"看的入口。