It is common to separate large assets such as media files, Unity asset bundles, textures, and 3d models into an OBB file to deploy with your APK. Game engines like Unity and Unreal Engine natively support packaging your app into a small APK and one or two large OBB files. There are several strategies for distributing OBB files via ManageXR. This doc provides an overview of each option.
3 Methods for Deploying OBBs:
Upload your OBB file with your APK
Deploy Main and Patch OBB files using Bundled Files
Deploy individual files into OBB directory using Bundled Files
Method 1: Upload your OBB file with your APK
You can upload your main OBB file alongside your APK when creating or uploading a new version of a Managed App. You can do this through the Web Console VR Content Library or automatically using the ManageXR CLI.
Use this method if: Your app APK is deployed with a single OBB file. (This is most common.)
Avoid using if: Your app requires 2 OBB files, a "main" and a "patch" OBB file. (This is not common)
Method 2: Deploy Main and Patch OBB files using Bundled Files
In rare cases, your app may require 2 OBB files - a "main" and a "patch" OBB. This isn't common because Unity doesn't natively support building 2 OBB files. However, if your app is built with two OBB files, you can deploy these OBBs using ManageXR's Bundled Files system. To deploy your 2 main and patch OBB files using Bundled Files:
Upload your main and patch files using to your Library > Files section of the Web Console
Go to your app in your Library > VR Content and find the app version that requires your OBB files
Click the + under Bundled Files and choose the location where your OBB files should be deployed. Then, drag and drop your main and patch files into the folder. (Watch Video above)
It is important to deploy your OBB file(s) to the correct location on the device and to use standard naming conventions.
Location (most common)
Android/obb/<package-name>/
File names
For main OBB: main.<versionCode>.<package-name>.obb
For patch OBB: patch.<versionCode>.<package-name>.obb
If either the location or the file naming is incorrect, it will not work as intended.
Use this method if: Your app APK is deployed with 2 OBB files - a "main" and a "patch" OBB.
Method 3: Deploy individual files into OBB directory using Bundled Files
If you're dealing with many large assets, sometimes your app will exceed the total OBB size supported by Android (4-8GB depending on how many OBB files your game engine supports). This can happen quickly if your app relies on large files like 360 videos.
Instead of bundling files into OBBs, you should consider deploying the raw files to the device's file system and accessing them directly in your code. With Bundled Files, you can deploy any number of files with your APK. The files will still all be deployed together when you use Bundled Files, so you don't need to worry about some files deploying and others getting left behind. To deploy files via Bundled Files:
Upload your files using to your Library > Files section of the Web Console
Go to your app in your Library > VR Content and find the app version that requires your files
Click the + under Bundled Files and choose the location where your files should be deployed (
Android/obb/<package-name>/).
Consider using if:
You have many additional files
You want the flexibility to change some asset files without building a new APK version
FAQs
How many OBBs can I deploy with my APK?
How many OBBs can I deploy with my APK?
Android natively supports deploying up to 2 OBB files with an APK— a main OBB and a patch OBB. Unity will only automatically build your main OBB file, while Unreal supports building both the main and patch OBB files. If you need more flexibility over the files you deploy, we recommend using Method #3 and distributing all the individual files you need as bundled files into the OBB directory.
Can I automatically upload all the individual files or OBB(s) I need to deploy?
Can I automatically upload all the individual files or OBB(s) I need to deploy?
Yes! You can use the ManageXR CLI to automate uploading your APK and OBB file or bundled files to ManageXR.