Verge3D开发者工具包

Verge3D开发者工具包（DevKit）是一个示例、工具和源代码的集合，通过 Verge3D企业版提供。这个集合将帮助您执行各种开发任务，例如：

学习并评估Verge3D工具包的内部功能：
修改Verge3D并在您自己的3D应用程序中使用修改版本。
使用您自己的类和方法扩展Verge3D API。
添加新的拼图模块。
通过添加您自己的数据或参数来增强Verge3D glTF导出器。
以 Verge3D for WordPress 插件为参考，为WordPress开发您自己的产品配置程序或电子商务系统，

开发者工具包是为那些希望修改引擎的经验丰富的程序员准备的。创建具有标准功能设定的Verge3D应用时，并不需要它。

安装和配置

从您的帐户仪表板下载区域获取DevKit压缩包。将此压缩包解压到自定义目录中。

如果您想从源代码构建Verge3D引擎或拼图，需要使用 npm 工具，它是 node.js 运行时的一部分。您可以参照如下说明安装 npm 。

最后，进入DevKit的解压目录，执行下面的命令来安装依赖项：

npm install

DevKit结构

新安装的DevKit包括以下目录：

目录	说明
addons/verge3d	Blender插件的源代码（Verge3D for Blender或Verge3D旗舰版）。
build	预构建的Verge3D引擎脚本和附加模块（ammo.js等）。
max_plugin	3ds Max插件的源代码（Verge3D for 3ds Max或Verge3D旗舰版）。
maya_plugin	Maya插件的源代码（Verge3D for Maya或Verge3D旗舰版）。
puzzles	拼图编辑器的预构建脚本和源代码。
python	Python 3 运行时和实用程序模块。
src	Verge3D引擎源代码。
templates	Verge3D应用模板。
utils	各种实用程序脚本。
WordPress	Verge3D for WordPress 插件源代码。
xz	XZ压缩模块的源代码。

构建Verge3D

在编译Verge3D之前，请确保您已经安装了 npm 和所有所需的依赖项，如上所述。

要测试和调试Verge3D，您可以编译 未优化 的build，请在DevKit目录中执行以下命令：

npm run build

您可以在devkit的 build 目录中找到编译好的模块。要对其进行测试，只需将 v3d.js 引擎模块复制到Verge3D安装内部的应用中，例如：

cp build/v3d.js ~/verge3d/applications/my_awesome_application/

如果要编译 已优化的 Verge3D（也称为发行版），请在DevKit目录中执行以下命令：

npm run build-release

以下命令用于构建拼图逻辑编辑器。建立一个 未优化的 版本类型：

npm run build-puzzles

要建立一个 已优化的 版本，请执行：

npm run build-puzzles-release

您可以在DevKit的 puzzles 目录下找到已编译好的拼图编辑器脚本：要将其应用到Verge3D，请将该目录的全部内容复制到Verge3D安装中的 Puzzles 目录（替换已存在的文件）。

激活引擎模块

要使用您的授权码对对已编译的引擎模块进行签名，请使用 utils 目录中的 keymanager.py 脚本（需要 python）：

./keymanager activate ../build/v3d.js XXXXXXXXXX

其中 XXXXXXXXXX 是您的授权码。因为此命令不打印任何内容，因此您需要运行编译后的引擎，在应用管理器中新建应用，检查页面是否包含 MADE WITH VERGE3D TRIAL 水印来验证激活效果。

添加新方法到JavaScript API

假如您想添加一个额外的方法到 App 类中。例如， printHelloWorld() 方法可将指定内容打印到浏览器控制台：

App.printHelloWorld()

这一 App 类通过位于 src/extras/App.js 的模块实现。打开并将以下代码添加到文件的末尾，即 App 类的关闭括号之前。别忘了在前一个方法代码的末尾再加一个逗号。


      printHelloWorld: function() {
          console.log('Hello World!');
      }

构建并将拼图运行库复制到Verge3D安装文件夹中。您现在可以在拼图编辑器中尝试新添加的模块。

向JavaScript API添加新类

要用一些自定义类来补充Verge3D API，请在DevKit的 src 文件夹的相关子目录（例如src/extras/MyAwesomeClass.js)中创建一个以类命名的.js文件。在这个.js文件中实现自定义的类——您可以从已经存在的类中得到启发。最后，通过在 src/v3d.js 文件中添加以下行，在全局名称空间 v3d 中注册您的类：

export { MyAwesomeClass } from './extras/MyAwesomeClass.js';

构建并将Verge3D运行库复制到应用中，然后在浏览器控制台中试用。


      const myAwesomeStuff = new v3d.MyAwesomeClass();
      myAwesomeStuff.whatEver();

添加新的拼图

要创建自定义拼图块，请编辑 puzzles/src/puzzles_blocks.js 文件。您可以从现有的拼图中得到启发。将其注册到文件顶部的相关工具箱类目中。

构建并将拼图运行库复制到Verge3D安装文件夹中。您现在可以在拼图编辑器的工具箱中找到新的拼图了。

遇到问题？

欢迎您随时在论坛上提问！您还可以加入中文用户社区QQ群(171678760)，在线寻求帮助。