Alter SDK

Alter SDK is a cross-platform SDK consisting of a real-time 3D avatar system, facial motion capture, and multi-platform components for creating avatars (Avatar Designer). The SDK is built from scratch for web3 interoperability and the open metaverse. Easily pipe avatars into your game, app, or website. It just works. Check out the included code samples to learn how to get started with Alter SDK.

Please star us ⭐ ⭐ ⭐ on GitHub—it motivates us a lot!

📋 Table of Content

• Tech and Avatar Specs
• Motion Capture
• Installation
• License
• Use Cases
• Links

🤓 Tech and Avatar Specs

🚉 Supported Platforms

• iOS 13+
• • TestFlight demo
• Android 8+ (Soon)
• WebGL 2 (Soon)

See alter-core for detailed technical specifications about the rendering and motion capture.

✨ Avatar Formats

• Head only
• A bust with clothing
• A bust with clothing and background (Soon)
• Accessories only (for e.g. AR filters) (Soon)
• Full body (Soon)

🌈 Variability

• Human and non-human
• From toddler to skeleton
• Genders and non-binary
• Full range of diversity

🤪 Motion Capture

• 42 tracked facial expressions via blendshapes
• Eye tracking including eye gaze vector
• Tongue tracking
• Light & fast, just 3MB ML model size
• Simultaneous back and front camera support
• Powered by mocap4face

💿 Installation

Prerequisites

Register in Alter Studio to get a unique key to access avatar data from our servers.

See our example code to see where to put the key. Look for "YOUR-API-KEY-HERE".

iOS

To run the example, simply open the attached Xcode project and run it on your iPhone or iPad.

Do not forget to get your API key at studio.alter.xyz and paste it into the code. Look for "YOUR-API-KEY-HERE".

SwiftPackage Installation

Add this repository as a dependency to your Package.swift or Xcode Project.

Manual iOS Installation

Download the AlterCore.xcframework from this repository and drag&drop it into your Xcode Project.

Android

To run the example, open the android-example project in Android Studio and run it on your Android phone.

Do not forget to get your API key at studio.alter.xyz and paste it into the code. Look for "YOUR-API-KEY-HERE".

Gradle/Maven Installation for Android

Add this repository to your Gradle repositories in build.gradle:

repositories {
    // ...
    maven {
        name = "Alter"
        url = uri("https://facemoji.jfrog.io/artifactory/default-maven-local/")
    }
    // ...
}

// ...
dependencies {
    implementation "alter:alter-core:0.13.0"
}

📄 License

This library is provided under the Alter SDK License Agreement. The sample code in this repository is provided under the Alter Samples License.

🚀 Use Cases

Any app or game experience that uses an avatar as a profile picture or for character animations. The only limit is your imagination.

• Audio-only chat apps
• Next-gen profile pics
• Live avatar experiences
• Snapchat-like lenses
• AR experiences
• VTubing apps
• Live streaming apps
• Face filters
• Personalized stickers
• AR games with facial triggers
• Role-playing games

Known Limitations

This is an alpha release software—we are still ironing out bugs, adding new features and changing the data:

• Item names within an Avatar Matrix can change
• The SDK is still not 100 % thread safe and race conditions or memory leaks can occur rarely
• Documentation is very sparse, make sure to join our Discord or file an issue if you encounter problems

❤️ Links

• Twitter
• Discord
• LinkedIn
• Blog
• Avatar Designer TestFlight
• Learn more...