On-demand resources

Explains ODR and the steps required to use it with your application.

읽는 시간 4분

최근 업데이트: 한 달 전

On-demand resources (ODR) is a feature available for iOS and tvOS that lets you reduce the size of your application. The reduction occurs by separating the core assets needed from the application startup from assets that are optional or appear in later parts of your game. These additional Assets, known as AssetBundles, are available across all Unity build targets. However, you must take extra steps to enable them for hosting on the App Store.

AssetBundles can contain Asset files such as models, materials, textures, and scenes, but they can't include scripts. For this reason, store your scripting logic in the main application. The recommended best practice is that an AssetBundle is at most 64MB in size. This helps to reduce load time and minimizes storage space used on the device.

Enable on-demand resources

To set up your project to use ODR, use the following steps:

Navigate to Edit >
Project Settings
?
> Player > iOS > Other Settings.
In the Configuration section, enable Use on-demand resources.

Create an AssetBundle

To create an AssetBundle, use the following steps:

Create a new folder to group the Assets you want to place into an AssetBundle. To do this, right-click inside the Assets folder in the Project window and go to Create > Folder.
Give the new folder a name.
Select the Asset files you want to add to the AssetBundle, then drag them into your new folder.
In the new folder, create three additional folders named
```
Bundles
```
,
```
ODR
```
, and
```
Editor
```
.

Tag an AssetBundle

When creating an AssetBundle, you must assign a tag to identify it when requesting the AssetBundle download. It's recommended to create a label that matches the bundle’s file name.

To create and assign a tag, use the following steps:

Select the folder where you are grouping your assets.
In the Inspector window, in the Asset Labels section, click the left-hand drop-down menu and select New.
Enter the name of your new label in lowercase.

To generate the new AssetBundle file, you must reference the new label in an Editor script. To create an Editor script:

Right-click in the Editor folder and select Create > MonoBehaviour Script.
Name the new script
```
BuildiOSAssetBundles
```
.

Open

BuildiOSAssetBundles.cs

and copy in the following code example. In this example, the label

textures

is used. Change this throughout with the name of your label in lowercase.

참고

This example uses uncompressed bundles, but this isn’t a requirement to use app thinning.


using UnityEngine;using UnityEditor;public class BuildiOSAssetBundles : MonoBehaviour{    [InitializeOnLoadMethod]    static void SetupResourcesBuild( )    {        UnityEditor.iOS.BuildPipeline.collectResources += CollectResources;    }    static UnityEditor.iOS.Resource[] CollectResources( )    {        return new UnityEditor.iOS.Resource[]        {            new UnityEditor.iOS.Resource( "textures", "Assets/ODR/textures" ).AddOnDemandResourceTags( "textures" ),            new UnityEditor.iOS.Resource( "bundle", "Assets/Bundles/bundle.unity3d" ).AddOnDemandResourceTags( "bundle" ),        };    }    [MenuItem( "Bundle/Build iOS AssetBundle" )]    static void BuildAssetBundles( )    {        var options = BuildAssetBundleOptions.None;        bool shouldCheckODR = EditorUserBuildSettings.activeBuildTarget == BuildTarget.iOS;#if UNITY_TVOS            shouldCheckODR |= EditorUserBuildSettings.activeBuildTarget == BuildTarget.tvOS;#endif        if( shouldCheckODR )        {#if ENABLE_IOS_ON_DEMAND_RESOURCES            if( PlayerSettings.iOS.useOnDemandResources )                options |= BuildAssetBundleOptions.UncompressedAssetBundle;#endif#if ENABLE_IOS_APP_SLICING            options |= BuildAssetBundleOptions.UncompressedAssetBundle;#endif        }        BuildPipeline.BuildAssetBundles( "Assets/ODR", options, EditorUserBuildSettings.activeBuildTarget );    }}

The following line in the previous code sample takes the files tagged with the textures label and creates an AssetBundle file named textures within the Assets/ODR folder:


new UnityEditor.iOS.Resource( "textures", "Assets/ODR/textures" ).AddOnDemandResourceTags( "textures" )

For demonstration purposes, the previous code sample also includes the following line, which adds an AssetBundle called bundle that’s already built - for example, from another project or a third-party vendor:


new UnityEditor.iOS.Resource( "bundle", "Assets/Bundles/bundle.unity3d" ).AddOnDemandResourceTags( "bundle" )

The whole code sample creates a new menu in the Unity Editor menu bar. Go to Bundle > Build iOS AssetBundle to generate the AssetBundles in the ODR folder.

Load the AssetBundle

After you generate the AssetBundles, you must load them into the application.

Create a script in the Assets folder called

LoadBundle.cs

and copy in the following code example. This example script downloads the textures ODR AssetBundle and assigns it the public member of TextureBundle.


using UnityEngine;using UnityEngine.iOS;using System;using System.Collections;public class LoadBundle : MonoBehaviour{    public AssetBundle     TextureBundle;    void Start( )    {        LoadAssetAsync( "textures", "textures" );    }    public async Awaitable LoadAssetAsync( string resourceName, string odrTag )    {        // Create the request        using(OnDemandResourcesRequest request = OnDemandResources.PreloadAsync( new string[] { odrTag } ))        {            // Wait until request is completed            await request;            // Check for errors            if( request.error != null )                throw new Exception( "ODR request failed: " + request.error );            TextureBundle = AssetBundle.LoadFromFile( "res://" + resourceName );        }    }}

Generate an Xcode project

After you create and load the AssetBundles, you must complete the following steps:

Create an Xcode project.
In Xcode, navigate to Build Settings > Assets.
Set Embed Asset Packs In Product Bundle to No, and Enable On Demand Resources to Yes.
Build an iOS App Store package (IPA).
Upload the IPA to App Store Connect’s TestFlight.

Additional resources

App slicing

기술 자료

Development

User Acquisition

Monetization

산업 분야

Unity Engine

User Manual

Script Reference