Getting started with Scriptable Build Pipeline
Installing the Scriptable Build Pipeline (SBP) package
Requires Unity 2018.3 or later.
To install this package, follow the instructions in the Package Manager documentation.
To build an AssetBundle, use the ContentPipeline.BuildAssetBundles() method. In its simplest form, you supply the following parameters:
Build Parameters - An object that implements the IBuildParameters
interface. The object specifies the BuildTarget, the BuildTargetGroup, the output path, and additional optional properties.
The content to build - An object that implements the IBundleBuildContent
interface. The object specifies the content to build (the assets) and its layout (what assets in which bundles.)
A results object - An object that implements the IBundleBuildResults
interface. The object receives the details of the built AssetBundles.
Note: The UnityEditor.Build.Pipeline
namespace contains default implementations for all of the SBP required interfaces. Implementation names mirror the interfaces, with the leading 'I' removed. For example, the IBuildParameters
interface is implemented as BuildParameters
.
To quickly switch to building AssetBundles with SBP, use the CompatibilityBuildPipeline.BuildAssetBundles()
method as a drop in replacement for calls to BuildPipeline.BuildAssetBundles()
in your existing code. See also Usage Examples and Upgrade Guide.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.