SLAvatarKit

SLAvatarKit is a powerful and flexible library for creating expressive and dynamic avatars, including memojis and animojis. It serves as a compelling alternative to Apple's private AvatarKit, allowing developers to integrate customizable avatar features seamlessly into their iOS applications.

Note

AvatarKit is currently in development and not yet ready for production use. You are welcome to test the latest alpha/dev build at your own risk. We welcome feedback here.

The AvatarExplorer sample project is associated with SLAvatarKit. Check it out here: SwiftUI | Obj-C

Features

• Memoji and Animoji Support: Design and animate personalized memojis and animojis to enhance user engagement.

• Flexible Customization: Tailor avatars to suit your app's unique style with a range of customizable features, including facial expressions, accessories, and more.

• Real-time Animation: Bring avatars to life with real-time animation capabilities, providing a captivating user experience.

• Easy Integration: Simple and intuitive API for seamless integration into your iOS projects.

🖥️ Installation

Requirements

• iOS 17.1+
• Xcode 15.2+
• Swift 5.9 (SLAvatarKit 1.x.x) (legacy support later)

Install

Swift Package Manager (recommended)

You can install SLAvatarKit into your Xcode project via SPM. To learn more about SPM, click here

1. In Xcode 12, open your project and navigate to File → Swift Packages → Add Package Dependency...

For Xcode 13, navigate to Files → Add Package

1. Paste the repository URL (https://github.com/ScribbleLabApp/AvatarKit.git) and click Next.
2. For Version, verify it's Up to next major.
3. Click Next and select the (You don't need to add SLAvatarKitUI or SLAvatarKitCore)
4. Click Finish
5. You are all set, thank you for using SLAvatarKit!

You can also add it to the dependencies of your Package.swift file:

dependencies: [
  .package(url: "https://github.com/ScribbleLabApp/AvatarKit", .upToNextMajor(from: "1.0.0"))
]

CocoaPods (Deprecated)

To install with CocoaPods, simply add this in your Podfile:

platform :ios, '17.0'

target 'test abstract' do
  use_frameworks!
  pod 'SLAvatarKit'

end

Carthage (Deprecated)

To install with Carthage, simply add this in your Cartfile:

github "ScribbleLabApp/SLAvatarKit"

🚀 Quickstart

Before you start, please star ⭐️ this repository. Your star is our biggest motivation to pull all-nighters and maintain this open-source project. If you like the idea behind this project, please share it with your friends, colleagues, or anyone who might find it valuable.

🛠️ Usage

Privacy Settings

You must provide a description for how your app uses the following privacy settings in your app's Info.plist file. Add those keys to your Info.plist file:

<key>NSPhotoLibraryAddUsageDescription</key>
<string>We need access to your PhotoLibary to store and save your created avatar.</string>
<key>NSCameraUsageDescription</key>
<string>We need to access your camera to create unique Animojis for you.</string>

📖 Cheatsheet

Modifiers

Parameters

Views

🧰 Supported Avatar types

💪 Contribute

Contributions are welcome here for coders and non-coders alike. No matter what your skill level is, you can for certain contribute to SLAvatarKit's open source community. Please read Contributing.md and the step-by-setp guide before starting.

If you encounter ANY issue, have ANY concerns, or ANY comments, please do NOT hesitate to let us know. Open a discussion, issue, or email us. As a developer, we feel you when you don't understand something in the codebase. We try to comment and document as best as we can, but if you happen to encounter any issues, we will be happy to assist in any way we can.

Contributors

We would like to express our gratitude to all the individuals who have already contributed to AvatarKit! If you have any AvatarKit-related project, documentation, tool or template, please feel free to contribute it by submitting a pull request to our curated list on GitHub.

Support Us

Your support is valuable to us and helps us dedicate more time to enhancing and maintaining this repository. Here's how you can contribute:

⭐️ Leave a Star: If you find this repository useful or interesting, please consider leaving a star on GitHub. Your stars help us gain visibility and encourage others in the community to discover and benefit from this work.

📲 Share with Friends: If you like the idea behind this project, please share it with your friends, colleagues, or anyone who might find it valuable.