Repository files navigation

HTFramework是基于Unity的一个快速开发框架，集需求模块化、代码重用性、实用便捷性、功能高内聚、统一编码规范、可扩展性、可维护性、可通用性、可插拨性为一体，并提供持续维护、升级。

• Unity版本：2022.3.34。

• .NET API版本：.NET Framework。

• 编码及代码审查遵循此规范HTCODINGSTANDARD。

• Blog:wanderer.blog.csdn.net。

• AspectTrack - 根据AOP思想设计的一个面向切面的程序代码追踪模块，它可以跟踪每一个方法的调用，在调用前阻断该方法，亦或是更改其传入的实参，更改其返回值等！可以用于调用日志打印，系统运行监控等需求。

• Audio - 项目中所有音频的管理器，提供统一的接口用来播放、暂停、停止各种音频资源。

• Controller - 封装了主角控制、主摄像机控制、射线检测等，比如支持自由操作的自由控制视角，可扩展的第一人称、第三人称视角。

• Coroutiner - 协程调度器，通过协程调度器启动的协程，将会处于调度器的监控中，可以通过CoroutinerTracker追踪面板查看协程的运行状态、运行耗时，可重启、终止任意协程。

• CustomModule - 框架内置了多个常用的模块，如果想要添加自己的模块，通过CustomModule添加自定义模块即可，自定义模块拥有与内置模块完全一样的生命周期。

• DataSet - 数据集管理器，任何需要存储数据的地方都可以定义为自定义数据集，包括预制的配置文件、运行时生成的动态数据、从后台拉取的各种数据等。

• Debug - Debug模块自带Debugger运行时调试器，可以监控一些常规数据与软件运行环境，或是进行一些高级的操作，比如检索场景所有游戏对象（等效于编辑器内Hierarchy窗口的功能），检索游戏对象的所有组件（等效于编辑器内Inspector窗口的功能）。

• ECS - 实体-组件-系统，此ECS非Unity的ECS，并不一定会带来性能的提升，只是基于ECS的思想，建立在Unity现有的组件模式之上，以ECS模式进行开发可以避开项目后期繁重的继承链，提升开发速度和质量、以及项目稳定性。

• Entity - 实体管理器，除去UI以外，场景中的其余可见物体都应该抽象为Entity，在Entity之上配合FSM一起管理逻辑，将是一个不错的搭配。

• Event - 可以将一切操作定义为具体的全局事件，通过订阅事件、抛出事件以驱动整个业务逻辑。

• Exception - 异常处理器，当程序任何部位发生未知、未捕获的异常时，他会在这里被截获，并写入日志文件，同时支持在异常发生时打开指定程序（仅在PC平台），或者在异常发生时回馈日志到指定邮箱。

• FSM - FSM模拟一切可以抽象为有限状态机结构的业务逻辑，类似于角色动画、怪物AI、任意有独立逻辑的个体等。

• Hotfix - 以C#反射实现的轻量级热更新框架，开发非常方便，新项目只需要拉取框架源码后，一键即可创建热更新环境，之后便可以用C#正常开发，目前已支持在热更新库中动态修复外界的任何方法，无需重新发布项目。

• Input - 将任意输入都定义为虚拟输入，再由Input模块统一调用，将是跨平台输入的最优解决方案。

• Instruction - 指令系统为Unity动态修补程序、热更新等提供了另一种补充方案，我们可以将任意一段指令代码即时编译并执行（请放心，即时编译的性能开销极低），达到运行时随意修改程序功能的需求。

• Main - 框架主模块，提供访问其他模块的快捷接口，还支持快捷设置脚本定义、指定全局主要数据类、设置项目授权、以及配置全局参数等。

• Network - 网络客户端模块，以单个通信管道为单位，每个管道均支持TCP/UDP等协议，可以为每个管道定义通信消息格式，基本能胜任一些常见的通信环境。

• ObjectPool - 专用于GameObject类型的对象池，可以复用任意GameObject对象，以达到减少系统在频繁创建和删除对象时的开销。

• Procedure - 流程是框架的核心模块，也是最基本的模块，他贯穿整个框架的始终，从框架的生命周期开始，到生命周期结束，都会在流程间完成，同时，他又是一个强化版的有限状态机，当在多个流程间切换直至最终流程时，便代表整个系统的结束。

• ReferencePool - 可用于任意引用类型（除GameObject）的对象池，可以复用任意引用类型对象，以达到减少系统在频繁创建和删除对象时的开销。

• Resource - 资源管理器，主要用于动态加载资源（只支持异步加载），在加载中或加载完成后都可以进行自定义操作，现在主要支持Resource加载模式、AssetBundle加载模式、Addressables加载模式，比如，UI模块就会自动调用资源管理器加载UI实体。

• StepMaster - 步骤编辑器，用来解决一系列冗长的序列任务流程，支持可视化编辑和自定义步骤助手。

• TaskMaster - 任务编辑器，可以自定义任务点，设置任务达成条件，多个任务点组成一个任务内容，使用一系列任务内容完成角色扮演的设计。

• UI - 用于管理全局的UI实体，以省去手动创建UI实例、销毁UI实例等一系列操作，他可以在非常方便且省去不必要的开销优势下，让你条例清晰的组织和管控好任何复杂的UI结构。

• Utility - 实用工具，包含大量编辑器实用工具及运行时实用工具。

• WebRequest - 网络请求模块，主要用于与web服务器通信，比如请求某一网络链接或服务器接口，获得回复或下载网络上的资源。

• AI【可选模块】 - AI相关模块，比如A*寻路以及各种人工智能模块。

• Deployment【可选模块】 - 轻量级资源部署管线，整合资源打包、资源版本构建、资源版本更新为一体，快速实现资源部署和交付游戏。

• GameComponent【可选模块】 - 游戏组件模块，本模块整合了多个游戏开发过程中可能会涉及到的子系统或组件，包括但不仅限于文件系统、本地化系统、新手引导系统、时间系统、AVG2D系统、FTG2D系统、RPG2D系统等，且各个系统或组件均为可插拨式，可一键移除不需要的系统或组件，或再次一键导入。

• AssetBundle Browser 1.7.0。

• Dotween Free 1.2.632。

• LitJson 0.17.0。

• 入门级Demo。

• 应用级Demo - 超级坦克大战。

• 应用级Demo - FTG2D横版自由格斗。

• 应用级Demo - RPG2D角色扮演与回合制战棋。

• 1.框架中所有On开头的函数为生命周期函数或回调函数，均由框架呼叫，请勿手动调用。

• 2.框架中的Procedure（流程）必须包含至少一个流程才能正确构建项目，而其他模块，如无需要，均可以不使用。

• 1.入口场景为一切的开始，也为一切的结束，整个游戏的生命周期都将在入口场景中完成，不建议使用多场景切换模式，如果确实需要使用，可以将其他场景打入AB包内加载。

• 2.入口场景中只包含框架主模块（或其他自定义主模块、主控制器），其他任何东西都应该是动态加载的。

• Addressables - 使用Addressables可寻址系统。

• Assets Master - 资产管理器，允许你在编辑模式或是运行模式非常直观的查看和管理当前打开场景中的你感兴趣的资产。

• Auto Attach Namespace - 新建脚本时，自动向脚本添加命名空间。

• Code Snippet Executer - 适用于代码片段测试、单元测试的编辑器工具。

• HybridCLR - 使用HybridCLR热更新。

• Inspector - 支持通过简单的在序列化字段上添加特性标记从而实现在Inspector界面自定义多种实用的检视器效果。

• License - 授权验证功能支持在你的游戏启动时，执行指定的授权检查，可以是本地授权检查，也可以是远程授权检查，只有授权检查通过才能正常进入游戏，如果授权检查失败，框架将会瘫痪整个程序，无论用户做出任何补救措施都将是徒劳。

• Location - 使用Location设置Transform的位置、旋转、缩放。

• Markdown Text - MarkdownText为Text的扩展加强版，支持在运行时解析并显示Markdown格式的文本。

• MVVM - UI的数据驱动模式。

• Project Folder Locker - 在Project窗口中将插件文件夹、或不需要经常访问的文件夹加锁，保持Project窗口的干净整洁。

• Scene Handler - 支持通过简单的在序列化字段上添加特性标记从而实现在Scene界面自定义多种实用的控制柄。

• Settings - 全局设置面板可以快捷、统一的设置全局的一些参数，还可以自定义设置项，用来设置自己的任何游戏参数。

• Search By Layer Or Tag - 通过Tag、Layer批量搜索物体。

• StandardizingNaming - 建立统一的标准化命名规范。

• Table View - 使用TableView可以很方便的在编辑器中绘制表格视图。

• 控制反转 - 在Unity中使用控制反转模式。

• 1.拉取框架到项目中的Assets文件夹下（Assets/HTFramework/），或以添加子模块的形式。

• 2.在入口场景的层级（Hierarchy）视图点击右键，选择 HTFramework -> Main Environment（创建框架主环境），并删除入口场景其他的东西（除了框架的主要模块，其他任何东西都应该是动态加载的）。

• 3.参阅各个模块的帮助文档，开始开发。