https://github.com/efremidze/animoji

Animoji Generator 🦊
https://github.com/efremidze/animoji

animation animoji apple avatar avatarkit carthage cocoapods emoji ios objective-c private-api swift

Last synced: 1 day ago
JSON representation

Animoji Generator 🦊

• Host: GitHub
• URL: https://github.com/efremidze/animoji
• Owner: efremidze
• License: mit
• Created: 2017-11-10T00:20:57.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-11-20T08:17:42.000Z (12 months ago)
• Last Synced: 2024-04-14T09:58:16.805Z (7 months ago)
• Topics: animation, animoji, apple, avatar, avatarkit, carthage, cocoapods, emoji, ios, objective-c, private-api, swift
• Language: Swift
• Homepage:
• Size: 8.58 MB
• Stars: 375
• Watchers: 13
• Forks: 42
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
![Animoji](https://raw.githubusercontent.com/efremidze/Animoji/master/Images/logo.png)

[![Build Status](https://travis-ci.org/efremidze/Animoji.svg?branch=master)](https://travis-ci.org/efremidze/Animoji)

[![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

[![Language](https://img.shields.io/badge/Swift-5-orange.svg?style=flat)](https://swift.org)

[![Version](https://img.shields.io/cocoapods/v/Animoji.svg?style=flat)](http://cocoapods.org/pods/Animoji)

[![License](https://img.shields.io/cocoapods/l/Animoji.svg?style=flat)](http://cocoapods.org/pods/Animoji)

[![Platform](https://img.shields.io/cocoapods/p/Animoji.svg?style=flat)](http://cocoapods.org/pods/Animoji)

**Animoji** is an iOS library that gives access to the private framework AvatarKit to generate Animoji, just like the Messages app.

*Supports iOS 12.2 Animoji (Boar, Giraffe, Owl, Shark)!*

**Animoji uses iPhone X and iOS 11.1 features so no Simulator support yet.**



```

$ pod try Animoji

```

## Requirements

- iOS 11.1+

- Xcode 9.1+

- Swift 5 (Animoji 1.x), Swift 4 (Animoji 0.x)

## Usage

You can initialize an _Animoji_ like a UIView. _Animoji_ is a `SCNView` so if your using a storyboard/xib use a SceneKit View.

```swift

import Animoji

let animoji = Animoji(frame: self.view.bounds)

animoji.setPuppet(name: .cat)

view.addSubview(animoji)

```

## Installation

Animoji is available via CocoaPods and Carthage.

### CocoaPods

To install with [CocoaPods](http://cocoapods.org/), simply add this in your `Podfile`:

```ruby

use_frameworks!

pod "Animoji"

```

### Carthage

To install with [Carthage](https://github.com/Carthage/Carthage), simply add this in your `Cartfile`:

```ruby

github "efremidze/Animoji"

```

## Privacy Settings

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

* NSPhotoLibraryAddUsageDescription

* NSMicrophoneUsageDescription

* NSCameraUsageDescription

## Disclaimer

Animoji utilizes Apple's private API to do its magic. Use caution, submitting this code to the App Store adds the risk of being rejected!

## Communication

- If you **found a bug**, open an issue.

- If you **have a feature request**, open an issue.

- If you **want to contribute**, submit a pull request.

## Apps Using _Animoji_

Feel free to submit a PR if you’re using this library in your apps.

- [AnimojiChat](https://github.com/dotEngine/animoji-chat) -- Animoji + video chat  

## License

Animoji is available under the MIT license. See the LICENSE file for more info.