Plugin Adaptor | Cocos Store

About / 关于

SSRCreatorPluginAdaptor 模板的作用，是将使用 Creator v2.x 开发的游戏，转换为可以运行在 Creator v2.x/v3.x 中的插件。

作者的 ShaderEditor 插件，就是用这种技术实现的。

png

SSRCreatorPluginAdaptor 模板在实现的时候，趟了很多坑，做了很多搭桥手术，尽最大可能兼容了 Creator v2.x/v3.x 两种不同的机制，基本上用户只需要做两步:

配置一下 project.json
把要运行在插件中的游戏的发布后代码，拷贝到指定位置

插件转换过的项目在 Creator v2.4.4 和 Creator v3.1.1 的全局和本地项目两种模式下，均测试过。

Content / 内容

源码包含内容:

SSRCreatorPluginAdaptor2D

包含测试插件的 Creator v2.4.4 项目
SSRCreatorPluginAdaptor3D

包含测试插件的 Creator v3.1.1 项目
SSRCreatorPluginAdaptorTemplate

插件模板，具体使用方式见文档
文档中用于测试的官方游戏，下载地址:

https://gitee.com/mirrors_cocos-creator/tutorial-first-game

https://gitee.com/mirrors_cocos-creator/tutorial-blackjack

How to Use / 使用方式

使用方式十分简单，可以先看一下视频操作:

SSRCreatorPluginAdaptor2D 操作教程

SSRCreatorPluginAdaptor3D 操作教程

将 SSRCreatorPluginAdaptorTemplate 下的 ssr-creator-plugin 文件夹拷贝到项目中，插件的位置

Creator v2.x 路径为: your_game_project/packages

Creator v3.x 路径为: your_game_project/extensions
重命名 ssr-creator-plugin 中的配置文件 project.json

插件的运行需要一个 project.json 配置文件，且 v2.x/v3.x 格式内容不同

因此 SSRCreatorPluginAdaptorTemplate 中保留了两个文件:

package_v2.json // v2.x 用

package_v3.json // v3.x 用

只需保留对应需要的文件，删除不用的，并且将需要的重命名为 project.json
准备需要转换的游戏

将想要转换为插件的游戏，发布为 Web Desktop 项目即可
将发布好的游戏，拷贝到插件下 ssr-creator-plugin/app 目录中即可
重启 Creator 编辑器就可以看到我们的插件了

如果需要修改插件的名称，操作如下:

修改 ssr-creator-plugin 文件夹的名称，如改为 my-plugin
将 project.json 中的 ssr-creator-plugin 字符串替换为 my-plugin 即可

MD5 Cache

想要转换为插件的游戏发布时有个 md5 caches 选项，如果开启了，生成的文件名会带上 md5 信息，这种情况下需要在 project.json 中配置一下 md5 信息:

"ssr_creator_plugin": {
    "md5": {
        "enable": false,     // 需要改为 true，打开 md5 cache
        "style": "style-desktop.81ede.css", // 请填写实际的文件名
        "main": "main.d9aa9.js",  // 请填写实际的文件名
        "settings": "settings.69c84.js",  // 请填写实际的文件名
        "cocos2djs": "cocos2d-js-min.cd734.js"  // 请填写实际的文件名
    }
}

这样，就可以支持 md5 cache 发布的项目了。

Attention / 注意

转为插件的游戏，必须使用 Creator v2.x 开发，Creator v3.x 开发的不行 (但是转换好的插件可以在 Creator v.2/3 中运行)
目前转换为插件的游戏，只能在 float/浮动 状态下运行，切换为 doct/停靠 状态，会报错，这一问题暂时没有解决，估计也很难解决，官方给出的回答建议是:

插件在 dock 和 float 状态下，所处的引擎环境是不同的，不建议在 dock 状态下，去启动插件内部包含的 Creator 引擎，否则可能会导致不可预知的严重错误
项目并未包含 Creator 编辑器 和 插件 交互的示例代码，当然这是可以做到的，只需要使用官方提供的解决方案即可:

https://docs.cocos.com/creator/manual/zh/extension/scene-script.html
个人认为，插件开发最好还是走正统套路 node.js + vue + html + css + ...... ，如果你也想尝试下这种用 Creator 开发 Creaotr 插件的可能性的话，那么欢迎一试