lcc-framework客户端框架插件

QQ交流群：861746804

什么是lcc-framework框架？

lcc-framework是专门为游戏开发引擎cocos creator设计的游戏开发框架，旨在帮助开发者更方便，更快速，模块化的开发单机或者网络游戏。该框架完整包含三个部分：

1. 客户端框架及配套cocos creator插件。

   客户端框架是基于多分包的模块化游戏内容组织框架，并且提供UI、场景、多语言、配置、数据表、网络等系列便利功能。配套cocos creator插件主要为客户端框架服务，提供分包代码声明文件生成、游戏发布时框架裁剪等功能。框架代码提供了非常细致的裁剪功能，可以自定义框架保留的模块，并且对于小型项目也提供自动裁剪功能，即使是小游戏也可以使用该框架。

2. 服务器框架及配套服务器发布与控制脚本。

   服务器框架是基于客户端框架开发的与之配套的框架，主要提供配置、数据库、日志、网络、数据表、工作者管理 等系列便利功能。服务器框架API和客户端框架API大部分一致，并且功能通用，比如网络模块是互通的，学习难度不会太高。配套服务器发布与控制脚本提供游戏服务器的发布与控制功能。当前游戏服务器使用typescript开发，在运行前是需要编译为javascript的，发布操作就是编译程序代码并且提取资源文件到发布目录。控制脚本可以控制多个服务器的启动和停止。

3. 原始资源配置与构建工具。

   原始资源配置用于在外部配置游戏数据，主要提供数据表Excel表、多语言Excel表、通信协议配置等系列功能。该功能主要提供给策划使用Excel表格配置游戏常量数据，提供给开发者配置客户端和服务器之间通信协议(服务器与服务器之间也可以使用这些通信协议)。资源构建工具主要编译原始资源配置为客户端和服务器需要的解析格式。

该框架的三部分也可以单独或者部分使用。比如客户端框架及配套cocos creator插件 + 原始资源配置与资源构建工具适用于纯单机游戏，服务器框架及配套服务器发布与控制脚本 + 原始资源配置与资源构建工具适用于独立服务器，完整三个部分一起适用于网络游戏。

客户端框架文档

客户端框架插件功能说明

特别注意，安装此插件后，需要在插件根目录执行npm i，以安装依赖。

1. 导入或更新框架

   在菜单栏 扩展 -> LCC框架 -> 导入或更新框架 可以使用该功能。
   该功能的目的是把 lcc客户端框架资源文件 导入到当前游戏项目中。这个功能会有以下步骤：
   

   • 在工程中查找lcc-framework文件夹路径；如果未找到，则会在根目录创建lcc-framework文件夹。
   • 把lcc客户端框架资源文件复制到lcc-framework文件夹内。

   这样框架导入或更新完成。
   从上面的步骤可以看出，lcc-framework文件夹是框架文件夹，游戏项目中应该只出现一个。

2. 构建包声明

   在菜单栏 扩展 -> LCC框架 -> 功能面包 中构建包声明页面可以使用该功能。
   该功能的目的是为每个模块化分包代码，生成独立的声明文件。这样，我们不需要把分包工程代码给其他人；只要把构建的远程分包URL和包声明文件，也许还需要一些说明文档给出去，其他人就可以使用该分包的资源和功能。包声明文件会以d.ts结尾，并且放在和assets目录同级的@types目录内。
   特别注意，当前分包不能引入生成的当前分包声明文件，否则会发生循环引入问题。

3. 发布设置

   在菜单栏 扩展 -> LCC框架 -> 功能面包 中发布设置页面可以使用该功能。
   发布设置主要是控制框架的裁剪功能。导入项目中的框架是完整的框架，我们可以在编辑器中使用全部功能。
   但是，如果发布后我们需要剔除未使用的模块，所以就需要在这里设置。具体功能有：
   

   • 框架混淆。可以混淆框架，框架本身是开源的，感觉没什么大用。
   • 自动裁剪框架。使用该功能，会在项目中搜索框架各个模块的关键字，最后决定保留的模块。这种方式可能并不能剔除所有未引用模块，但是胜在方便。而且，由于会搜索整个项目，可能比较耗时，建议小项目使用。
   • 自定义裁剪框架。更精细化的选择保留的模块。

   在发布时，裁剪功能可能需要一定时间。