Addressable Asset Systemをベースとした社内用アセット基盤【CAGC2024】

Addressable Asset System (以下、Addressables) をベースに開発した新しいアセット基盤について発表します。
これまで使用していた独自基盤からどういった経緯で新しい基盤を開発するに至ったのか、Addressablesをベースにするにあたって心がけたこと、追加した機能やバックエンド、更に利便性を向上させるサポートライブラリについて具体的に解説します。

https://cagc.cyberagent.co.jp/2024/session/index.html?id=Qy7sJgTV

Copyright © CyberAgent, Inc.

Transcript

1. Addressable Asset System をベースとした社内用アセット基盤 1 クライアントエンジニア / SGEコア技術本部（コアテク） 袴田 大貴　Hakamata Daiki
2. 　はじめに 2 　　アセット管理には多くのエンジニアが頭を悩ませてきたと思います。 　　弊社ではこれまで使っていた基盤から方針を転換し、 　　新しい基盤を開発したので今回紹介します。
3. 　アジェンダ 3 • これまでのアセット基盤 • 新しい基盤の開発経緯 • 開発方針 • 独自に追加した機能 • バックエンド • サポートライブラリ • まとめ
4. これまでのアセット基盤 4
5. 5 　　フルスクラッチのアセット基盤『OCTO』 　　　AmebaGames内で開発され当該部署のゲーム部門子会社化に伴って ゲーム事業部の各子会社に普及。 　　　Unity5の頃から脈々と更新され続けた秘伝のタレのような存在。
6. 　OCTOの特徴 6 　　APIサーバ、管理画面、CLI、Unityパッケージからなる基盤 　　情報公開しているので気になる方は見てみてください 　　　QualiArtsのUnity開発を支える基盤の紹介 　　　複雑化するAssetBundleの配信からロードまでを基盤化した話【CEDEC 2017】 世代管理 参照カウント管理 高パフォーマンス 依存関係管理 ローカルアセット
7. 新しい基盤の開発経緯 7
8. 　経緯 8 • 改修は続けているがコストは徐々に増大 ◦ Addressable Asset Systemの登場に伴って取り残されやすくなった • 高い自由度の反面、習熟が必要でトラブルもたびたび起きていた • ビルドフローやセキュリティ面など利用者側の追加実装が必須だった 　▶ Unityの更新に追随しやすく、利用しやすく、ワークフローをカバー 　　 した新しい基盤『Addressable OCTO』を作ろう
9. 9 　　　　　　　　　　　　　引用: Unity. ADDRESSABLE を使用してコンテンツ管理を簡略化する 　Addressable Asset Systemとは？
10. 　Addressable Asset Systemとは？ 10 • 任意の文字列 (アドレス) を割り当ててアセットをロードできる • ResourcesとAssetBundle、LocalとRemoteを透過的に扱うことができる • 依存関係解決、参照カウント管理を自動で行ってくれる • ローカルホスティング機能、アセットバンドルをビルドせずロードする機能など開発向 け機能がある 　▶ 独自実装で頑張っていたことを大抵やってくれる公式パッケージ
11. 開発方針 11
12. 　方針案 12 　　① Addressable Asset Systemの外付け拡張 　　② Addressable Asset System自体を改造
13. 　方針案 13 　　① Addressable Asset Systemの外付け拡張 　パッケージが拡張に対してあまり開いていなかった 　　② Addressable Asset System自体を改造 　Unityの更新を取り込みやすいように partial キーワードを活用して改造する public static partial class Addressables { // 公式のコード } public static partial class Addressables { // 独自の追加コード } Addressables.cs Addressables_Octo.cs
14. 独自に追加した機能 14
15. 　 旧OCTOに存在した機能 【要望】 • UnityWebRequestのメインスレッド制約を回避したい • C#↔ネイティブ間のメモリコピーを回避したい • HTTP/2に対応したい 　　UnityWebRequestとネイティブ通信の比較については 　　Unityにおける通信APIを色々試して罠を踏んだ話も公開しています 　ネイティブプラグインによる通信 15
16. 　　iOSネイティブ, Androidネイティブ, UnityWebRequestを抽象化 　　 　　WebRequestQueue、AssetBundleProviderに相当するクラスを 　　実装して換装 　ネイティブプラグインによる通信 16 IOctoWebRequest OctoiOS WebRequest OctoAndroid WebRequest OctoUnity WebRequest
17. 　独自キャッシュ 17 　 旧OCTOに存在した機能 【要望】 • 標準ではアセット量が増えるほど準備に時間がかかるのを回避したい • 暗号化したアセットバンドルなども扱いたい
18. 　独自キャッシュ 18 　　シンプルなKeyValueで状態 (なし, あり, 使用中) を管理する機構 　　全キャッシュ走査はせず、問い合わせごと 　　自動削除なし 　　　サイズや日時管理がコストのわりに旧OCTOでもあまり使われていない
19. 　カタログフォーマット 19 　 Addressable Asset SystemのカタログはJSON形式 　　 ※ v1.21.3〜は独自バイナリ形式にも対応 【要望】 • 任意の軽量高速なフォーマットを使いたい
20. 　カタログフォーマット 20 　　カタログフォーマットを抽象化 　　 　　ビルド処理、ロード処理を改修してシリアライズ/デシリアライズ IContentCatalogFormatter Json ContentCatalogFormatter Binary ContentCatalogFormatter MessagePack ContentCatalogFormatter 利用者の任意実装
21. 　非Unityアセット対応 21 　 Addressable Asset Systemの対象はUnityがアセットと認識するもの 【要望】 • CRIWAREのacb、awbなども透過的に扱いたい • Unity対応済み拡張子でもバイナリとして扱いたいことがある
22. 　　① Scripted Importerで適当なアセットとしてUnityに認識させる 　非Unityアセット対応 22 Default Asset Scripted Importer Octo Binary Asset
23. 　　② 生ファイルをビルド結果のAssetBundleとすり替えて成果物とする 　非Unityアセット対応 23 Default Asset Scripted Importer Octo Binary Asset ビルド AssetBundle 成果物
24. 　　③ カタログのファイルサイズやハッシュ値も生ファイルで記載する 　非Unityアセット対応 24 Default Asset Scripted Importer Octo Binary Asset ビルド 成果物 size : 4544 → 6496 hash: 86ae → ecd9 crc : 2818 → 2788 AssetBundle
25. 　暗号化 25 　 Addressable Asset Systemはアセットもカタログも暗号化非対応 　 IPタイトルの増加でセキュリティの重要度も向上 【要望】 • アセットの抽出、解析対策がしたい • 複数のロジックを使い分けることで強度を上げたい • 利用者側でロジックを追加したい
26. 　暗号化 26 　　カタログフォーマットと同様に暗号化ロジックを抽象化 　　 　　ビルド処理にAssetBundleの暗号化ステップを追加 IEncrypter XXX Encrypter YYY Encrypter 利用者の任意実装
27. 　暗号化 27 　　AssetBundle.LoadFromStreamを使ってロードしながら復号 　　LoadFromFile: 暗号化していると使えない 　　LoadFromMemory: 復号したバイト列を渡せば使えるがメモリ消費大 　　 　　 ⚠ Streamにはいくつかの制約があり、特にCanSeek=trueが求められる。 C#標準のCryptoStreamはCanSeek=falseなので ランダムアクセス可能な暗号ロジックおよび、それを使用するStreamの実装が必要。
28. 　Play Asset Delivery対応 28 　　Androidのアプリサイズ上限(150MB)を超えるための対応 　　　インストール時、インストール直後、リクエスト時の配信モードがある 　　　それぞれ1GB、512MB、512MBが上限 　　　インストール時だけであればUnityの設定のみで対応できる 　　公式サンプル 　　　https://github.com/Unity-Technologies/Addressables-Sample 　　 公式から com.unity.addressables.androidという付属パッケージがリリース済み 　　 ※ Unity2023.2以上
29. 　開発イテレーション高速化 29 　 FastModeというアセットをビルドせず直接ロードする機能があり、 　 編集後にすぐに確認が可能 　 大規模プロジェクトではアセット数も膨大になる 【要望】 • 一部のアセットを削除して容量やインポート時間を削減したい
30. 　開発イテレーション高速化 30 　　FastModeとPackedModeを組み合わせたハイブリッドモードを実装 　　　※ プロジェクト内に存在するアセットはFastMode, 存在しないアセットはPackedModeで動作する 　　ResourceLocatorがKeyに対してリソースの場所を返す 　　　FastModeではAddressableAssetSettingsLocatorというロケータを使う 　　　PackedModeで使うカタログもロケータの一種 　　2つのロケータを併用するカスタムロケータを実装
31. バックエンド 31
32. 　方針 32 　 プロジェクト側の負担軽減のために、ある程度の自由度がありつつも 　 統一性のあるバックエンドを提供 【要望】 • 高スケーラビリティ • 低コスト • ビルド内容が確認できる管理画面 • Jenkins等から利用するCLIツール
33. 　サーバ関連機能 33 　　S3、CloundFrontを用意すればスピーディに利用開始できる terraform dockerイメージ (管理画面 / API) CLI
34. 　サーバ関連機能 34
35. 　サーバ関連機能 35 Dev環境 Stg環境 Prd環境 アセットビルド CLIでアップロード 閲覧 環境間同期 環境間同期 配信
36. サポートライブラリ 36
37. 　Smart Addresser 37 　　OSSとして公開済み 　　　https://github.com/CyberAgentGameEntertainment/SmartAddresser 　　任意のルールに従ってアセットにアドレスを付与する 　　バージョン管理機能も備えており、 任意のバージョン以下のアセットのみを Addressable Asset Systemに反映することができる
38. 　Addler 38 　　OSSとして公開済み 　　　https://github.com/Haruma-K/Addler 　　Addressable Asset Systemでロードしたアセットの ライフタイム管理やプーリング、プリローディング機能を備える
39. 　Address Definition Generator 39 　　アセットアドレスを定数や関数としてコード生成する misc public const string misc = “misc”; bg_0001 bg_0002 bg_0003 public static string GetBackground(string backgroundId) { return $”bg_{backgroundId}”; }
40. まとめ 40
41. 41 Unity製 Addressable Asset System 独自の拡張 標準バックエンド基盤 サポートライブラリ より便利に、より安全に、 より高パフォーマンスに ワークフローと環境の標準化 痒い所に手が届くように
42. 　現況 42 • 開発中タイトル4つに導入済み、リリース実績はまだ無い • 開発をサポートしながらワークフローを整備していく • Unity公式の更新はリリースから2週間以内に追随できている • partial活用で更新作業も許容範囲の工数で済んでいる
43. 　展望 43 • 他プラットフォームのネイティブ対応 • 便利に使うためのサポートライブラリ拡充