MeiShe Face Sticker Design Plugin AR Scene Editor Instruction

MeiShe Face Sticker Design Plugin

AR Scene Editor Instruction

Version 1.4.0

Beijing Meishe Network Technology Co., Ltd.

Contents

 

1、Overview.. 4

2、Environment. 4

3、Description. 4

4、Model Creation Specification. 5

4.1、      Model Creation Specification. 5

4.2、Sticker Creation Specification. 7

4.3、Export FBX. 8

5、Installation and Project Creation. 9

5.1、Installation of plugin. 9

5.2、AR Scene Generation. 10

6、Unity 3D Sticker Creation Specification. 12

6.1、Unity Model Creation Specification. 12

6.2、Unity Material Creation Specification. 14

6.3、Unity Lighting Creation Specification. 17

6.4、Unity Animation Creation Specification. 18

7、Unity Physical System Creation Specification. 21

7.1、Ensure the Hierarchy. 21

7.2、Load Bone Physics. 22

7.3、Preview.. 23

7.4、Plugin Tune. 24

8、Unity 2D Sticker Creation Specification. 25

8.1、Static 2D Sticker Generation. 25

8.2、2D Image Series Sticker Generation. 26

9、Event Trigger. 28

9.1、Trigger Condition. 29

9.2、Trigger object switch. 30

9.3、Action trigger example. 31

9.4、Time trigger example. 33

10、Fake Face function. 34

10.1、Fake Faceparameter. 34

10.2、Example. 35

11、AR Scene Generation. 36

11.1、AR Scene Package Generation. 36

11.2、Test in Mobile Device. 38

 

Version	Description	Authors
1.1.0-1	Doc Creation	Liu Chong, Fan Chenchen
1.3.0-1	Doc Upgrading, Features envent and fakeface are added.	Zang Junqing, Zhang Siming
1.4.0-1	Doc Upgradin, and the problem that the packaged .Arscene file cannot be uploaded has been modified	Zang Junqing
1.4.0-1	The document is updated, adding a combination with 2D foreground and 2D trigger.	Fan Chenchen

 

1、Overview

MeiShe SDK provides face sticker rendering engine, which helps users to add various face stikcers during capture. For users to design more personalized stickers, we have developed a helper plugin called AR Scene Editor. This document is to guide users to the correct use of the plugin and how to complete the design work.

2、Environment

Hardware：Windows PC / MAC

Software：Unity 5.6.3 or above，the following instruction is based on Unity 5.6.3

Notes

MeiShe SDK only provides the design plugin. For Unity, we suggest users purchase the legitimate software for use. Meishe Network Technology Co., Ltd.  will not be responsible for any problems or losses arising from the use of pirated Unity software.

3、Description

AR Scene Editor can only produce the face sticker packages applicable to the SDK. This plugin provides a whole set of AR Scene file making scheme for the SDK, realizing the visualization of model, material, lighting, animation and physical system effects. The tool is currently in the process of being perfected, and the types of stickers that can be made include

 

A. 2D face sticker

B. 3D face sticker

1. Stickers with physical system support
2. 3D trigger animation (new in 1.3.0).
3. Handwritten scripts realize the combination of foreground filters.

4、Model Creation Specification

Users can use MAYA,3Ds MAX, etc. as the 3D model design tool. We provide the standard face model (meishe_reference_head.fbx), All designs should be based on the standard face model, so that the designed stickers could accurately match the real human face and that the occlusion relation is right.

 

Notes

All specification referenced in this doc should be combination of letter, number and underline. Chinese characters are not allowed. All path referenced in this doc should be combination of letter, number and underline. Chinese characters are not allowed.

1. 1. Model Creation Specification

A.Users use the standard face model (meishe_reference_head.fbx) to create face sticker.

 

Notes:

1	Number of facets should be within 2W.
2	Model history should be removed and transform should be zero.
3	In Meishe SDK, the opposite side of normal direction could not be displayed, models should be sealed. If necessary, AR Scene supports double side display, but this function has not been integrated into the AR Scene plugin in version 1.1.0. And double side display could lower the efficiency of the SDK.

 

B.The models in the outline will be rendered from top to bottom, which needs to be structured according to the spatial context. Otherwise it will not display correctly when using transparent sticker, etc.

C. Use the common method to bind the model，functions like IK, restriction can`t be use on bone.

D. All models and bones can be put into one main group, if the main group does not exist, unity will automatically generate one which has the same name as the FBX.

 

Notes

Models and bones cannot have duplicate names, and the SDK cannot recognize duplicate names.

4.2、Sticker Creation Specification

A. stickers in JPG, PNG, JPG/PNG series（caf）are supported，transparent stickers are created in PNG or caf.

 

B. MeiShe SDK supports stickers in any aspect ratio, however ratio in 2ⁿ is suggested. And it should not exceed 2048x2048.

 

Notes

1	After sticker is applied to the model in 3D software, attribute Diffuse Color will not work at all, it won`t be read by the MeiShe SDK.
2	caf is the SDK`s internal format for image series, which can`t be read by other 3D software. After converting image series to caf, a companion image is generated automatically, which is used as the delegate of the caf in unity. When generating the sticker package, the delegate is then replaced by the real caf. For more information of caf creation, please refer to 8.2 2D Image Series Generation.

4.3、Export FBX

1. FBX of version 2013 is demanded.

 

1. Option embed media should be disabled, otherwise it might cause errors.

 

1. If the skeleton has its own animation, it needs to be baked frame by frame when exporting, the SDK will play the animation in a loop.