|
| 1 | +<p> |
| 2 | + <img src="https://img.shields.io/badge/version-0.7.0-blue.svg?style=flat-square" /> |
| 3 | + <a href="https://github.com/handsomecode/UnityBuildKit/blob/master/LICENSE"> |
| 4 | + <img src="https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square"/> |
| 5 | + </a> |
| 6 | +</p> |
| 7 | + |
1 | 8 | # UnityBuildKit |
2 | 9 |
|
3 | | -A description of this package. |
| 10 | +UnityBuildKit is a command line tool that generates an iOS application with an embedded Unity scene. |
| 11 | + |
| 12 | +## Installation |
| 13 | +`UnityBuildKit` requires Xcode 9 and Swift 4 |
| 14 | + |
| 15 | +### Make |
| 16 | +``` |
| 17 | +git clone https://github.com/handsomecode/UnityBuildKit |
| 18 | +cd UnityBuildKit |
| 19 | +make |
| 20 | +``` |
| 21 | + |
| 22 | +### Swift Package Manager |
| 23 | +#### Use as a dependency |
| 24 | +``` |
| 25 | +.package(url: "https://github.com/handsomecode/UnityBuildKit", from: "1.0.0"), |
| 26 | +``` |
| 27 | + |
| 28 | +## Usage |
| 29 | +### To generate a new project |
| 30 | +1. Create a top-level folder and navigate to it. This folder will contain all information about the Xcode and Unity projects. (_Note: By default, the name of this folder will be the name of the Xcode and Unity projects._) |
| 31 | +``` |
| 32 | +mkdir ExampleProject |
| 33 | +cd ExampleProject |
| 34 | +``` |
| 35 | + |
| 36 | +2. Create a configuration file named `ubconfig.json` |
| 37 | + |
| 38 | +``` |
| 39 | +{ |
| 40 | + "project_name": "", // Leaving this empty uses folder name by default |
| 41 | + "bundle_id": "is.handsome.UnityBuildKit", |
| 42 | + "unity_path": "<path_to_unity_app>", // "/Applications/Unity/Unity.app/Contents/MacOS/Unity" |
| 43 | + "unity_version": "2017.1.1f1", |
| 44 | + "unity_scene_name": "" // Leaving this empty uses folder name by default |
| 45 | +} |
| 46 | +``` |
| 47 | + |
| 48 | +3. Run |
| 49 | +``` |
| 50 | +$ UnityBuildKit generate |
| 51 | +``` |
| 52 | + |
| 53 | +## Known Unity Version Compatibility |
| 54 | +- 2107.1.f1 |
| 55 | + |
| 56 | +## Attributions |
| 57 | +This tool is built using: |
| 58 | +- [XcodeGen](https://github.com/yonaskolb/XcodeGen) |
| 59 | +- [xcproj](https://github.com/xcodeswift/xcproj) |
| 60 | + |
| 61 | +and the wonderful dependencies they bring with them. |
| 62 | + |
| 63 | +Inspiration for building `UnityBuildKit` came after running into several problems while trying to [manually do this process](https://the-nerd.be/2015/11/13/integrate-unity-5-in-a-native-ios-app-with-xcode-7/) and reading over a [github issue](https://github.com/blitzagency/ios-unity5/issues/52) trying to resolve those problems. |
| 64 | + |
| 65 | +## License |
| 66 | + |
| 67 | +UnityBuildKit is licensed under the MIT license. See LICENSE for more info. |
0 commit comments