Unity iOS で Carthage を使う

Unity iOS のネイティブプラグインを書くときに、OSS のライブラリを使いたいときがある。ライブラリのソースを直接 Unity プロジェクトに取り込んでも良いが、どうせなら Carthage のようなパッケージマネージャを使いたい。

概要

Unity からビルドした Xcode プロジェクトで…
- Carthage を使えるようにする
- Swift を使えるようにする
設定はスクリプトで自動的にできるようにする
- UnityEditor.iOS.PBXProject を使って Xcode プロジェクトを設定する
- Build Phases は、RubyGem の xcodeproj を使って設定する

環境

Unity 5.3.4f1
Xcode Version 7.3 (7D175)
Carthage 0.15.2
xcodeproj (1.0.0.beta.4)

基本的なこと

Carthage/Carthage: A simple, decentralized dependency manager for Cocoa

Unity からビルドした Xcode プロジェクトを設定する

Swift を使えるようにする

Xcode プロジェクトで Swift を使うフラグを立てる。

Assets/Editor/SwiftConfigurator.cs

using UnityEditor; using UnityEditor.Callbacks; using UnityEditor.iOS.Xcode; using System.IO; using System.Linq; public class SwiftConfigurator { [PostProcessBuild] static void Configure(BuildTarget buildTarget, string buildPath) { if (buildTarget != BuildTarget.iOS) return; EnableSwift(buildPath); } static void EnableSwift(string buildPath) { var project = new PBXProject(); var path = PBXProject.GetPBXProjectPath(buildPath); project.ReadFromFile(path); var target = project.TargetGuidByName(PBXProject.GetUnityTargetName()); project.SetBuildProperty(target, "EMBEDDED_CONTENT_CONTAINS_SWIFT", "YES"); project.WriteToFile(path); } }

Carthage を使う

通常の Xcode プロジェクトで Carthage を使うときの手順を再現する。

carthage update コマンドを実行する
Carthage がビルドした .framework を Xcode プロジェクトに追加する
フレームワークへのパスを通す
Build Phase に carthage copy-frameworks を設定する

Assets/Editor/CarthageConfigurator.cs

using UnityEngine; using UnityEditor; using UnityEditor.Callbacks; using UnityEditor.iOS.Xcode; using System.Collections.Generic; using System.Diagnostics; using System.IO; using System.Linq; public class CarthageConfigurator { [PostProcessBuild] static void Configure(BuildTarget buildTarget, string buildPath) { if (buildTarget != BuildTarget.iOS) return; RunCarthageUpdate(buildPath); AddCarthageFrameworks(buildPath); AddCopyFrameworksBuildPhase(buildPath); } static void RunCarthageUpdate(string buildPath) { var files = new List<string> { "Cartfile", "Cartfile.resolved" }; foreach (var x in files) { File.Copy(CombinePaths(Application.dataPath, "Editor", "Carthage", x), CombinePaths(buildPath, x), true); } var command = new ProcessStartInfo { WorkingDirectory = buildPath, FileName = "/usr/local/bin/carthage", Arguments = "update --platform iOS", CreateNoWindow = true }; Process process = Process.Start(command); process.WaitForExit(); process.Close(); } static void AddCarthageFrameworks(string buildPath) { var project = new PBXProject(); var path = PBXProject.GetPBXProjectPath(buildPath); project.ReadFromFile(path); var target = project.TargetGuidByName(PBXProject.GetUnityTargetName()); var frameworks = Directory.GetDirectories(CombinePaths(buildPath, "Carthage", "Build", "iOS"), "*.framework"); foreach (var x in frameworks) { var name = Path.GetFileName(x); project.AddFileToBuild(target, project.AddFile("Carthage/Build/iOS/" + name, "Frameworks/" + name, PBXSourceTree.Source)); } project.AddBuildProperty(target, "FRAMEWORK_SEARCH_PATHS", "$(PROJECT_DIR)/Carthage/Build/iOS"); project.SetBuildProperty(target, "LD_RUNPATH_SEARCH_PATHS", "$(inherited) @executable_path/Frameworks"); project.WriteToFile(path); } static void AddCopyFrameworksBuildPhase(string buildPath) { var files = new List<string> { "Gemfile", "carthage_copy_frameworks.rb" }; foreach (var x in files) { File.Copy(CombinePaths(Application.dataPath, "Editor", "Carthage", x), CombinePaths(buildPath, x), true); } var commands = new List<ProcessStartInfo> { new ProcessStartInfo { Arguments = "gem install bundler --no-ri --no-rdoc" }, new ProcessStartInfo { Arguments = "bundle install --path vendor/bundle" }, new ProcessStartInfo { Arguments = "bundle exec ruby carthage_copy_frameworks.rb" } }; foreach (var x in commands) { x.EnvironmentVariables["PATH"] = string.Join(":", new string[] { x.EnvironmentVariables["HOME"] + "/.rbenv/shims", x.EnvironmentVariables["PATH"] }); x.UseShellExecute = false; x.FileName = "/bin/sh"; x.WorkingDirectory = buildPath; x.CreateNoWindow = true; var process = Process.Start(x); process.WaitForExit(); process.Close(); } } private static string CombinePaths(params string[] paths) { return paths.Aggregate(Path.Combine); } }

Assets/Editor/Carthage/Gemfile

Assets/Editor/Carthage/carthage_copy_frameworks.rb

#!/usr/bin/env ruby require 'rubygems' require 'bundler/setup' require 'xcodeproj' proj = Xcodeproj::Project.new('Unity-iPhone.xcodeproj') proj.initialize_from_file proj.targets.each do |target| # Delete if the same run script phase exists target.build_phases.delete_if do |phase| phase.is_a?(Xcodeproj::Project::Object::PBXShellScriptBuildPhase) && phase.name == 'Carthage Copy Frameworks' end # Create a new run script phase run_script = proj.new(Xcodeproj::Project::Object::PBXShellScriptBuildPhase) run_script.name = 'Carthage Copy Frameworks' run_script.shell_script = '/usr/local/bin/carthage copy-frameworks' run_script.input_paths = Dir.glob('Carthage/Build/iOS/*.framework').map do |framework| "$(SRCROOT)/#{framework}" end target.build_phases << run_script end proj.save

手動で .framework をプロジェクトに追加 Drag & Drop するとき、フレームワークがプロジェクトに追加されると同時に、Framework Search Paths が設定されるので、スクリプトで同 Build Setting を設定している。

また、アプリ実行（Run）時に Library が見つからなくてクラッシュする問題を回避するために、 Build Phase に Run Script Phase を追加している。詳しくは Carthage/README.md at master · Carthage/Carthage を参照する。ただし、 UnityEditor.iOS.PBXProject だけでは Build Phase を設定できないので、 CocoaPods/Xcodeproj: Create and modify Xcode projects from Ruby. を使っている。

xcodeproj Gem のバージョンが古いと .pbxproj を XML 形式で上書きされてしまい、UnityEditor.iOS.PBXProject で読み込めなくなるので注意する

さらに、Unity からビルドした Xcode プロジェクトの場合、Runpath Search Paths も設定する必要があった。 Linker Error : Library not found · Issue #615 · Carthage/Carthage を見る限り、古い Xcode で作ったプロジェクトだと同問題が発生するらしい。

これで、Xcode プロジェクトをビルドする度に、自動で設定が行われる

OSS のライブラリを使ってみる

試しに questbeat/QBImagePicker: A clone of UIImagePickerController with multiple selection support. を使ってみる。いつもの iOS 開発のときと同じように Cartfile を書く。

Assets/Editor/Carthage/Cartfile

プラグインのコードでも、いつもの iOS 開発のときと同じように、Framework を #import して使う。 QBImagePicker が Objective-C で書かれているので、Swift を使っていない。

Assets/Plugins/iOS/DDDImagePicker/DDDImagePickerPlugin.mm

// // DDDImagePickerPlugin.mm // Unity-iPhone // // Created by dddnuts on 4/29/16. // // #import <Foundation/Foundation.h> #import <QBImagePicker/QBImagePicker.h> @interface DDDImagePickerDelegate : NSObject<QBImagePickerControllerDelegate> +(instancetype)sharedInstance; @end @implementation DDDImagePickerDelegate +(instancetype)sharedInstance { static DDDImagePickerDelegate *instance; static dispatch_once_t onceToken; dispatch_once(&onceToken, ^{ instance = [DDDImagePickerDelegate new]; }); return instance; } -(void)qb_imagePickerControllerDidCancel:(QBImagePickerController *)imagePickerController { UIViewController *unityViewController = UnityGetGLViewController(); [unityViewController dismissViewControllerAnimated:YES completion:nil]; // TODO: Send message to Unity. } -(void)qb_imagePickerController:(QBImagePickerController *)imagePickerController didFinishPickingAssets:(NSArray *)assets { UIViewController *unityViewController = UnityGetGLViewController(); [unityViewController dismissViewControllerAnimated:YES completion:nil]; // TODO: Send message with selected images to Unity. } @end extern "C" { void DDDImagePicker_Open() { QBImagePickerController *picker = [QBImagePickerController new]; picker.allowsMultipleSelection = YES; picker.maximumNumberOfSelection = 2; picker.showsNumberOfSelectedAssets = YES; picker.delegate = [DDDImagePickerDelegate sharedInstance]; UIViewController *unityViewController = UnityGetGLViewController(); [unityViewController presentViewController:picker animated:YES completion:nil]; } }

Swift を使ったネイティブプラグインは、また別のポストで書いてみる。ただし、Unity から叩くエントリポイントは C で書くので、Objective-C++ から一部 Swift を呼び出すという感じになるはず。

まとめ・感想

Unity からビルドした Xcode プロジェクトで、Carthage を使えるようにした
- ついでに Swift も使えるようにした
- Swift の検証は、また別のポストで行う予定
Xcode の設定はスクリプトで行い、Xcode プロジェクトビルドの度に自動で実行できるようにした
- Build Settings は UnityEditor.iOS.PBXProject を使って設定した
- Build Phases は、UnityEditor.iOS.PBXProject では設定できなかったので、RubyGem の xcodeproj を使って設定した

軽い興味で始めてみたら、結構大変だった。 UnityEditor.iOS.PBXProject で Embedded Binaries か Build Phases が設定できるようになると Gem 依存がなくなって嬉しいので応援している。

概要

環境