开发入门

使用前提

EasyAR插件基于微信小程序及其3D引擎 xr-frame 运行,请在使用前确保 您已熟悉3D引擎基本知识和小程序本身的开发流程

如果您对于微信小程序的基本开发流程还不了解,请先查看 微信小程序开发文档

如果您对微信小程序的3D引擎 xr-frame 还不了解,请先查看 微信小程序xr-frame文档

申请EasyAR Mega 小程序许可证

初次开发时,先在开发中心内申请测试版本小程序许可证,有效期30天。

测试版许可证有水印,不可用于商用。

正式上线前需升级到专业版,升级不会变更license key。

../../_images/01.png

输入你的小程序名称和APPID

../../_images/02.png

获取微信小程序许可证 License Key

../../_images/03.png ../../_images/04.png

创建Mega云定位服务API KEY

在开发中心内选择云服务API KEY,并创建API KEY

../../_images/114.png

输入应用名称,选中Mega云服务选项

../../_images/122.png

获取你的API Key和API Secret

../../_images/134.png

获取Mega云定位服务配置信息

详细 * 配置定位服务

../../_images/143.png ../../_images/153.png ../../_images/162.png

标注数据生成

为什么需要标注数据,请了解下Mega 产品体系

微信小程序上开发Mega应用流程如下图:

https://help.easyar.cn/EasyAR%20Mega/_images/image_s1_18.png
  1. 建图Block,请查看文档

  2. Mega Studio工具使用,标注数据及内容摆放,请查看文档

  3. 小程序开发,开发前建议先运行sample

获取标注数据(ar annotation id)

标注数据需要通过Unity来创建,* 标注并在现场验证 Mega 效果

../../_images/182.png

下载 sample

登录到开发中心(www.easyar.cn),点击右上角“EasyAR 开发工具下载”,在弹出的窗口中选择“EasyARMega-WxMini-demo-v*.zip”下载。

../../_images/193.png

导入到微信开发者工具

../../_images/311.png

选择下载的sample,并选择一个AppId。

../../_images/32.png

配置工程

在工程app.json中配置plugins和lazyCodeLoading设置。

../../_images/cfg2.png

配置Mega定位服务

配置Mega服务必要信息及license key(miniprogram/components/data/mega-config.js)

../../_images/cfg.png

手机等移动设备上运行:不在现场(不建议)

设置enable-remote-debug = true,如:

<xr-easyar-session enable-remote-debug="{{true}}" ... ></xr-easyar-session>

如果不在现场,又想在手机等移动设备上快速做些验证(比如与跟踪效果不相关的流程开发),可以使用这种方式。

需要注意的是,对着视频或图片运行看到的效果与实际效果完全无关,请勿以对着视频或图片看到的效果进行判断。

点击“预览”在手机上体验,不要使用真机调试

xr-frame需依赖真机测试,非真机测试下问题不容易暴露,开发中请尽量用真机进行测试。

../../_images/511.png

开发调试

在开发过程中,建议打开调试功能,打开方法如下图, 点击 打开调试 小程序会退出,重新打开即可 。

../../_images/debug1.png ../../_images/debug2.png

微信3D引擎学习

Mega微信小程序插件需基于xr-frame开发使用 请详细阅读,xr-frame官方文档 https://developers.weixin.qq.com/miniprogram/dev/component/xr-frame/overview/

EasyAR Mega小程序Toolbox验证工具

../../_images/tb.jpg

无需开发,就能快速验证您的场景定位效果,使用方法请参考 Mega Toolbox

设备支持

Mega需要运动跟踪的能力,在微信小程序里面,这个能力由微信的VisionKit提供,系统要求和手机支持列表请参考 微信 VisionKit 内文档 的说明。 一般来说,需要支持V2平面AR接口的手机才能较好的支持Mega,只支持V1的手机效果会有大幅影响。


微信已知问题

说明:以下问题均已向微信官方反馈,在等待微信修复。如微信官方已修复而该文档未及时更新,请联系我们进行修改。

多次进入AR界面,微信闪退或提示内存不足

真机环境下微信小程序的xr-frame存在一定程度的内存泄露。该泄漏出现在小程序内切换页面的时候,关闭小程序会释放。

视频内容随机显示不出来

微信的视频纹理功能尚处于beta阶段,会随机出现播放失败的情况,Android及iOS手机上均有问题,微信暂未提供接口获取视频播放信息。

使用时有轻微卡顿(默认情况约为1s一次)

该问题由EasyAR与微信对接部分的一些数据路径有关,该路径目前性能仍需提升。理论上该提升会非常显著,但仍需等待微信支持。