読者です 読者をやめる 読者になる 読者になる

【Unity】AssetBundleの概要

unity UnityAdventCalendar2016

AssetBundleの概要

はじめに

こんにちは、Unityエンジニアの清水です。
この記事はカヤックUnityアドベントカレンダー2016の23日目の記事になります。

今日はAssetBundleの概要についてお送りします。

AssetBundleとは

AssetBundleは複数のアセットを1つのファイルとして書き出したもので、ランタイムで内部のアセットを読み込むことができます。
主に、追加コンテンツの配信のために使われます。
公式ドキュメント

導入目的

前項の通り、AssetBundleを使うことでアプリのバージョンアップなしでアセットを追加、更新できます。
キャラクターやアイテムなど、運用を続けていると自然と増えていきますが、その度にアプリのバージョンアップが必要になると運用がだいぶ難しくなります。
そこで、そのようなアセットはAssetBundleから読み込むように作っておくことで、コンテンツ追加を柔軟に行うことができます。

もう1つのAssetBundle導入目的として、アプリ本体の容量を減らすということがあります。
App Store や Google Play ストアではwifiを使わずキャリア回線でアプリをダウンロードできるサイズに制限があります。
そのサイズ(2016年12月時点では100MB)内に収めるため、容量の大きいアセットをAssetBundleにしてアプリ起動後にダウンロードさせます。

AssetBundleは一度ダウンロードさせたら端末のディスク上にキャッシュしておき、そのAssetBundleが更新されるまでは再ダウンロードさせないのが一般的です。

対象のアセット

ほとんどのアセットはAssetBundle化可能です。
その中でも、更新頻度やアプリサイズへの影響的に、バナーやアイテム画像などのテクスチャ類をAssetBundleで配信することが多いです。
他にサウンドやprefabなどもよくAssetBundle化されます。
ただし、iOSのAOTのため、スクリプトはAssetBundleに含めることができません。
スクリプト本体を含めることはできませんが、prefabやシーンに含まれるMonoBehaviourやScriptableObjectに関しては、アプリ本体にもそのスクリプトが含まれていれば使用可能です。

プロジェクトへの導入フロー

プロジェクトにAssetBundleを導入する際の手順を追いつつ、各段階での注意点などを解説します。

1. ビルド、配信、ロード、バージョン管理、運用方法などの検討、設計を行う

AssetBundleをビルドしたりロードしたりするAPIは用意されていますが、実際にプロジェクトで使うには仕組みを整えたりルールを決めたりする必要があります。
できるだけ自動化して、AssetBundleの追加や更新にかかるコストを減らすことが重要です。
Unity5.3以降を使っているなら、AssetBundleの圧縮形式はファイルサイズとロード時間のバランスが良い LZ4 がオススメです。

2. ビルドスクリプトの実装

AssetBundleを出力するためのスクリプトを用意します。
Unity5から、インスペクタでAssetBundle名を設定して BuildPipeline.BuildAssetBundles を実行すれば簡単にビルドできるようになりました。
f:id:shimiu:20161221110829p:plain
ビルド対象をコードから指定することも引き続き可能です。

AssetBundleにすることが最も多いであろうテクスチャはエンジニア以外が用意することが多いので、あまりUnity上で操作しなくても追加できるようにしておくと良いでしょう。
例えば、特定のディレクトリに配置するだけで良いようにしておくと、デザイナーだけで作業が完結できるかもしれません。

また、アプリ本体のプロジェクトとは別にAssetBundleビルド用のプロジェクトを用意することが多いです。
プロジェクト内に大量のアセットの存在するとインポート時間が長くなり、作業に影響が出てくるためです。

3. ロードやアンロードを管理するスクリプトの実装

ランタイム側で使用するスクリプトを用意します。
複数箇所から同じAssetBundleへのアクセスがあった場合の制御、解放タイミング、キャッシュからの取得などを管理する必要があります。
キャッシュに関しては WWW.LoadFromCacheOrDownload を使用すればバージョンの制御くらいで済みます。
ただ、この方法ではキャッシュ削除のタイミングが制御しづらかったり、複数のAssetBundleを並行でロードする場合のパフォーマンスが出なかったりするので、自前で実装する場合もあります。

ここまでが初回導入時に必要になる手順で、以降はAssetBundleの追加の度に発生する手順になります。

4. アセットを用意してAssetBundleをビルドする

2で用意した仕組みを用いてビルドします。
あまりたくさんのアセットを1つのAssetBundleにまとめてしまうと、変更が入った時にダウンロードし直す容量が大きくなるため、基本的には小分けにしたほうが良いです。

5. AssetBundleをサーバに配置する

AssetBundleをダウンロードできるように、サーバ上に配置します。

6. サーバから配信するAssetBundleのバージョン情報を更新

AssetBundleのキャッシュの制御のために配信するバージョン情報の更新を行います。
手動で管理するのは大変なので、自動で更新される仕組みを用意しておくと良いでしょう。
ビルドのたびにインクリメントされるようにする、対象ファイルのgitのコミット回数を使う、などが考えられます。
jenkinsなどを使って、4からここまでのフローを自動で行われる仕組みを構築しておくのが望ましいです。

7. 動作確認

アプリ本体の開発と同じく、実機での動作確認は必須です。
iOSとAndroidでAssetBundleは別ファイルになるので、それぞれ確認するようにしましょう。

おわりに

今日はAssetBundleについての導入的な内容をお送りしました。
明日はp_chinによるビルドとリリースに関する記事になります。