【Unite 2018 Tokyo】『CARAVAN STORIES』のアセットバンドル事例

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

Ad

『CARAVAN STORIES』(キャラスト)
のアセットバンドル事例
2018/5/9
清水史人
株式会社Aiming / ソフトウェアエンジニア

清水史人
株式会社Aiming / ソフトウェアエンジニア
@fumilin
Unity歴6年ほど。クライアント側が多い。
音ゲーが好き。
主なタイトル
・将棋ウォーズ(HEROZ株式会社)
・どうぶつしょうぎウォーズ(HEROZ株式会社)
・...

突然ですが

アセットバンドル
好きですか？

僕は嫌いでした

過去に触った
タイトルで

Resources.Loadと
同じように
使えない

確認の時、アプリと
アセットバンドルの
更新が必要

非同期の
処理に直すの
辛いです

そんな思いも
ありましたが

今日は
これらの問題を
解決します少しだけ

目次
• CARAVAN STORIESについて(1′00″)
• キャラストのアセットバンドル実装(2′00″)
- 単一のリソース名から必要な文字列を生成する(5′00″)
- アセットの読み込み順(7′00″)
- キャッシュやアセットバ...

CARAVAN STORIESについて
• 開発期間 2015/10/16~2017/11/28
• Unity 5.2.1f1~5.6.4p4
• iOS/Android版 2017/11/28リリース
• PC(Windows)版 2018...

プロジェクトについて
• 前身プロジェクトは幻塔戦記グリフォン
• UIは引き続きNGUIを使用
• エフェクトはSPARKGEAR
• Git管理途中からLFSを使用サウンドはSubversion
• アセットバンドルは元のシステムが古か...

目次
• CARAVAN STORIESについて(1′00″)
• キャラストのアセットバンドル実装(2′00″)
- 単一のリソース名から必要な文字列を生成する(5′00″)
- アセットの読み込み順(7′00″)
- キャッシュやアセットバ...

アセットバンドル化の機運の高まり
• アプリサイズが2GBを超えてAndroidでビルドできなくなった
• βテストやリリースが近くなってきた

アセットバンドル化の機運の高まり
• アプリサイズが2GBを超えてAndroidでビルドできなくなった
• βテストやリリースが近くなってきた
アセットバンドル嫌い…だけど
やるかーやるしかないかー

アセットバンドル化の時期
開発時間軸
アセットバンドル化
開発の流れ
0 200 400 600 800
Prepro α β master assetbundle
2015/10/16 2016/2/26 2017/4/10 2017/8/1...

プロジェクトに含まれている主なアセット
数
キャラ 535キャラ/13155clip
BGM 145wav
SE 733wav
Voice 25307wav
ワールド 125種類
カットシーン 110シーン
UI 50パーツ/5500アイコン
...

アセットバンドル化に取り掛かる(1/2)
• 1ヶ月後のβテストに向けて、アプリサイズを減らしてビルドできるようにする
• 最終的には可能なものは全てアセットバンドル化する
- 前身プロジェクトのグリフォンでそうだったので運用的に同じにしたい
...

アセットバンドル化に取り掛かる(2/2)
• 1ヶ月後のβテストに向けて、アプリサイズを減らしてビルドできるようにする
• 最終的には可能なものは全てアセットバンドル化する
• なるべく他の人の作業を止めない
➡ これらを満たすために
• ちょ...

Unity2018.2から入るらしい
Addressable Asset Systemみたいなのが欲しい。
車輪の再発明いやだな…。

社内のプロジェクトの
アセットバンドル実装を探る

あった。
Unity TechnologyのAssetBundleManagerから
派生させた
リソース管理システム

特徴
• 単一のリソース名を使って、Resources/LoadAssetAtPath/AssetBundleの順番
で走査し、最初に見つかったリソースを使う
- 単一のリソース名なので、利用する他の開発者は、アセットバンドルかどうかを
気にし...

目次
• CARAVAN STORIESについて(1′00″)
• キャラストのアセットバンドル実装(2′00″)
- 単一のリソース名から必要な文字列を生成する(5′00″)
- アセットの読み込み順(7′00″)
- キャッシュやアセットバ...

単一のリソース名から必要な文字列を生成する手順
• 構造を同じにすれば、アセットバンドル名以外は機械的に作成できる。
• 例として、単一のリソース名をUI/Icon/1/1_10.png
• LoadAssetAtPath対象フォルダ名をERと...

正規表現を使ったアセットバンドル名の解決(1/3)
static readonly List<AssetBundleNameDefinition> Definitions = new List<AssetBundleNameDefinition...

$正規表現を使ったアセットバンドル名の解決(2/3) public string GetBundleNameOrNull(string assetName)  {  var match = _assetNameRegex.Match(assetN...$

正規表現を使ったアセットバンドル名の解決(3/3)
static Dictionary<string, string> assetBundleNameCache = new Dictionary<string, string>();
publi...

正規表現を使ったアセットバンドル名の解決の補足
• アセットバンドルの名前の付け方(グルーピング)は、プロジェクトごとに個性が出
る箇所。参考として具体的な粒度については後ほど紹介します。
• キャラストではアセットバンドルを見やすくするために...

正規表現を使ったアセットバンドル名のテスト
void GetAssetBundleNameFromAssetNameTest(string answer, string[] relativePaths) 
{ 
foreach (var rel...

特徴
• 単一のリソース名を使って、Resources/LoadAssetAtPath/AssetBundleの順番
で走査し、最初に見つかったリソースを使う
- 単一のリソース名なので、利用する他の開発者は、アセットバンドルかどうかを
気にし...

目次
• CARAVAN STORIESについて(1′00″)
• キャラストのアセットバンドル実装(2′00″)
- 単一のリソース名から必要な文字列を生成する(5′00″)
- アセットの読み込み順(7′00″)
- キャッシュやアセットバ...

読み込み時の走査
1. Resourcesから読み込む
2. 1で読み込めなかったら、
LoadAssetAtPathを使って読み込む
（エディタのみ）
3. 1や2で読み込めなかったら、アセッ
トバンドルから読み込む

読み込み順コード例(1/2)
internal static T LoadResourceFromAll<T>(string pathWithExtension) where T : UnityEngine.Object 
{
var path...

読み込み順コード例(2/2)
internal IEnumerator LoadResourceFromAllAsyncCoroutine<T>(string pathWithExtension, Action<T> onFinishCallB...

ここまでの実装により…
• 以下の4ステップでアセットバンドル化が可能
1. Resources.Loadの読み込み時に使っていたパスに拡張子を付ける
2. 付けたいアセットバンドル名へ変換する正規表現を記述
3. (必要であれば)非同期処理に...

キャラストのアセットバンドル化の流れ
1.全てのアセット読み込みに対して拡張子を追加し、リソース管理システムを置き換
えた
- この時点では同期読みの関数から読み込む
2.アセットバンドル化予定のアセットに対し、アセットバンドル名へ変換する正規...

目次
• CARAVAN STORIESについて(1′00″)
• キャラストのアセットバンドル実装(2′00″)
- 単一のリソース名から必要な文字列を生成する(5′00″)
- アセットの読み込み順(7′00″)
- キャッシュやアセットバ...

アセットバンドルからのアセット同期読み
internal static T LoadResourceFromAll<T>(string pathWithExtension) where T : UnityEngine.Object 
{
var...

アセットバンドルを常にロードしている箇所
• テキストファイル全般(同期読みがしたい)
• Cameraのアニメーション(同期読みがしたい)
• Shaderや密接に結びついてるテクスチャ/マテリアル(依存関係が多い)
• Font(依存関係が...

アセットバンドル化の結果
• 1ヶ月後のβテストに向けて、アプリサイズを減らしてビルドできるようにする
➡ ワールドとサウンドをアセットバンドル化し、800MB程となった。
• 最終的には可能なものは全てアセットバンドル化する
➡ 最終的にアプ...

目次
• CARAVAN STORIESについて(1′00″)
• キャラストのアセットバンドル実装(2′00″)
- 単一のリソース名から必要な文字列を生成する(5′00″)
- アセットの読み込み順(7′00″)
- キャッシュやアセットバ...

AssetBundleManagerの改修点(1/3)
• AssetBundleManagerの2015年頃の物をベースにしています
• 最新版では治っているかもしれません
• 読み込み中のAssetBundleをLoadAssetBundl...

AssetBundleManagerの改修点(2/3)
• AssetBundleManifestのインスタンスを使いまわし
- Initializeを呼ぶ度に毎回GameObjectを生成してたのでSingletonにした
• 同時読み込み数...

AssetBundleManagerの改修点(3/3)
• RemapVariantNameの最適化
- 元々のコードは全てのアセットバンドル名を取得して、総当たりで検索。
- AssetBundleManifestのダウンロード後に、Dict...

追加実装した機能(1/3)
• アセットバンドルビルド後に、各アセットバンドルのファイルのサイズを記録
- ダウンロードサイズ出すため
- 合わせて別ブランチとの差分も出して、変な差分がないかも確認
- ファイルサイズデータはアセットバンドル化...

追加実装した機能(2/3)
• Editorで、指定のPlatformのアセットバンドルを使うオプション
- iOSやAndroidのアセットバンドルのエラーをEditorで確認する目的で作られた
- Shaderは互換性ないのでピンク。それで...

これらのエディタ用機能は、メニューアイテムとして追加

追加実装した機能(3/3)
• 開発用のエディタシーンなど、ゲームサーバーに繋がない状態でアセットバンドル
を暗黙的に使えるようにする
- Editor上でアセットバンドル初期化前にアセットバンドルにアクセスがあったら
暗黙的に初期化を呼んでか...

目次
• CARAVAN STORIESについて(1′00″)
• キャラストのアセットバンドル実装(2′00″)
- 単一のリソース名から必要な文字列を生成する(5′00″)
- アセットの読み込み順(7′00″)
- キャッシュやアセットバ...

UnityEditor上でのロード時間を軽減
• UnityEditor上で、バトル開始時のロード時間が規定時間(20秒)を超えて、タイム
アウトする事がある問題が発生していた。
• シミュレーションモード使わず、アセットバンドルから読み込むと...

UnityEditor上でのAnimationClipの読み込み時間
• アセットバンドルはまとまってたほうが早い
• Resources.LoadとLoadAssetAtPathは同じ
• ForceTextはとても遅く、ForceBinar...

AnimationClipだけアセットバンドルから読み込むコード
internal static T LoadResourceFromAll<T>(string pathWithExtension) where T : UnityEngine....

ローカルのプロジェクトサイズを削減できる
• キャラストのプロジェクトサイズは.gitや.svn含めて130GBほど。
• その内Soundのサイズは.svn込みで35GB。
• 容量圧迫するので、作業的に必要な人だけローカルに落とす運用に。
...

アプリのビルド時間が早くなる
• Androidで3時間ほどかかっていたビルド時間が5分ほどで終わるように。プログラ
ムだけ変更した時の実機確認などが楽になりました。
• 早期にアセットバンドルを導入する理由の一つになると思います。
• アプリ...

目次
• CARAVAN STORIESについて(1′00″)
• キャラストのアセットバンドル実装(2′00″)
- 単一のリソース名から必要な文字列を生成する(5′00″)
- アセットの読み込み順(7′00″)
- キャッシュやアセットバ...

アセットバンドルの粒度
• 粒度は大きく、4600アセットバンドル程にまとめた。
- 一般的な1アセットを1アセットバンドルに入れる運用にすると、キャラストでは
10万を超え、数に依存する処理(起動時間など)が遅くなったり管理が大変になる
ため...

カットシーン(110シーン)
• 1カットシーン1アセットバンドル。
• 中身はカメラのアニメーション＋表情アニメーション＋特殊な背景小物
• ここは依存関係が激しいのでもっと上手くやりたかった。（特定のカットシーン専
用のサウンドやモーション...

キャラ(535キャラ/13155clip)
• Mesh/Texture/Material、全レアリティまとめて1キャラ1アセットバンドル
- レアリティで共通して参照しているパーツやテクスチャが存在する
- 分けるとアセットバンドル数が2倍弱...

サウンド
• BGM(145wav)
- 1BGMを1アセットバンドル
• SE(733wav)
- 基本は1ジャンル(攻撃音など)を1アセットバンドル
- 環境音やカットシーン用の長めのwavは10個1アセットバンドル
• Voice(253...

ワールド(3D背景・125種類)
• 1つのフィールドの素材全てを、1つのア
セットバンドル
• 配置データは別アセットバンドル
• サイズは大きめのフィールドで30MBほど
• テクスチャやメッシュには名前をつけない
- カットシーンから参照...

UI(50パーツ/5500アイコン)
• 上手くまとめるのが難しい。そもそも流動的に変わるもので、アセットバンドルに
したくないもの筆頭
- 複雑なため、17個の正規表現で名前付け
• アイコンは1ジャンル(顔アイコンなど)1アセットバンドル。...

大きくまとめた結果…
• 読み込みはアセットバンドル使ったから遅くなったとかはなかった。
• アップデート時の差分が大きくなったのがデメリット。
- ワールド(背景)は基本的に更新がないと踏んでいたが、実際には細かいテクス
チャの修正や追加パー...

目次
• CARAVAN STORIESについて(1′00″)
• キャラストのアセットバンドル実装(2′00″)
- 単一のリソース名から必要な文字列を生成する(5′00″)
- アセットの読み込み順(7′00″)
- キャッシュやアセットバ...

AssetBundleNameの運用が難しい
• AssetBundleNameの名前付けが重い
- PostProcessorで、アセットの追加/移動時に自動的に名前をつけている。
- その度、metaが変わり再インポートが走り、アセットの読...

想定しているShaderに切り替わらない
• バトル中に半透明になるはずのキャラが半透明にならない
- Shader.Findで差し替えられていなかった
- Shader.Findはアセットバンドル内のシェーダーを指定できない
- Always...

テクスチャが反映されない
• ビルドマシンの特定のプラットフォームの
workspaceで該当のテクスチャのインポートに失
敗していた
• ビルドマシンでUnityを起動して、該当のテクス
チャをReimportしてエディタ上では解決したが、
...

最新のManifest/アセットバンドルがダウンロードできない
• Amazon S3からダウンロードしている時は常に最新をダウンロードできていた
が、IDCF Cloudコンテンツキャッシュ(CDN)からダウンロードする際に、キャッ
シュの削...

BGMが鳴らなくなる
• Resources.UnloadUnusedAssetsを叩いた時に、下記問題が起きていた。
- アセットバンドルの内容が破棄されることがある
- 再生中のサウンドが停止することがある
• 両方共Unity2017.3...

Cacheが溜まる
• WWW.LoadFromCacheOrDownload(url, hash, crc)でダウンロードしている場合、同じ
urlで異なるhashのアセットバンドルをダウンロードしても、前のアセットバンドルは消
えない。
•...

Jenkinsでのアセットバンドルビルドが不安定
• ビルドに時間がかかる
- 差分なしのアセットバンドルビルドで、手元では5分ほどで終わる所、Jenkins(iMac Pro)で
は20分ほどかかる
- ブランチ移動直後では、平気で1〜2時間...

目次
• CARAVAN STORIESについて(1′00″)
• キャラストのアセットバンドル実装(2′00″)
- 単一のリソース名から必要な文字列を生成する(5′00″)
- アセットの読み込み順(7′00″)
- キャッシュやアセットバ...

おわりに
• アセットバンドル化の時期は、α版終了時など、アセットの構造がだいたい決まっ
たときくらいが後戻りが少なくて良いと思う。
• 単一のリソース名での読み込み共通化はやるべき。正規表現の解決の速度はそこま
で遅くないのでデメリットは少な...

Thank you!
おわりです。ご清聴ありがとうございました！