Avatar SDK  2.0.0
Realistic avatar generation toolset for Unity3D
Main Page

ITSEEZ3D AVATAR SDK PLUGIN

Meet the Avatar SDK: robust AI-powered 3D avatar creation engine!

Useful links:

"Cloud SDK" vs "Offline SDK"

The Avatar SDK for Unity is delivered in two flavors: Cloud SDK and Offline SDK

  • Cloud SDK uses an external server to generate the 3D avatars. It is available to everyone, please check the pricing at avatarsdk.com
  • Offline SDK can calculate avatars directly on the client machine. Please fill the form at this link (https://avatarsdk.com/#contact-us) to get access to the Offline SDK.

We split Cloud SDK and Offline SDK to different packages starting from the 2.0.0 version. After that new versions of products and their updates will be delivered independently.

Getting Started

  • First of all, follow Getting Started instructions on the website (https://accounts.avatarsdk.com/developer/#unity-plugin) and in the auth window to set up the authentication, if you haven't done so yet.
  • Find getting started scene in itseez3d/avatar_sdk/samples_cloud/. You can either generate 3D avatar from a predefined photo or upload your photo. Make sure that shortly after you pressed "Generate Avatar" button the 3D avatar appears in a scene.
  • Find more advanced gallery scene in the same folders. This sample shows more complex API usage scenarios. Make sure it works for you.
  • Check out other samples in the Cloud SDK folder. Press on "Scene documentation" buttons to see detailed instructions for a particular scene.
  • Start creating your app by modifying one of the samples or starting from scratch. Good luck!
  • Note: if you need to adjust the behaviour of API functions to your liking we encourage you to create your implementations in a separate class/file, using composition or inheritance. If you modify the plugin files directly you will have trouble upgrading to the new versions later. If you find it impossible to proceed without directly modifying the plugin code (e.g. you found a bug) please let us know - we will try to fix this in the next version.

FAQ

This section will be updated in each version. Last updated: 2.0.0

Does it work on mobile platforms?

Cloud SDK version is lightweight and works on all devices, even in WebGL.

How can I attach your 3D head to the body?

In version 1.3.0 we added a full-body sample and you can find it in itseez3d/avatar_sdk/samples_* Please note that it's just an example of how this can be done in the real app, and the low resolution character provided is just a placeholder, you should replace it with your own body models. This method works for any humanoid rig, but of course, you will have the seam between the neck and the rest of the body, which should be covered with some kind of collar. If you have questions about this feature or you need more advanced functionality (like the seamless attachment to your bodies with texture blending), please contact us at suppo.nosp@m.rt@i.nosp@m.tseez.nosp@m.3d.c.nosp@m.om For now, you're encouraged to take apart this sample to see how it works. See the detailed instruction on the scene documentation page.

Why my models have a watermark on the forehead?

This is a feature of the Free Cloud SDK. Please update to the paid plan to get rid of it.

Is avatar generation limited?

Please check the pricing on our website

Does it work in runtime?

Yes, the plugin works in runtime. Any player of your game can generate his avatar.

How many triangles do the avatars have?

9 LODs supported ranging from ~3K to ~24K triangles per avatar for the Face pipeline. 8 LODs supported ranging from ~5K to ~50K triangles per avatar for the Head pipeline.

Can I display avatars of the different user in my app?

Yes, you can query any generated avatar if you know the avatar code. Take a look at the samples and the functions in Connection.cs

How do I get more haircuts or blendshapes?

Please see the scene documentation for parameters_sample scene here.

How can I generate cartoonish avatars?

The users with the "Indie" subscription type or above can generate cartoonish avatars. See the "06_cartoonish_avatar_sample_cloud" sample that demonstrates how this can be done.

What recommendations can I give my users in terms of input photos?

The SDK is pretty robust, but these recommendations will improve the quality (in priority order): Our recommendations:

  • The face should be easily recognizable on the photo. The photo is not blurry.
  • Only for Face pipeline: ask the user to remove hair from the forehead and from the sides of the face, otherwise, hair may appear on the face texture.
  • Uniform good lighting on the photo, without dark shadows or too bright glare
  • A person should keep a neutral facial expression or slightly smile but without opening their mouth. If teeth are visible on the input photo the lip texture might be incorrect.
  • It's best to look straight into the camera without turning your neck or eyes. This way Head pipeline can generate good looking shoulders.
  • We advise removing the glasses because they're reconstructed only in the texture, not 3D mesh. But this is not completely necessary.

How to upgrade to a new version of Avatar SDK

Unfortunately, Unity does not provide a consistent mechanism for plugin upgrades, so the most failproof method is to delete the avatar_sdk folder from your project entirely and re-import the entire plugin. If you have changes in SDK source files (this is not recommended and you should try to avoid this, but sometimes it's inevitable), then you can use diff tool like Meld to manually merge your changes to the new version of the plugin.

After upgrading it's highly recommended to re-enter your authentication credentials in Window->itSeez3D Avatar SDK->Authentication and press Save Credentials ...

Support

Any questions about the plugin or the avatar generation, general feedback, bugs, ideas, feature requests: suppo.nosp@m.rt@a.nosp@m.vatar.nosp@m.sdk..nosp@m.com For commercial inquiries or licensing questions use busin.nosp@m.ess_.nosp@m.suppo.nosp@m.rt@i.nosp@m.tseez.nosp@m.3d.c.nosp@m.om or suppo.nosp@m.rt@a.nosp@m.vatar.nosp@m.sdk..nosp@m.com