d1l4y / PoseKit

poseKit is a Library that uses ARKit and RealityKit to track a body position and return the position in a json. It has more than 4 million different position possibilities
MIT License
38 stars 5 forks source link

Platforms License Swift Package Manager Carthage compatible CocoaPods compatible Travis SwiftFrameworkTemplate

Banner Git

Note: This project is not complete and under development, since it is a project made by students of the Apple Developer Academy in Curitiba, Brazil.

Overview

PoseKit is a Library that uses ARKit and RealityKit to track a body position and return the position in a json. It has more than 4 million of different position possibilities

Summary

Requirements

References

How to Use

Installation

Dependency Managers

CocoaPods [CocoaPods](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command: ```bash $ gem install cocoapods ``` To integrate poseKit into your Xcode project using CocoaPods, specify it in your `Podfile`: ```ruby source 'https://github.com/CocoaPods/Specs.git' platform :ios, '13.0' use_frameworks! pod 'PoseKit', '~> 0.5.0' ``` Then, run the following command: ```bash $ pod install ```
Carthage [Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application. You can install Carthage with [Homebrew](http://brew.sh/) using the following command: ```bash $ brew update $ brew install carthage ``` To integrate poseKit into your Xcode project using Carthage, specify it in your `Cartfile`: ```ogdl github "d1l4y/PoseKit" ~> 0.5.0 ```
Swift Package Manager To use poseKit as a [Swift Package Manager](https://swift.org/package-manager/) package just add the following in your Package.swift file. ``` swift // swift-tools-version:4.2 import PackageDescription let package = Package( name: "HelloposeKit", dependencies: [ .package(url: "https://github.com/d1l4y/PoseKit.git", .upToNextMajor(from: "0.5.0")) ], targets: [ .target( name: "PoseKit", dependencies: [], path: "Sources" ) ] ) ```

Manually

If you prefer not to use either of the aforementioned dependency managers, you can integrate poseKit into your project manually.

Git Submodules

- Open up Terminal, `cd` into your top-level project directory, and run the following command "if" your project is not initialized as a git repository: ```bash $ git init ``` - Add poseKit as a git [submodule](http://git-scm.com/docs/git-submodule) by running the following command: ```bash $ git submodule add https://github.com/d1l4y/PoseKit.git $ git submodule update --init --recursive ``` - Open the new `PoseKit` folder, and drag the `poseKit.xcodeproj` into the Project Navigator of your application's Xcode project. > It should appear nested underneath your application's blue project icon. Whether it is above or below all the other Xcode groups does not matter. - Select the `poseKit.xcodeproj` in the Project Navigator and verify the deployment target matches that of your application target. - Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar. - In the tab bar at the top of that window, open the "General" panel. - Click on the `+` button under the "Embedded Binaries" section. - You will see two different `poseKit.xcodeproj` folders each with two different versions of the `poseKit.framework` nested inside a `Products` folder. > It does not matter which `Products` folder you choose from. - Select the `poseKit.framework`. - And that's it! > The `poseKit.framework` is automagically added as a target dependency, linked framework and embedded framework in a copy files build phase which is all you need to build on the simulator and a device.

Embedded Binaries

- Download the latest release from https://github.com/d1l4y/PoseKit/releases - Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar. - In the tab bar at the top of that window, open the "General" panel. - Click on the `+` button under the "Embedded Binaries" section. - Add the downloaded `poseKit.framework`. - And that's it!

Contributing

Issues and pull requests are welcome! To learn more see Contributor Covenant.

Author

Vinicius Dilay, Isabela Castro, Leonardo Palinkas, Lucas Ronnau, Saulo da Silva

License

poseKit is released under the MIT license. See LICENSE for details.