Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rsrbk/SmileToUnlock
This library uses ARKit Face Tracking in order to catch user's smile.
https://github.com/rsrbk/SmileToUnlock
Last synced: about 1 month ago
JSON representation
This library uses ARKit Face Tracking in order to catch user's smile.
- Host: GitHub
- URL: https://github.com/rsrbk/SmileToUnlock
- Owner: rsrbk
- License: mit
- Created: 2017-12-02T16:51:17.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-08-28T01:52:05.000Z (about 4 years ago)
- Last Synced: 2024-07-25T14:24:59.233Z (about 2 months ago)
- Language: Swift
- Homepage:
- Size: 16.6 MB
- Stars: 627
- Watchers: 18
- Forks: 37
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-ios - SmileToUnlock - This library uses ARKit Face Tracking in order to catch a user's smile. (ARKit)
- awesome-ios-star - SmileToUnlock - This library uses ARKit Face Tracking in order to catch a user's smile. (ARKit)
README
# SmileToUnlock
[](https://cocoapods.org/pods/SmileToUnlock) [](https://github.com/apple/swift-package-manager)
Make your users smile before opening the app :)
Gif with the demonstration
## Installation
### Cocoapods
The most preferable way to use this library is cocoapods. Add the following line to your `Podfile`:
```sh
pod 'SmileToUnlock'
```
and run `pod install` in your terminal.
### Swift Package Manager
Add the following as a dependency to your `Package.swift:
```swift
.package(url: "https://github.com/rsrbk/SmileToUnlock.git", from: "1.0.3")
```
and then specify `"SmileToUnlock"` as a dependency of the Target in which you wish to use SmileToUnlock. Here's an example:
```swift
let package = Package(
name: "Example",
dependencies: [
.package(url: "https://github.com/rsrbk/SmileToUnlock.git", from: "1.0.3")
],
targets: [
.target(name: "Example", dependencies: ["SmileToUnlock"])
]
)
```
### Manually
Add the files in the `SmileToUnlock` directory to your project.
## Usage
First of all, you have to add NSCameraUsageDescription to you Info.plist with a brief explanation.
Then you need to check if a user's device has the face tracking support:
```swift
if SmileToUnlock.isSupported {
}
```
Keep in mind that only iPhone X and older (a real device, not even a stimulator!) have this support currently.
Then just create an instance of the SmileToUnlock and specify the success handler:
```swift
if SmileToUnlock.isSupported {
let vc = SmileToUnlock()
vc.onSuccess = {
let storyboard = UIStoryboard(name: "Main", bundle: nil)
let vc = storyboard.instantiateInitialViewController()!
self.window?.rootViewController = vc
}
window?.rootViewController = vc
}
```
If you want SmileToUnlock to be presented on your app's launch, add the code above to your didFinishLaunchingWithOptions method in AppDelegate.
Few additional customization properties:
```swift
public var titleText: String? = "Hello,"
public var subtitleText: String? = "Begin using our app from the smile"
public var skipButtonText: String? = "Skip this"
/// Sound to play after a user has smiled. Set to nil if you don't want a sound to be played.
public var successSoundPlaying: (() -> Void)? = {
AudioServicesPlaySystemSound(1075)
}
/// Set how much smile do you need from a user. 0.8 is kind of hard already!
public var successTreshold: CGFloat = 0.7
/// Background color for this view controller.
public var backgroundColor: SmileToUnlockBackground = .blue
```
There are 3 preinstalled background colors. You can set your custom one as well:
```swift
public enum SmileToUnlockBackground {
case blue
case red
case purple
case other(UIColor)
}
```
## Feature requests
If you wish to contribute, look at this topics:
- Improving the face itself (maybe some 3D model)
- Adding additional emotions (like eye blinking)
- Improving the UI of the screen
## Follow me on twitter
I promise it's gonna be more interesting stuff there! [@rsrbk123](https://twitter.com/rsrbk123)
## Check out my other libraries
[SRCountdownTimer](https://github.com/rsrbk/SRCountdownTimer) - a simple circle countdown with a configurable timer.
[SRAttractionsMap](https://github.com/rsrbk/SRAttractionsMap) - the map with attractions on which you can click and see the full description.
## License
MIT License
Copyright (c) 2017 Ruslan Serebriakov
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.