「Unity/Addressable/基本」の版間の差分
(→Remote.LoadPath変更) |
(→Addressableとは) |
||
行3: | 行3: | ||
==Addressableとは== | ==Addressableとは== | ||
− | + | *内部Assetsを、都度ロードできるPrefabのようなもの。これによりメモリ使用量を削減できる。 | |
+ | *Remote機能を使えば、外部サーバーで使えるResourcesとなる。 | ||
==インストール== | ==インストール== |
2023年11月30日 (木) 10:42時点における版
目次
- 1 Addressableをscriptで実行
- 2 Addressableとは
- 3 インストール
- 4 Addressableの作り方
- 5 設定確認
- 6 プレイモード選択
- 7 Addressableでビルドしたものを、Addressableを取得
- 8 Addressableの削除
- 9 Addressableの再生成
- 10 ビルド時のパスを確認
- 11 サーバーにAddressableファイルを読み込んで表示
- 12 AddressablesのRemoteLoadPathの変更
- 13 AddressableでダウンロードしたAssetBundleデータの削除
- 14 AddressableでダウンロードしたAssetBundleデータの保存先
- 15 StreamingAssetsディレクトリについて
- 16 "Player content must be built before entering play mode with packed data."エラーが出る場合
- 17 プロジェクトをビルドしたときのAddressableリンクデータ
- 18 依存関連
- 19 addressable設定値の場所
- 20 アプリサイズが大きすぎる場合
- 21 andoridのEditorモードのaddressableのmaterialがピンクになる問題
- 22 Remote.LoadPath変更
- 23 サーバー側で"Access-Control-Allow-Origin"エラーが出る場合
- 24 重複エラー
- 25 自動ビルド
- 26 参考
Addressableをscriptで実行
Unity/Editor/Addressableビルド [ショートカット]
Addressableとは
- 内部Assetsを、都度ロードできるPrefabのようなもの。これによりメモリ使用量を削減できる。
- Remote機能を使えば、外部サーバーで使えるResourcesとなる。
インストール
- Unityメインメニュー/Window/Package Manager/Unity Registryが選択"addressable"を検索
- Addressablesをinstall
Addressableの作り方
- 例として、プレハブを作るのでAssetsの下にResourcesフォルダがなければ作る。
- 適当にプレハブをAssets/Resourcesの下につくる。(例:ButtonGroup)
- inspectorにaddressableのチェックがあるので、チェックを付ける
- チェックをつけると、addressableのpathが生成される(例:ButtonGroup)
- Resources_movedに勝手に移動される。もしくは、作られたファイルをResources以外のdirに入れる。
- 以下SampleScene.csをシーンに連携する
using System.Collections; using UnityEngine; using UnityEngine.AddressableAssets; using UnityEngine.ResourceManagement.AsyncOperations; using UnityEngine.UI; public class SampleScene : MonoBehaviour { [SerializeField] Button clearButton; [SerializeField] Button loadButton; [SerializeField] Button unloadButton; [SerializeField] GameObject canvas; GameObject instance; void Start() { clearButton.onClick.AddListener(() => { Caching.ClearCache(); }); loadButton.onClick.AddListener(() => { if (instance == null) { StartCoroutine(Load()); } }); unloadButton.onClick.AddListener(() => { Destroy(instance); Addressables.ReleaseInstance(instance); // 破棄 }); } IEnumerator Load() { // プレハブ:GameObject、画像:Image、スプライト:Sprite var handle = Addressables.LoadAssetAsync<GameObject>("ButtonGroup"); yield return handle; if (handle.Status == AsyncOperationStatus.Succeeded) { instance = Instantiate(handle.Result, canvas.transform); } } }
Loadボタンを押すと、シーンのCanvasの下に、Addressableで作った、プレハブが表示される。
"Exception encountered in operation CompletedOperation, status=Failed, result= : Exception of type"エラーが出るとき
Addressable化したもののパスが合ってるか確認、PlayModeScript(後述)が、サーバーから取得するようになってないか。
設定確認
- Unityメインメニュー/Window/AssetManagement/Addressable/Groups/Profile/ManageProfiles
BuildTarget:[UnityEditor.EditorUserBuildSettings.activeBuildTarget] LocalBuildPath:[UnityEngine.AddressableAssets.Addressables.BuildPath]/[BuildTarget] LocalLoadPath:{UnityEngine.AddressableAssets.Addressables.RuntimePath}/[BuildTarget] RemoteBuildPath:ServerData/[BuildTarget] RemoteLoadPath:http://[PrivateIpAddress]:[HostingServicePort]/[BuildTarget]
設定変更
設定変更したい場合は、
- Unityメインメニュー/Window/Addressable/Groups/ManageProfiles/Create/NewProfileを選択し、
- 各項目を入力していく
プレイモード選択
- Unityメインメニュー/Window/Addressable/Groups/PlayModeScriptを選択
- Use Asset Database (fastest):Unity内のアセットから
- Simulate Groups (Advanced):依存関係を分析して取得
- Use Existing Build(requires built groups):パックプレイモードで、サーバーから取得
Addressableでビルドしたものを、Addressableを取得
- 上記のPlayModeScriptを"Use Existing Build"へ
- Addressableをビルドする(Unityメインメニュー/Window/Asset Management/Addressables/Groups/Build/New Build/Default Build Script
- プレビュー実行
ちなみにBuild時に以下のようなファイルが出来る。
- Library/com.unity.addressables/aa/WebGL/AddressablesLink
- Library/com.unity.addressables/aa/WebGL/catalog.json
- Library/com.unity.addressables/aa/WebGL/settings.json
- ServerData/WebGL/defaultlocalgroup_assets_all_69745f2bc65176429eb31f083306322b.bundle
Addressableの削除
- Unityメインメニュー/Window/Asset Management/Addressables/Groupsを選択
- 以下3種類削除操作がある
- Build/CleanBuild/All → 以下2つのLibrary/com.unity.addressablesと、Library/BuildCacheが、削除される
- Build/CleanBuild/"Content Builders" → Library/com.unity.addressables が、削除される
- Build/CleanBuild/"Build Pipeline Cache" → Library/BuildCache が、削除される
Addressableの再生成
- Unityメインメニュー/Window/Asset Management/Addressables/Groups
- Build/New Build/Default Build Script
プロジェクト以下/ServerData/WebGL/とかにできる
ServerData/WebGL/catalog_v1.0.hash ServerData/WebGL/catalog_v1.0.json ServerData/WebGL/localization-assets-shared_assets_all.bundle ServerData/WebGL/localization-string-tables-chinese(traditional)(zh-tw)_assets_all.bundle ServerData/WebGL/localization-string-tables-english(unitedstates)(en-us)_assets_all.bundle ServerData/WebGL/localization-string-tables-japanese(japan)(ja-jp)_assets_all.bundle Library/BuildCache/ Library/com.unity.addressables/aa/ Library/com.unity.addressables/WebGL/
ビルド時のパスを確認
- Assets/AddressableAssetsData/AssetGroups/Default Local Group
- BuildPathとLoadPathに何を設定してるか確認。
- LocalBuildPath:Library/com.unity.addressables/aa/WebGL/WebGL
- LocalLoadPath:{UnityEngine.AddressableAssets.Addressables.RuntimePath}/WebGL
- RemoteBuildPath:ServerData/WebGL
- RemoteLoadPath:ttp://localhost/WebGL
サーバーにAddressableファイルを読み込んで表示
- Assets/AddressableAssetsData/AssetGroups/Default Local Group
- BuildPathにRemoteBuildPathを設定し、
- LoadPathにRemoteLoadPathを設定
- Addressableをビルドし、(Unityメインメニュー/Window/Asset Management/Addressables/Groups/Build/New Build/Default Build Script
- ServerData/WebGLにできたファイルを自分のサーバー(例:ttp://localhost/WebGL/~)へ上げる。
- Unityメインメニュー/Window/Addressable/Groups/Profile/ManageProfilesのRemoteLoadPathをttp://localhost/[BuildTarget]から、自分のサーバー(例:ttp://localhost/WebGL/~)のファイルのある場所へ。
- プレイモード(Unityメインメニュー/Window/Addressable/Groups/PlayModeScript)をUse Existing Buildへ
- プレビュー表示すると表示される。
AddressablesのRemoteLoadPathの変更
- Window/Asset Management/Addressables/Groups
- Profile:WebGLを選択
- ManageProfiles
- RemoteLoadPathを変更する
https://qiita.com/tetr4lab/items/1b26755089820b041b4f
AddressableでダウンロードしたAssetBundleデータの削除
スクリプトでの削除
Caching.ClearCache();
Addressableでロードしたアプリ内で、実行してもキャッシュは消えなかった。利用中のキャッシュが消えないのかも。 一度アプリを消して、再度キャッシュクリア処理だけ実行したら消えた。
AddressableでダウンロードしたAssetBundleデータの保存先
macの場合の保存先
~/Library/Caches/Unity/[社名]_AddressablesProject/__info ~/Library/Caches/Unity/[社名]_AddressablesProject/e93a4ab8b320d6c828e139bbc64c9600/6311e87ae18bf58221e098afaa7d0f47/__data ~/Library/Caches/Unity/[社名]_AddressablesProject/e93a4ab8b320d6c828e139bbc64c9600/6311e87ae18bf58221e098afaa7d0f47/__info
windowsの場合の保存先
~\AppData\LocalLow\Unity\[CompanyName]_[ProductName]
androidの場合の保存先
/storage/emulated/0/Android/data/[PackageName]/files/
参考:https://yotiky.hatenablog.com/entry/unity_addresableassetsssytem
参考:https://baba-s.hatenablog.com/entry/2020/04/04/091500
StreamingAssetsディレクトリについて
Addressableをビルドして、UnityプロジェクトのWebGLをBuildすると、
- Build
- TemplateData
- index.html
と同じ場所に、
- StreamingAssets
ができる。
"Player content must be built before entering play mode with packed data."エラーが出る場合
詳細エラーメッセージ
Player content must be built before entering play mode with packed data. This can be done from the Addressables window in the Build->Build Player Content menu command. UnityEngine.GUIUtility:ProcessEvent
一度addressableをビルドする。
プロジェクトをビルドしたときのAddressableリンクデータ
プロジェクトビルドファイルの下に、"StreamingAssets"ができる。 これがないとAddressableにアクセスできない。
依存関連
通常DirにSpriteの画像ファイルを用意して、ResoucesにImageを、作り、Imageのspriteに先程の画像を追加して、Imageをaddressableにすると、Spriteの画像もaddressableのbundle含まれる。実際に検証して、確認もできた。
参考:https://qiita.com/kkpp/items/8238e54cfc67a777a0e9
addressable設定値の場所
Assets/AddressableAssetsData/AddressableAssetSettings.asset
アプリサイズが大きすぎる場合
例:iOSの場合
- "Default Local Group"の"Build & Load Paths"をLocalからRemoteになってるか確認
- Localビルドデータ(Library/com.unity.addressables/aa/iOS/iOS)があれば消す。or addressableのcache削除で消してもok
- Remoteビルドデータ(ServerData/iOS)を一旦消す。or addressableのcache削除で消してもok
andoridのEditorモードのaddressableのmaterialがピンクになる問題
なぜなるのか不明だが、回避策として・・
- PlayModeScriptを、Use Existing Build(requires built groups)からUse Asset Database (fastest)に変えておくと、うまくいくので、Editorモードで、限定してやれば良いかも。
- iosやandroidの実機端末での再生では問題ない。
Remote.LoadPath変更
Unityメインメニュー/Window/AssetsManager/Addressable/Groups/Profile/ManageProfileを選択 Remote.LoadPathの以下デフォルトを変更
ttp://[PrivateIpAddress]:[HostingServicePort]
hoge.example.com/iOSからロードしたい場合
ttp://hoge.example.com/[BuildTarget]
サーバー側で"Access-Control-Allow-Origin"エラーが出る場合
.htaccessを設置する場合、.htaccessを以下のように
Header set Access-Control-Allow-Origin "*"
phpの場合
header("Access-Control-Allow-Origin: *");
重複エラー
エラー詳細
An item with the same key has already been added. Key: 9094b19606136664ab11dcc3ba29f123
対応その1、以下ファイル内に同じidがあれば削除
Assets/AddressableAssetSettings/AddressableAssetSettings.asset
対応その2、Assets/AddressableAssetsData/AssetGroups/内に、同じidがあるファイルを削除
$ grep "9094b19606136664ab11dcc3ba29f123" Assets/AddressableAssetsData/AssetGroups/ -r
自動ビルド
unity2021.2から、unity側ビルド時にaddressableのビルドも自動でするように。
参考:https://light11.hatenadiary.com/entry/2022/08/15/192556
参考
https://robamemo.hatenablog.com/entry/2021/01/08/195415