GameFramework替换源码
--------使用StarForce 为例---------

项目工程


GameFramework源码地址


PS Important!!! GameFramework源码的版本要和StartForce项目的版本要匹配，不然会报错



下载StartForce项目和GameFramework源码项目


打开StarForce的Assets/GameFramework/Libraries,找到GameFramework.dll，将其删除


如果使用Unity 2017.3(不包含)以前的版本，直接把GameFramework 源码目录拷贝到Plugins目录中即可（如果不存在Plugins目录，请自己创建一个）


如果使用Unity 2017.3及以后的版本，把gameframework源码目录拷贝到项目的任意文件夹（建议放在原GameFramework.dll的文件夹）


在GameFramework源码同级目录新建GameFramework.asmdef文件（其实文件名字是啥都行）创建asmdef文件方法：Project面板=>右键=>Create=>Assembly Definition


设置GameFramework.asmdef文件的Allow ‘unsafe’ Code属性为true


给UnityGameFramework.Editor.asmdef添加依赖，设置给文件的Assembly Definition References添加 UnityGameFramework.Runtime.asmdef、GameFramework.asmdef引用


给UnityGameFramework.Runtime.asmdef添加GameFramework.asmdef引用，操作同上


Ok了，我们就可以愉快的学习源码了，2333！！


如果报错，请检查源码和项目使用的GameFramework.dll版本是否一致

目录

目的：方便查看源码

一、删除原GameFramework.dll及其相关信息

二、下载GameFramework工程

三、创建dll、设置dll依赖

目的：方便查看源码

测试工程版本：Unity2017.4.32f1

测试工程：StarForce工程（依赖UnityGameFramework的一个UnityDemo)

一、删除原GameFramework.dll及其相关信息

在Project窗口搜索 "GameFramework.dll" ，找到并删除它。

在Project窗口搜索 "link", 它位于UnityGameFramework/Libraries，去掉<assembly fullname="GameFramework" preserve="all" />



若不去掉，打il2cpp包时会报错。

二、下载GameFramework工程

https://blog.csdn.net/qq_39574690/article/details/109213700

解压后，将其中的GameFramework文件夹整个拷贝到Assets目录下。

三、创建dll、设置dll依赖

在GameFramework文件夹下新建dll文件 （Unity2017的功能），起名为“GameFramework” （名字随意）



在Project窗口搜索 “UnityGameFramework.Editor” 和 “UnityGameFramework.Runtime”  dll文件，追加GameFramework.dll文件依赖。

 

 

写在前面

什么是Game Framework

Game Framework是一个基于 Unity 5.3+ 引擎的游戏框架 ，完全开源、功能强大且作者一直在更新功能。

它主要对游戏开发过程中常用模块进行了封装，很大程度地规范开发过程、加快开发速度并保证产品质量。

 

为什么要使用一个优秀的框架开发游戏

大家可以看看这个UNITE －Unity项目架构设计与开发管理_腾讯视频 ，这是在UNITE 2015 BEIJING上，时任Unity大中华区技术总监刘钢的演讲。

原则上Unity本身就是一个大的架构，但是为了应付足够多的环境，Unity没有做过多的限制，既允许你仅仅只用单一的Empty Game Object，也也允许你自己客制复杂的 Manger of Mangers 来分类管理各个功能模块。

当你准备开发一个稍大一点的游戏时，就会发现游戏内各种资源、实例如果不通过一些合理的方式整理起来，就会变得杂乱无章，无形之中提高了开发难度，游戏越复杂，难度越大。这时候你就需要框架了。

 

为什么要学习使用Game Framework

对于游戏开发者来说，最适合自己的框架无非是自己在从小项目到大项目的过程中，自己整理出来的可复用代码。但是对于像我这样没什么经验的新手，想要学习这方面的知识，最快的方法无非是学习别人的框架了。Game Framework毫无疑问是一个非常优秀的框架，相对来说比较适合我们学习（要是作者能再多写一些文档就好了），而且也是开源的，作者E大（Ellan）游戏上线时间也不长，工作上也比较忙，我们也没法要求更多。

 

学习Game Framework有什么要求

只要你接触过Unity，知道C#最基础的语法就能开始学习了（完全不用，因为我自己就没达到这个水平T-T）。

当然因为我本身能力就非常有限，所以只能一步一步来。

开始接触Game Framework

首先我们得下载Game Framework的资源包。

进入Game Framework官网的下载界面，点击下载最新版本。

接着，新建一个Unity空项目，将资源包导入进去。



等待导入完成后，资源目录是这样的：



资源包本身为我们提供了一个示例场景，我们双击切换至Example文件夹下的Example场景。

点击Play按钮，激活场景。



可以看到场景中左上角显示了一个正在显示帧数的方框，那是Game Framework Debugger。还能看到console里面五条信息，三条Log，一条Warning和一条Error。

Game Framework version is 3.1.3. Unity Game Framework version is 3.1.3.
UnityEngine.Debug:Log(Object)
During this run, Game Framework will use editor resource files, which you should validate first.
UnityEngine.Debug:Log(Object)
Hello! This is an empty project based on Game Framework 3.1.3.
UnityEngine.Debug:Log(Object)
Hello! This is an empty project based on Game Framework 3.1.3.
UnityEngine.Debug:LogWarning(Object)
Hello! This is an empty project based on Game Framework 3.1.3.
UnityEngine.Debug:LogError(Object)

第一条Log信息提示当前Game Framework和Unity Game Framework的版本，第二条显示我们目前使用的是Editor内的资源文件（而不是已经打包好的Asset Bundle，这个我会在以后的文章里面讲到）。

后面三条信息是作者分别用三种方式告诉我们，我们打开的是示例的空项目。

 

接着我们打开Example文件夹内的C#文件。

using GameFramework;
using GameFramework.Procedure;
using ProcedureOwner = GameFramework.Fsm.IFsm<GameFramework.Procedure.IProcedureManager>;
​
namespace GameFrameworkExample
{
    public class ProcedureExample : ProcedureBase
    {
        protected override void OnEnter(ProcedureOwner procedureOwner)
        {
            base.OnEnter(procedureOwner);
​
            string welcomeMessage = string.Format("Hello! This is an empty project based on Game Framework {0}.", GameFrameworkEntry.Version);
            Log.Info(welcomeMessage);
            Log.Warning(welcomeMessage);
            Log.Error(welcomeMessage);
        }
    }
}
​

可以看到，在重写的OnEnter函数内，Log.Info(welcomeMessage);、Log.Warning(welcomeMessage);、Log.Error(welcomeMessage);这三句对应了三条消息。

这些代码是通过什么方式调用的？下篇文章我们就来学习Game Framework的核心内容之一：流程（Procedure）。

为了方便我们研究Demo和学习框架，我们要把GameFramework.dll替换成源码。在此之前，请确保GF和UGF皆为最新版本。

环境：



若当前使用的 Unity 2017.3（不含）以前的版本

将 Game Framework 源码目录拷贝至 Plugins 目录（若不存在 Plugins 目录，请自行创建）中即可。

1.打开项目的UnityGameFramework文件夹，打开Libraries，把GameFramework相关资源全部删除



2.回到Unity中，将GameFramework源码拖入Assets文件夹下



3.等Unity刷新好，我们就可以惊喜的发现，有满屏的报错



我们发现大都是引用缺失的问题

我们打开Libraries下面的link.xml文件，发现有这样一句话



和我们没关系，所以不用管

我们再看报错



发现绝大多数报错原因都是找不到GF而造成的

顺着报错路径，我们发现了这个



这个是unity2017.3的新特性：程序集定义文件，参考：https://blog.csdn.net/zhenghongzhi6/article/details/78874580

于是我们知道了，要让UGF模块拿到GF需要这个文件

所以我们在GF里创建







在UGF的Runtime程序及定义文件添加GF引用，Apply一下





等Unity编译完成，我们发现报错已经大大减少



我们继续解决问题，发现有Editor模块缺少GF引用



于是给UGF的Editor程序集定义文件添加GF引用，Apply



OK，此时Console窗口什么都没有了，可以运行游戏了。

我们发现Debug窗口有很多很多输出，这是由于编辑器模式下是宏编译状态，所以GF源码里面的Debug全部会输出，如果不想看到这么多Debug，就顺着源码把Debug给注释掉。

接下来我们就可以体验追踪源码的乐趣了

比如

找到

追踪ShowEntity



一路追踪到这里，此时，如果使用的是程序集，即dll的话，追踪到此为止，由于我们使用的是源码，所以可以进一步查看



顺着IEntityManager接口，查找引用，找到EntityManager，找到里面的ShowEntity，箭头所指即为原始实现方式





至此，ShowEntity函数追踪完毕，大家可以以此为参考，学习GF这个强大的框架