Official Release Announcements and Notes

Hello all, we will be using this thread to announce each version release, with notes. As you have issues/comments/concerns with the Addressables System, please create new threads as this one will be locked for just release announcements.

With that I'll mention that 0.2.1-preview is out. This release is primarily a bug fix release. We have several larger changes coming very soon, but wanted to get some bug fixes out now. Notes:

- Added checks for adding duplicate scenes into the EditorBuildSettings.scenes list
- Fixed exception when deleting group via delete key, added confirmation to all deletions
- Fixed bundles being built with default compression instead of compression from settings
- Fixed bug in tracking loaded assets resulting in not being able to release them properly
- Added Key property to IAsyncOperation to allow for retrieval of key that requested the operation
- Added AssetLabelReference to provide inspector UI for selecting the string name of a label
- Fixed dragging from Resources to a group.
- Added ability to re-initialize Addressables with multiple runtime data paths. This is to support split projects.
- Clean up StreamingAssets folder after build/play mode
- Smoothed transition from 0.1.x data to 0.2.x data

 

Now released: 0.2.2-preview

This is only a hot-fix for a single issue. The fix involves disabling the Addressable checkbox on all assets until we can get a better fix in at the engine level. More details of the bug are here: https://forum.unity.com/threads/bug...-if-addressables-package-is-installed.541375/

 

Now released: 0.3.5-preview

Lots changed in this release!

Highlights:

• Moved asset group data into separate assets in order to better support version control
• Redesigned the UI, moving most data settings onto actual assets. AddressableAssetSettings and (newly created) AddressableAssetGroup assets.
• Implemented content update workflow within the Build dropdown. See https://docs.unity3d.com/Packages/c...DevelopmentCycle.html#content-update-workflow for details.
• Added support for disabling the automatic initialization of the addressables system at runtime via a script define: ADDRESSABLES_DISABLE_AUTO_INITIALIZATION

Full notes (https://docs.unity3d.com/Packages/com.unity.addressables@0.3/changelog/CHANGELOG.html)

• implemented content update workflow. Added a dropdown to the "Build" button on main window's toolbar.
  • "Build/Prepare for Content Update" will detect assets in locked bundles (bundles flagged as static, by default all local bundles).
  • "Build/Build for Content Update" will build assets with a catalog that is compatible with a previously released player.
  • "Build/Build Packed Data" will build in the same way entering play mode in PackedMode would.
  • implemented Clean Build. "Build/Clean/*" will clear out build caches.
• cleaned up streaming assets folder better after build
• moved asset group data into separate assets in order to better support version control
• fixed bug when canceling export of entries to an AssetEntryCollection
• fixed several bugs related to caching packed bundles in play mode
• added option to build settings to control whether streaming assets is cleared after each build
• enabled CreateBuiltInShadersBundle task in build and preview
• fixed bug in AA initialization that was cuasing tests to fail when AA is not being used.
• fixed bug where toggling "send profiler events" would have no effect in some situations
• default the first 2 converted groups to have StaticContent set to true
• UI Redesign
  • Moved most data settings onto actual assets. AddressableAssetSettings and AddressableAssetGroup assets.
    • AddressableAssetSettings asset has "Send Profile Events", list of groups, labels, and profiles
    • AddressableAssetGroup assets have all data associated with that group (such as BuildPath)
  • Made "preview" be a sub-section within the Addressables window.
  • The "Default" group can now be set with a right-click in the Addressables window.
  • Set play mode from "Mode" dropdown on main window's toolbar.
  • Moved "Hierarchical Search" option onto magnifying glass of search bar. Removed now empty settings cog button.
• fixed issue when packing groups into seperate bundles generated duplicate asset bundle names, leading to an error being thrown during build
• added support for disabling the automatic initialization of the addressables system at runtime via a script define: ADDRESSABLES_DISABLE_AUTO_INITIALIZATION
• added API to create AssetReference from AddressableAssetSettings object in order to create an entry if it does not exist.
• moving resource profiler from the ResourceManager package to the Addressables package
• fixed bug where UnloadScene operation never entered Done state or called callback.
• fixed loading of additonal catalogs. The API has changed to Addressables.LoadCatalogsFromRuntimeData.
• fixed bug in InitializationOperation where content catalogs were not found.
• changed content update workflow to browse for cachedata.bin file instead of folder
• fixed exception thrown when creating a group and using .NET 4.x
• fixed bugs surrounding a project without addressables data.
  • AssetLabelReference inspector rendering
  • AssetReference drag and drop
• fixed profiler details view not updating when a mouse drag is completed
• fixes surrounding the stability of interacting with the "default" group.
• Added docs for the Content Update flow.
• Adjusted UI slightly so single-clicking groups shows their inspector.
• removed not-helpful "Build/Build Packed Data" item from menu.
• fixed bug where you could no longer create groups, and group assets were not named correctly
  

 

Now released: 0.4.6-preview

NOTE: on for iOS builds, turn off code stripping. There is a known bug that we are in-progress fixing.

Highlights (see full list for details):
- MINIMUM RECOMMENDED VERSION - 2018.2.11+ to avoid bugs in the Animation Import Settings Inspector
- Added Hosting Services feature; NOTE: the profile will need to be exactly this "http://[PrivateIpAddress]:[HostingServicePort]" unless you are doing custom fancy things. Full docs: https://docs.unity3d.com/Packages/c.../manual/AddressableAssetsHostingServices.html
- AssetReference now stores the loaded asset
- many changes to the build script and group-data/processor setup.
- Removed "Preview" and added "Analyze".

See docs for more information on new features https://docs.unity3d.com/Packages/com.unity.addressables@0.4/manual/index.html

Full Notes (https://docs.unity3d.com/Packages/com.unity.addressables@0.4/changelog/CHANGELOG.html):
- MINIMUM RECOMMENDED VERSION - 2018.2.11+
- We have re-enabled the addressables checkbox. Versions of 2018.2 older than the .11 release will work unless you attempt to view the Animation Import Settings inspector. If you do have animations you need to inspect, use .11+. If you do not, use any official release version of 2018.2.
- refactored the way IResourceProviders are initialized in the player - serialized data is constructed at runtime to control how the providers are configured
- added readonly custom inspector for AddressableAssetEntryCollection
- AssetReference now stores the loaded asset which can be accessed via the Asset property after LoadAsset completes. ReleaseAsset has been modified to not need the asset passed in (the old version is marked obsolete]
- fixed profiler details view not updating when a mouse drag is completed
- fixed null-ref when moving Resources to Addressables when there are no Resources
- blocked moving EditorSceneList within GUI
- fixed cap on address name length
- fixed workflows of marking Resources as addressable and moving an addressable into Resources.
- fixed issue where AssetReferenceDrawer did not mark scene as dirty when changed.
- added Hosting Services feature; provides extensible framework and implementation for serving packed content to player builds from the Editor
- replaced addressables buildscript with an interface based system. IDataBuilder class is now used to define builders of specific types of data. The Addressables settings object
contains a collection of data builders and uses these to create player and play mode data. Users can implemented custom data builders to control the build process.
- replaced AssetGroupProcessors with a collection of AssetGroupSchema objects. The difference is that the schema objects only contain data and groups can have multiple schemas. The
logic for processing groups now resides in the build script and uses the schemas as data sources and filters for how to build.
- Added Initialization objects that can be created during the build to run during addressables initialization
- Implemented Caching API initialization with initialization objects
- Changed some API and tests to work with 2019.x
- fixed how AssetReference's draw when within lists, arrays, or contained classes
- Fixed the workflow of scenes moving in and out of the Editor Build Settings Scene list.
- Removed "Preview" and added "Analyze".
- The new system runs any rules it knows about.
- Currently this is one rule that is manually set up in code. Future work will have additional rules, and expose the ability to create/add user- or project-specific rules
- This process can be slow, as it runs most of a build to get accurate data.
- Within the Analyze window there is a "fix" button that allows each rule to fix any issues if the rule knows how.
- The current rule is a "check duplicate asset" rule. This looks for assets that are pulled into multiple asset bundles due to dependency calculations. The way it fixes things is to move all of those into a newly created group.
- Added option to toggle logging of all exceptions within the Resource Manager
- Refactored initialization of the addressable asset settings to prevent it getting into a bad state.

 

Now released: 0.4.8-preview

This is primarily a hot-fix to deal with the fact that iOS builds didn't work with code stripping on. Now they do.

full notes: https://docs.unity3d.com/Packages/com.unity.addressables@0.4/changelog/CHANGELOG.html

 

Now released: 0.5.2-preview

Edit - the Unite LA talk is up and covers a lot of concepts about the workflow

As of this release, the Addressables package should start showing up in the Package Manager UI before it's been added to the manifest (no more editing that file manually). This should take place within a day or two of this post.

The most important change from this release is that we have disabled automatic asset bundle building. The reasoning as copied from the changelog:

That used to happen when you built the player, or entered play mode in "packed mode". This is no longer the case. You must now select "Build->Build Player Content" from the Addressables window, or call AddressableAssetSettings.BuildPlayerContent(). We did this because we determined that automatic building did not scale well at all for large projects.

For those using the Scriptable Build Pipeline directly, it's worth noting that it had some API changes. See https://docs.unity3d.com/Packages/com.unity.scriptablebuildpipeline@1.2/changelog/CHANGELOG.html for details.


Notes on future work
- the next release will most likely be a 1.0.X-preview and include some API changes. We currently don't have any large functional changes coming with those. Primarily it will be some changes to naming and namespaces to make the new-user experience more intuitive. Details will be in the changelog, I just want to give the heads up now.
- We are working towards getting out of preview in the first half of next year, but it is unclear if or how exactly that will be tied to versions of the editor.
- The releases of the package so far are compatible with 2018.2 and 2018.3. Full 2019.* support is in-progress.
- Support over the next month or so will be light as the team has holiday.


full Addressables notes: https://docs.unity3d.com/Packages/com.unity.addressables@0.5/changelog/CHANGELOG.html

- *IMPORTANT CHANGE TO BUILDING*
- We have disabled automatic asset bundle building. That used to happen when you built the player, or entered play mode in "packed mode". This is no longer the case. You must now select "Build->Build Player Content" from the Addressables window, or call AddressableAssetSettings.BuildPlayerContent(). We did this because we determined that automatic building did not scale well at all for large projects.
- fixed regression loading local bundles
- Added Adddressables.DownloadDependencies() interface
- fixes for Nintendo Switch support
- Fixed issues around referencing Addressables during an Awake() call
- Code refactor and naming convention fixes
- Cleaned up missing docs
- Content update now handles not having and groups marked as Static Content
- Fixed errors when browing for the addressables_content_state.bin and cancelling
- Moved addressables_content_state.bin to be generated into the addressables settings folder
- Changed some exceptions when releasing null bundles to warnings to handle the case of releasing a failed download operation
- Separated hash and crc options to allow them to be used independently in asset bundle loads.
- Use CRC in AssetBundle.LoadFromFileAsync calls if specified
- Always include AssetBundleRequestOptions for asset bundle locations

 

Now released: 0.5.3-preview

We've released a hot-fix to handle package upgrades. If someone was upgrading from 0.4.x to 0.5.2, the packed play mode asset would go away. This is now fixed.

Note, that if you have already updated to 0.5.2, you may have extra "Packed Mode" assets in your AddressableAssetSettings object. This is harmless. If it bothers you, you can inspect the AddressableAssetSettings object (same place you'd set profile data), and look in the "Data Builders" section. If you see multiple "Packed Mode" entries, you can remove all but one using the "-" button.

 

0.6.6-preview is here. I have two general notes, then I'll get to the specifics.

First, an apology for the large delay between last release and this one. Between the holidays, some other priorities popping up, and some large refactoring, this release took far longer than expected. Moving forward, our goal is to release as close to monthly as possible.

Second, you may have noticed that this is not "1.0". I had mentioned on a couple threads that 1.0 was coming. This release does change some APIs, so we had been planning to move to a 1.0 after that, but in our review, we realize we still have some APIs to change. We are now planning to hold off on 1.0 until we are rock-solid on our interfaces, so that we will not change things once that comes along. I expect this to mean two, or maybe three, more releases, followed by a 1.0 in the May/June time frame. As a bit of reassurance, the interface changes between now and then should not affect most users. For example, we made some changes to the IResourceProvider interface in this release, and will be making some more in the next one. These changes, while public, will only affect those creating custom providers.


Changelog highlights:
- Minimum Unity version is now 2018.3 due to a soon-to-be fixed bug in the engine. If you use the progressive light mapper, prefabs will not be lit correctly when built with Addressables, unless you are using 2019.2 alpha, or, very soon, 2019.1 or 2018.3. The fix is not yet in those versions of the engine.
- BREAKING CODE CHANGES
- to ease code navigation, we have added several layers of namespace to the code.
- All Instantiate API calls (Adddressables and AssetReference) have been changed to only work with GameObjects.
- any hardcoded profile path to com.unity.addressables (specifically LocalLoadPath, RemoteLoadPath, etc) should use UnityEngine.AddressableAssets.Addressables.RuntimePath instead.
For build paths, replace Assets/StreamingAssets/com.unity.addressables/[BuildTarget] with [UnityEngine.AddressableAssets.Addressables.BuildPath]/[BuildTarget]
For load paths, replace Assets/StreamingAssets/com.unity.addressables/[BuildTarget] with {UnityEngine.AddressableAssets.Addressables.RuntimePath}/[BuildTarget]
- We have removed attribute AssetReferenceTypeRestriction as it is cleaner to enforce type via generics
- Attribute AssetReferenceLabelRestriction is renamed to AssetReferenceUILabelRestriction and must be surrounded by #if UNITY_EDITOR in your game code, to enforce it's editor-only capability
- Modifications to IResourceProvider API.
- Removed PreloadDependencies API. Instead use DownloadDependencies
- Remote content catalog now built based on locations specified in top level AddressableAssetSettings inspector (rather than building one remote catalog per group)

and oh so many bug fixes. Full Notes: (https://docs.unity3d.com/Packages/com.unity.addressables@0.6/changelog/CHANGELOG.html)

[0.6.6-preview] - 2019-03-05

• BREAKING CODE CHANGES
  • to ease code navigation, we have added several layers of namespace to the code.
  • All Instantiate API calls (Adddressables and AssetReference) have been changed to only work with GameObjects.
  • any hardcoded profile path to com.unity.addressables (specifically LocalLoadPath, RemoteLoadPath, etc) should use UnityEngine.AddressableAssets.Addressables.RuntimePath instead.
    For build paths, replace Assets/StreamingAssets/com.unity.addressables/[BuildTarget] with [UnityEngine.AddressableAssets.Addressables.BuildPath]/[BuildTarget] For load paths, replace Assets/StreamingAssets/com.unity.addressables/[BuildTarget] with {UnityEngine.AddressableAssets.Addressables.RuntimePath}/[BuildTarget]
  • We have removed attribute AssetReferenceTypeRestriction as it is cleaner to enforce type via generics
  • Attribute AssetReferenceLabelRestriction is renamed to AssetReferenceUILabelRestriction and must be surrounded by #if UNITY_EDITOR in your game code, to enforce it's editor-only capability
  • Modifications to IResourceProvider API.
  • Removed PreloadDependencies API. Instead use DownloadDependencies
• Content Update calculation has changed, this will invalide previously generated addressables_content_state.bin files.
  • Some types for content update were made private as a result of the above change.
• Minimum Unity version is now 2018.3 to address a build-time bug with progressive lightmapper.
• Moved all of the Resource Manager package to be contained within Addressables (no longer a stand alone package). No code change implications.
• Change to content catalog building:
  • Previous model built one catalog per group, wherever that group built it's data.
  • New model builds one catalog locally, and optionally one "remote". Remote location is set on the top level AddressableAssetSettings object.
  • Loading will now always check if remote has changes (if remote exists), and use local otherwise (or cached version of remote).
• LoadScene API now takes the LoadSceneParameters that were added to the engine in 2018.2
• Exposed AddressablesBuildDataBuilderContext.BuildScriptContextConstants for use in build scripts.
• Refactored AddressablesBuildDataBuilderContext.GetValue to take default parameter.
• Fixed Scene asset path to be consistent between different play modes in the catalog data.
• Exposed the various IDataBuilder implementations as public classes.
• Exposed asset and bundle provider types for BundledAssetGroupSchema.
• Fixed several bugs when loading catalogs from other projects.
• Added provider suffix to Initialization operation and Adddressables.LoadCatalogsFromRuntimeData API to better support overriding providers.
• Exposed CachedProvider options in BundledAssetGroupSchema. Each unique set of parameters will generate a separate provider. There is also an option to force a group to have its own providers.
• Added IEnumerable Keys property to IResourceLocator interface.
• Exposed InitializationOperation as public API.
• Added BuildTarget to ResourceManagerRuntimeData. This is used to check if the generated player content was built with the same build target as the player or the editor when entering play mode.
• Removed warnings generated from not finding the cached catalog hash files, which is not an error.
• Fixed bug where scenes were not unloading.
• Fixed GUI exception thrown in group inspector.
• Fixed error case where an asset (usually a bundle) was loaded multiple times as different types (object and AssetBundle).
• Fixed divide by zero bug when computing load percent of simulated asset bundles.
• AddressableAssetBuildResult.CreateResult now takes the settingsPath as a parameter to pass this to the result.
• Fix AssetReference GUI when the AssetReference is inside an array of classes, part of a SerializedObject, or private.
• Fix AssetReferenceSprite to properly support sprites (as opposed to Texture2D's).
• Fixed bug involving scenes being repeatedly added to the build scenes list.
• Removed deprecated and obsolete code. If you are upgrading from a very old version of Addressables, please update to 0.5.3-preview first.
• Removed the default MergeMode on LoadAssets calls to enforce explicit behavior.
• Added IAsyncOperation GetDownloadSize(object key) API to compute remaining data needed to load an asset
• Fixed assets being stuck in a read-only state in UI
• Unified asset moving API to clean up public interface
• Added PlayerVersion override to AddressableAssetSettings
• Ensure UI cannot show invalide assets (such as .cs files)
• Renamed Adddressables.LoadAddtionalCatalogs to Addressables.LoadContentCatalog and now it takes the path of the catalog instead of the settings file
• Moved provider information from ResourceManagerRuntimeDate into ContentCatalogData
• Updating ResourceManager to be a non-static class
• Fixed bugs surrounding assets moving in or out of Resources (outside Addressables UI)
• Fixed the AssetReference dropdown to properly filter valid assets (no Resources and honoring type or label limitations).
• Fixed AssetReferences to handle assets inside folders marked as Addressable.
• Added attribute AssetReferenceUIRestriction to support user-created AssetReference restrictions (they are only enforced in UI, for dropdown and drag&drop)
• Changed addressables_content_state.bin to only build to the folder containing the AddressableAssetSettings object (Assets/AddressableAssetsData/ in most cases)
• Fixed issue where the wrong scene would sometimes be open post-build.

 

0.6.7-preview is here.

This patch just fixes an issue with iOS (and sometimes Android) builds. Occasionally a needed class was getting stripped. The missing class has now been added to our generated link.xml.

 

0.6.8-preview is here

This is a hot fix patch to deal with the Build for Content Update. Apparently it had been doing a content update build, then deleting everything it built locally. Technically this was ok for the update part, as the deployed player can only update remote content. But this meant you couldn't go into play mode, or do useful things locally.

 

Now released: 0.7.4-preview

Note that the docs for the new release are not up yet. Our package doesn't always play nicely with the doc tools, and the holiday weekend as slowed the manual effort needed to work around that. I expect the docs to be up later this week. In the mean time, the full changelog is below

Highlights
- We've changed where we build content, and recommend you delete the old files unless you need them.
-- The content_state.bin is no longer in Assets/AddressableAssetsData, but in Assets/AddressableAssetsData/<platform>
-- The content formerly built into Assets/StreamingAssets/aa will now be built into the Library, then copied into Assets/StreamingAssets/aa only during player builds. This copy occurs pre-build, then cleans itself up post-build. So your StreamingAssets folder will remain as-is.
- We no longer support .NET 3.x. Please update to .NET 4.x
- Known issue: there is still an occasional issue with code stripping on iOS. If you run into iOS issues, try turning stripping off for now.

Full changelog (once it's live: https://docs.unity3d.com/Packages/com.unity.addressables@0.7/changelog/CHANGELOG.html)
- Removed support for .NET 3.x as it is deprecated for Unity in general.
- Replaced IAsyncOperation with AsyncOperationHandle.
- Once the asset is no longer needed, the user can call Addressables.Release, passing in either the handle, or the result the handle provided.
- Exposed AsyncOperationBase for creating custom operations
- These operations must be started by ResourceManager.StartOperation
- Replaced IDataBuilderContext and it's inherited classes with simpler AddressablesDataBuilderInput. This class is fed into all IDataBuilder.BuildData calls.
- Fixed Nintendo Switch and PlayStation4 support.
- Simplified the IResourceProvider interface.
- Refactored build script interface. Made BuildScriptBase and the provided concrete versions easier to inherit from.
- Removed DelayedActionManager.
- Removed ISceneProvider. Users can implement custom scene loading using a custom AsyncOperationBase.
- Removed optional LRU caching of Assets and Bundles.
- Addressables Profiler now tracks all active async operations
- AssetBundles targetting StreamingAssets (by using the profile variable [UnityEngine.AddressableAssets.Addressables.BuildPath] now build to the Library instead of StreamingAssets. During the player build, these files are copied into StreamingAssets, then after the build, the copies are deleted. They are also built into platform specific folders (so building for a second platform will not overwrite data from a first build). We recommend deleting anything in Assets/StreamingAssets/aa.
- The addressables_content_state.bin is built into a platform specific folder within Assets/AddressableAssetsData/. We recommend deleting the addressables_content_state.bin in Assets/AddressableAssetsData to avoid future confusion.
- ScriptableBuildPipeline now purges stale data from its cache in the background after each build.
- Disabled Addressables automatic initialization. It will now initialize itself upon the first call into it (such as Load or Instantiate). To Initialize on startup instead of first use, call Addressables.Initialize().
- Optimized performance around instantiation and general garbage generation.
- Added per-group bundle compression settings.
- Fixes to AssetReference drawers.
- Improved the group template system for creating better defined asset groups.
- Fixed bug in bundle caching that caused GetDownloadSize to report incorrectly
- Cleaned up Load/Release calls to make sure all releases could take either the handle returned by Load, or the handle.Result.
- Added editor-only analytics (nothing added in runtime). If you have Analytics disabled in your project nothing will be reported. Currently only run when you build addressables, it includes data such as Addressables version and Build Script name.
- Fixed null ref issue when cleaning all the data builders
- KNOWN ISSUE: there is still an occasional issue with code stripping on iOS. If you run into iOS issues, try turning stripping off for now.

 

Now released: 0.7.5-preview

This is a small bug fix release, primarily to get scene loading in built players to work.

The changelog online has not updated yet (https://docs.unity3d.com/Packages/com.unity.addressables@0.7/changelog/CHANGELOG.html) so here is the contents:

- Fixed issue with scene loading in the player. If problems persist, please do Build->Clean->All from the Addressables Window.
- Fixed the Addressables Profiler window. It was occasionally not drawing.
- Fixed the return value of LoadAssets when the key is unknown.
- Added logging to inform what's going on (copies of data) during a player build.

 

Now available... a collection of sample projects.

https://github.com/Unity-Technologies/Addressables-Sample

This github repo has 3 sample projects as of now. Each intending to show a single usage of addressalbes in an isolated setup. These are intentionally as simplistic as possible to keep the focus on how to do whatever it is they are doing.

Over time, we intend to add more projects. If you have ideas or feedback, please create another thread on this forum letting us know!

 

Now Released 0.8.4-preview
as is common, the docs are not up yet, but should be very soon.

Highlights
- We renamed almost everything! Well, just the methods that are asynchronous at runtime. We added the word Async to them. This was driven by internal API review, and the desire to align with all of the other async methods in Unity. This should auto-upgrade as long as you click the "i made a backup, go ahead" button when asked.
- We began work revamping the Analyze functionality. It's been moved into it's own window, with a few usability tweaks. More is in the works here.
- Note that AsyncOperationHandle has changed namespaces. This cannot be auto-upgraded, and will require manual fixing. (and the auto upgrade of the Async rename will probably not run until this is fixed manually)


Full Changelog (once live) https://docs.unity3d.com/Packages/com.unity.addressables@0.8/changelog/CHANGELOG.html

- *BREAKING CODE CHANGES*
- Chagned all asynchronous methods to include the word Async in method name. This fits better with Unity's history and convention. They should auto upgrade without actually breaking your game.
- Moved AsyncOperationHandle inside namespace UnityEngine.ResourceManagement (no auto-upgrade here).
- Addressable Analyze changes:
- Analyze has been moved into it's own window.
- CheckSceneDupeDependencies Analyze rule has been added.
- CheckDupeDependencies has been renamed into CheckBundleDupeDependencies.
- Analyze Rule operations for individuals or specific sets of Analyze Rules has been added via AnalyzeRule selections.

 

Now Released 0.8.6-preview

This is a hot fix for scene unloading. Calling UnloadScene with a handle was fine, but passing in a SceneInstance was broken. Both versions now unload properly.

 

Now Released 1.1.3-preview
as is common, the docs are not up yet, but should be very soon.

Two road-map notes:
1. We should be dropping the "-preview" tag in roughly two months. Between now and then, the plan is to just work on some bug fixes, with no API or large feature changes
2. Much of the team has holiday as well as a team off-site in the coming month. So expect slow responses on the forums or with bug reports.

Highlights

• ReleaseInstance will not destroy objects it does not recognize. Returns bool if it destroyed (recognized) object or not
• Added PrimaryKey to IResourceLocation. By default, this will be the address.
• Exposed AnalyzeRule class to support creating custom rules for Addressables analysis

Full Changelog (once live) https://docs.unity3d.com/Packages/com.unity.addressables@1.1/changelog/CHANGELOG.html

- *BREAKING CODE CHANGES*
- ReleaseInstance will now return a bool saying if it successfully destroyed the instance. If an instance is passed in that Addressables is unaware of, this will return false (as of 0.8 and earlier, it would print a log, and still destroy the instance). It will no longer destroy unknown instances.
- Added PrimaryKey to the IResourceLocation. By default, the PrimaryKey will be the address. This allows you to use LoadResourceLocationsAsync and then map the results back to an address.
- Added ResourceType to IResourceLocation.
- This allows you to know the type of a location before loading it.
- Fixes a problem where calling Load*<Type>(key) would load all items that matched the key, then filter based on type. Now it will do the filter before loading (after looking up location matches)
- This also adds a Type input to LoadResourceLocationsAsync. null input will match all types.
- Safety check AssetReference.Asset to return null if nothing loaded.
- New rule added to Analyze window - CheckResourcesDupeDependencies - to check for dependencies between addressables and items in Resources
- Added group rearranging support to the Addressables window.
- Improved logging when doing a Prepare for Content Update.
- Added versions of DownloadDependencies to take a list of IResourceLocations or a list of keys with a MergeMode.
- Fixed scenario where Task completion wouldn't happen if operation was already in a certain state
- Made LoadResourceLocations no longer throw an exception if given unknown keys. This method is the best way to check if an address exists.
- Exposed AnalyzeRule class to support creating custom rules for Addressables analysis.
- Fixed some issues surrounding loading scenes in build scenes list via Addressables
- Removed using alias directives defined in global space.
- Proper disposal of DiagnosticEventCollector and DelayedActionManager when application closes.
- Added support for loading named sub-objects via an "address.name" pattern. So a sprite named "trees" with sub-sprites, could be loaded via LoadAssetAsync<Sprite>("trees.trees_0").
- Known issue: loading IList<Sprite> from a Texture2D or IList<AnimationClip> from an fbx will crash the player. The workaround for now is to load items by name as mentioned just above. Engine fix for this is on its way in.

 

Now Released 1.1.4-preview

This is a hot fix for ensuring no editor types are not included in location data. This covers several edge cases, but the primary scenario is for AnimatorControllers, which need to be re-targetted a RuntimeAnimatorController.

 

Now Released 1.1.5 (note the distinct lack of "-preview")

This is basically 1.1.4 with two small bug fixes. We have been doing additional bug fixes in a separate branch which will role out in a future release, but we wanted the first non-preview to have little changed from the previous release.

With this release out, we are planning to spend the next couple months focused heavily on continued bug fixing without adding features or modifying API. We may add some to the API, but do not intend to break code, and most importantly, not break your data. We want to thank all of you that have stuck with us and continued to give feedback on the package. Please keep the feedback coming on the forum and through Unity's bug reporting tool. We are growing the team working on addressables, and will continue to make supporting it and supporting you, our users, our priority.

Changelog once it's up will be at: https://docs.unity3d.com/Packages/com.unity.addressables@1.1/changelog/CHANGELOG.html

 

Now Released 1.1.7

Now that we are out of preview, we are solidly staying within the rules of semver. So any 1.1.x will have untouched APIs. When we move to 1.2.x, we will add API, but not allow any code breakage.

This is primarily a bug fix release, so there isn't really a "highlight". There's probably one at least worth noting above the others, but I'd recommend just giving the full list a read.

the maybe more important one: This is related to https://forum.unity.com/threads/sta...catalog-when-build-for-content-update.703394/
- Added options for bundle naming: AppendHash, NoHash, OnlyHash.
- As a temporary workaround for updating issues, we recommend setting all groups with StaticContent=true to be NoHash. This will make sure the updated catalog still refers to the correct unchanged bundle. An actual fix will be out in a few releases.

Full List
## [1.1.7] - 2019-07-30
- Fixed chain operation percent complete calculation.
- Fixed scenario where deleting assets would also delete groups that have similar names.
- Fix in bundle caching bug surrounding bundles with '.' in their name
- Significant improvements to the manual pages
- Made the many init-logs not log unless ADDRESSABLES_LOG_ALL is defined in player settings (other logs always worked this way, init didn't).
- Prevented NullReferenceException when attempting to delete entries in the Addressables window.
- Fix for building by label (Bundle Mode = Pack Together By Label)
- Removed ability to mark editor-only assets as addressable in GUI
- Better fix to Editor types being added to the build
- Made BuiltIn Data group read-only by default.
- Fixed NullRef caused by an invalid (BuildIn Data) group being default during a build.
- Fixed path where LoadResourceLocationsAsync could still throw an exception with unknown key. Now it should not, and is a safe way to check for valid keys.
- If Key does not exist but nothing else goes wrong, it will return an empty list and Success state.
- Fixed NullRef caused when there was a deleted scene in the scenes list.
- BuildCompression for Addressables can now be driven from the default group. If necessary WebGL builds will fallback to LZ4Runtime and all other build targets will fallback to LZMA.
- Added options for bundle naming: AppendHash, NoHash, OnlyHash.
- As a temporary workaround for updating issues, we recommend setting all groups with StaticContent=true to be NoHash. This will make sure the updated catalog still refers to the correct unchanged bundle. An actual fix will be out in a few releases.

 

Now Released 1.1.9

Another round of (mostly) bug fixes, here's the full changelog:

• Fixed drag and drop NullRef in main addressables window.
• Fixed AudioMixer type assets getting stripped from bundles.
• Fixed issue where failed async operations weren't getting released from the async operation cache. This fixes the ability to retry a failed download.
• Fix unloading of scenes so that the dependencies will wait for the unload operation to complete before unloading. This was causing an occasional 1-frame visual glitch during unload.
• Fixed scenario where AsyncOperation Task fails to complete when AsyncOperation has already completed.
• Fixed a missed init-log that was stuck always-logging.
• Fixed issue around assets losing dependencies when unloaded then reloaded. This would manifest most often as sprites losing their texture or prefabs losing their shader/material/texture.
• Changed checks for determining if a path is remote or not from looking for "://" to looking for starting with "http". "://" is still used to determine if the asset should be loaded via UnityWebRequest or not.
• Added Analyze Rule to show entire Asset Bundle layout
• Added progress bars and some optimizations for calculating analyze rules

 

Now Released 1.1.10

This is primarily a hotfix for a "Missing File" bug introduced in 1.1.9.

Changelog:

• Fix for all files showing "Missing File" in the addressables window.
• Fix for waiting on a successfully done Task

 

Now Released 1.2.2

A note on versions. We bumped the minor version due to adding some public APIs. The impact of this is that if you are using 2019.3, 1.1.10 will show as "verified" and be the suggested version, even though 1.2.2 is newer. We suggest you use 1.2.2 on any version of the editor it supports.


The most interesting changes this release relate to sub objects. The main use case would be accessing a sprite directly from an addressable SpriteAtlas or an addressable sprite sheet. The other change likely to be popular on the forums is the change to hash calculations to avoid collisions (there are a few threads about it here).

Full Changelog (once live)
https://docs.unity3d.com/Packages/com.unity.addressables@1.2/changelog/CHANGELOG.html

• Made ContentUpdateScript.GatherModifiedEntries public.
• Added sub-object support to AssetReference. For example, you can now have an AssetReference to a specific sprite within a sprite atlas.
• Added sub-object support to addresses via [] notation. For example, sprite atlas "myAtlas", would support loading that atlas via that address, or a sprite via "myAtlas[mySprite]"
• Fixed issue with Content Update workflow. Assets that don't change groups during Content Update now remain in the same bundle.
• Added funtionality to allow multiple diagnostic callbacks to the ResourceManager.
  • Added error and IResourceLocation to the callback.
• Added default parameter to DownloadDependenciesAsync to allow auto releasing of the the operation handle on completion.
• Added memory management documentation.
• Changed OnlyHash naming option to remove folder structure. This is a workaround to Windows long-file-path issues.
• Made AssetReference interfaces virtual
• Fixed hash calculations to avoid collisions
• Fixed Addressables sprite tests
• Added overload for GetDownloadSizeAsync. The overload accepts a list of keys and calculates their total download size.

 

Now Released 1.2.3

This is just a hot-fix for the fact that we said we changed something in our last changelog, but it wasn't actually changed. This release actually "Made ContentUpdateScript.GatherModifiedEntries public".

*note that there are some server replication issues at the moment, so some people may not be able to see this release immediately.

 

Now Released 1.2.4

A fix to some scenarios we missed on the download progress %. DownloadDependenciesAsync should actually report valid %'s now. see note in changelog for details

Changelog:

• Further improvement to the % complete calculations.
  • Note that this is an average of dependency operations. Meaning a LoadAssetsAsync call will average the download, and the loading progress. DownloadDependenciesAsync currently has one extra op, so the download will crawl to 50%, then jump to done (we will look into removing that). Similarly any op that is called before Addressables init's will jump to 50% once init is done.

 

Now Released: 1.3.3

This includes many changes including an updated UI. Some of the UI has been tweaked based on the feedback from https://forum.unity.com/threads/ui-preview-feedback-requested.743501/ but please keep that feedback coming as we intend to keep iterating on this.

The recent Unite talk on Addressables utilizes this UI:

Note that the changes to the github samples that were needed for the talk have not all been integrated into that repo. That will be coming soon.

In general we prefer to get smaller updates out more often, but were unable to this go round. Through the rest of the year, we may still have these less frequent updates due to holiday schedules, but will be releasing as often as we can.

Edit: one important change was forgotten on the changelog, will be added online soon, but noting it here: Added APIs to update content catalog at runtime: CheckForCatalogUpdates() and UpdateCatalogs().
This gives you the ability to update the catalog after initialization.


Full Changelog (once live)
https://docs.unity3d.com/Packages/com.unity.addressables@1.3/changelog/CHANGELOG.html

• UI and naming changes
  • "Static true or false" content is now content with an "Update Restriction" of "Cannot Change Post Release" or "Can Change Post Release"
  • "Fast Mode" (play mode) has been renamed "Use Asset Database (faster)"
  • "Virtual Mode" (play mode) has been renamed "Simulate Groups (advanced)"
  • "Packed Mode" (play mode) has been renamed "Use Existing Build (requires built groups)"
  • There is no longer a current "Build Script" (Build Script menu in Addressables window). Instead the script is selected when triggering the build.
  • Schemas have been given display names to be more clear of their intent BundledAssetGroupSchema.
    • BundledAssetGroupSchema displays as "Content Packing & Loading"
    • ContentUpdateGroupSchema displays as "Content Update Restriction"
    • Bundle and Asset providers within schema settings are named more descriptively
  • Profile management is in its own window ("Profiles")
  • Label management is in its own window
  • "Prepare for Content Update" is now under the "Tools" menu (in Addressables window), and is called "Check for Content Update Restriction"
  • "Build for Content Update" is "Update a Previous Build" (still in "Build" menu of Addressables window).
  • "Profiler" window has been renamed "Event Viewer". It's more accurate, and avoids confusion with "Profilers" window.
• Added additional parameter to AssetReference.LoadSceneAsync method to match Addressables.LoadSceneAsync API
• Added AssetReference.UnloadScene API
• Fixed issue with WebGL builds where re-loading the page was causing an exception to get thrown.
• Fixed Analyze bug where bundle referenced multiple times was flagged as duplicate.
• Fixed issue with hashing dependencies that led to frequent "INCORRECT HASH: the same hash (hashCode) for different dependency lists:" errors.
• Update AddressableAssetEntry cached path to new modified asset entry paths.
• Storing the KeyData string from ContentCatalogData on disk instead of keeping it in memory as it can get quite large.
• Fixed Custom Hosting Service window so it won't close when focus is lost.
• Fixed issue with AudioMixerGroups not getting the proper runtime type conversion for the build.
• Fixed invalid location load path when using "only hash" bundle naming option in 'content packing and loading' schema.
• Removed content update hash from final AssetBundle filename.
• Removed exception in Analyze that was triggering when "Fix Selected Rules" was bundling in Un-fixable rules.
• (SBP) Fixed an edge case where Optimize Mesh would not apply to all meshes in the build.
• (SBP) Fixed an edge case where Global Usage was not being updated with latest values from Graphics Settings.
• (SBP) Fixed Scene Bundles not rebuilding when included prefab changes.
• (edit, not online yet) Added APIs to update content catalog at runtime: CheckForCatalogUpdates() and UpdateCatalogs().

 

Now Released: 1.3.8

This is mostly a hot fix to repair some slip-ups in 1.3.3. The biggest one was that we turned on a "feature" and have since made it optional. So the new feature is still there, but now off by default. The new toggle is "Unique Bundle IDs". See https://docs.unity3d.com/Packages/c...AssetsDevelopmentCycle.html#unique-bundle-ids for more info on that.


full changelog:

• Properly suppressing a harmless "Unknown error in AsyncOperation" that has been popping up during init. It had to do with not finding a cached catalog before a catalog had been cached (so error shouldn't happen).
• Fixed issue with asset hash calcluation for internal asset bundle name when building bundles.
• Adding option "Unique Bundle IDs" to the General section of the AddressableAssetSettings Inspector.
  • If set, every content build (original or update) will result in asset bundles with more complex internal names. This may result in more bundles being rebuilt, but safer mid-run updates. See docs for more info.
  • This complex internal naming was added to 1.3.3 to support safter Content Catalog updating, but was forced on. It is now optional as there are some drawbacks.

 

Now Released: 1.4.0

1.4.x will be our "verified with 2020.1 release", though we still recommend using it regardless of your Unity version (back to 2018.4).

The two most interesting changes are:

• Added the ability to disable checking for content catalog updates during initialization.
  
• Fixed issue with filenames being too long to write to our Temp cache of AssetBundles.

full changelog:
https://docs.unity3d.com/Packages/com.unity.addressables@1.4/changelog/CHANGELOG.html

• Added the ability to disable checking for content catalog updates during initialization.
• Fixed issue where turning off Include in Build in the right circumstances would throw an exception.
• Made internal classes and members public to support custom build scripts.
• Exposed Addressables.InstanceProvider to allow for setting up runtime specific data on custom instance providers.
• Fixed issue with filenames being too long to write to our Temp cache of AssetBundles.
• Changed ProcessGroup in BuildScriptFastMode to directly create catalog entries from Addressable entries.
• Added progress bar to Fast Mode when creating content catalog.

 

Now Released: 1.5.0

I had said before that 1.4.x would be our 2020.1 verified release, but some changes in the process have opened the door for us to continue updating the package (for now). So we aren't sure what the final "verified" version will be with 2020.1 Regardless, here we have 1.5.0 out the door.


full changelog
https://docs.unity3d.com/Packages/com.unity.addressables@1.5/changelog/CHANGELOG.html

• Fixed temporary StreamingAssets files not being removed on a failed player build.
• Added Bundle Naming option for naming as a hash of the full filename string.
• Added a delay before unloaded things are removed from event viewer graph. Ideally this would track with dependencies, but for now it's simply time based.
• Fixed ProfileValueReferences not getting set dirty when changed.
• Added ability for Addressables to handle null references in the Addressables groups list.
  • Null groups should not affect or influence content builds, updates, or Analyze rules.
  • Right clicking on a [Missing Reference] will give you the option to remove all missing references.
• Fixed issue with Analyze reporting multiple duplicate data for one group.
• Fixed issue where unloading a scene was throwing an invalid handle error.
• Added Addressables.ClearDependencyCacheAsync API to clear cached dependent AssetBundles for a given key or list of keys.
• Added type conversion from AnimatorController to RuntimeAnimatorController.

 

Now Released: 1.5.1

This is a hotfix for two issues:
- fixing compatibility with platforms that don't support caching (Switch, PS4, etc.)
- another fix for a scenario where groups were being deleted or null'd out

 

Now Released: 1.6.0

Highlights

• Group Multi-Edit!
• Fixed issue where groups and schemas were getting deleted on import

full changelog
(not online yet)https://docs.unity3d.com/Packages/com.unity.addressables@1.6/changelog/CHANGELOG.html

• Fixed bug where unsubscribing to AsyncOperations events could throw if no subscription happened beforehand.
• Fixed NullReferenceException when displaying Groups window displaying entries with Missing Script References on SubAssets.
• Moved AnalyzeWindow.RegisterNewRule to AnalyzeSystem.RegisterNewRule so that the API/logic wouldn't live in GUI code.
• Fixed bug where scenes in a folder containing "Assets" in the folder name not loadable in "Use Asset Database" mode.
• InvalidKeyException's message now include the type of the key that caused it, if applicable.
• Added the ability to select and edit multiple Addressable Groups at the same time.
• Assigning LocationCount during AddressableAssetBuildResult.CreateResult
• Fixed issue where groups and schemas were getting deleted on import.
• Adding dependencies to built in modules to prevent them from being disabled if Addressables is active.
• Adding scripting define to remove Caching API calls when ENABLE_CACHING is false
• Added API to get the scene AsyncOperation from ActivateAsync(). Made the previous API, Activate(), obsolete.
• Fixed bug where the group window wasn't properly refreshed on Analyse fix

 

Now Released: Addressables 1.6.2 & Scriptable Build Pipeline 1.5.6

Highlighted fix: content update flow had some broken paths that are fixed.
Known issue: in 1.6.x we introduced a significant UI slowdown in the groups menu. That is not fixed in this release, but should be fixed in the next one.

full changelog
https://docs.unity3d.com/Packages/com.unity.addressables@1.6/changelog/CHANGELOG.html
https://docs.unity3d.com/Packages/com.unity.scriptablebuildpipeline@1.5/changelog/CHANGELOG.html

• Checking if Profile Events is enabled on the engine side before running the DiagnosticEventCollector Update.
• Fixed issue where RuntimeKeyIsValid was give a false negative when checking sub-objects.
• Fixed Update Previous Build workflow that wasn't re-using previously built Asset Bundle paths when necessary.
• Updated Scriptable Build Pipeline dependency to bring in these changes:
  • Fixed an issue where texture sources for sprites were not being stripped from the build.
  • Fixed an issue where scene changes weren't getting picked up in a content re-build.
  • Fixed an issue where texture sources for non-packed sprites were being stripped incorrectly.
• Fixed issue where hosting service ports were changing on assets re-import.
• Fixed issues with Content Update, including groups that are Packed Separately not updating properly.

 

Out Now: Addressables 1.8.3 & SBP 1.7.2
Quite a lot of changes. We don't generally like putting this much in one release, but sometimes schedules just get away from us.

The main highlight would be a focus on build performance. This includes SBP's bundle build, as well as the addressables catalog being smaller and quicker to build.

Changelogs are up, and copied here with some bold added for emphasis

https://docs.unity3d.com/Packages/com.unity.addressables@1.8/changelog/CHANGELOG.html
[1.8.3] - 2020-04-07

• Option to disable sprites and subobjects has been added to the Groups window Tools menu. This option is persisted per user, not with the project.
• Catalog entries for subobjects and sprites are no longer serialized into the catalog. These are generated at runtime with a custom resource locator.
• Added missing error logs to various failure cases.
• Fixed subobject parsing to treat anything between the first '[' character and the last ']' as the subobject name instead of the last '[' and the last ']'.
• Changed the display of AssetReference types in the inspector from a dropdown to look like an object reference.
• Added the option to compress the local content catalog by packing it in an asset bundle.
• Added method in settings to retrieve all defined labels.
• Fixed PercentComplete in ChainOperation
• Fixed main settings asset getting marked dirty when making builds.
• Fixed issues with Content Update when entry with dependant entries was modified.
• Fixed "Unknown Exception" issue caused by releasing certain operation handles too many times.
• Added link to online documentation in the addressable windows menu.
• Fixed bug where two assets with the same address packed separately was causing an error.
• Fixed issue where loading a content catalog multiple times was throwing exceptions.
• Made it so using the LoadContentCatalogAsync API creates a ResourceLocation that allows those catalogs to be updated properly.
• Fixed bug where the scene in a recycled InstanceOperation wasn't being cleaned.
• Fixed bug where an invalid location would be created for assets that weren't in a Resources folder, but were part of a group with the PlayerDataGroupShema.
• Schema asset file name uses group name instead of GUID. For example: GroupName_SchemaName.asset
• Fixed text that was being cutoff in the CacheIntializationSettings inspector view.
• During init, if a remote catalog is expected but not present, this will fail silently. Fixed a bug where that silent failure showed up later as an "unknown error in async operation".
  • if you wish to see a log for the failed catalog retrieval, enable ADDRESSABLES_LOG_ALL as a scripting define symbol.
• Fixed bug where renaming a class referenced by an AddressableAssetEntry causes an InvalidKeyException.
• Fixed performance regression in ContentUpdateScript.SaveContentState
• Fixed performance regression in BuildScriptPackedMode.PostProcessCatalogEntries
• Updated to scriptable build pipeline 1.7.2 which includes many build optimizations - see SBP changelog for details

https://docs.unity3d.com/Packages/com.unity.scriptablebuildpipeline@1.7/changelog/CHANGELOG.html
[1.7.2] - 2020-04-07

• Merged in DOTS specific functionality into SBP core.
• Scriptable Build Pipeline settings now stored in ProjectSettings/ScriptableBuildPipeline.json
• Added option to remove extended debugging information from WriteResults before caching for better cache performance
• Added option to log Cache Misses to the console
• Switched to SpookyHash for Unity 2019.3 and higher for most hashing methods to edge out just a bit more performance
• Added multi-threading support to the archive and compress task

[1.6.x-preview]

• Updated SBP DOTs preview version with latest SBP Release changes.
• Updated SBP DOTs preview version with latest SBP Release changes.
• Fixed an issue where switching platforms caused Scene & Shader callbacks to no longer be called
• Improved error messaging when a task fails with an exception
• Removed ENABLE_SUBSCENE_IMPORTER define as everything has landed as of 2019.3.0b5
• Refactor of ImportedContent to be more flexible for adding custom content
• Added check for define ENABLE_SUBSCENE_IMPORTER
• Added support for DOTS SubScene Importer based asset bundles via ImportedContent property
• Added support for adding custom raw files to asset bundles via AddionalFiles property

[1.5.11] - 2020-03-05

• Fixed poor performance of GenerateBundleCommands with large data sets.

 

Out Now: Addressables 1.9.2 & SBP 1.8.2

Highlights:
We now support the "no-domain reload" feature available in the "Enable Play Mode Options" in 2019.3+
Beyond that, this release was primarily focused on optimization. Specifically in incremental builds and some UI functionality.

full changelogs:
https://docs.unity3d.com/Packages/com.unity.addressables@1.9/changelog/CHANGELOG.html
https://docs.unity3d.com/Packages/com.unity.scriptablebuildpipeline@1.8/changelog/CHANGELOG.html

[1.9.2] - 2020-05-21

• Improved the performance of GenerateLocationLists.
• Fixed AssetReferenceLabelUIRestriction not working for private fields
• Fixed AssetReferenceDrawer OnGui changing text of static variable GUIContent.none
• Updated documentation to explain what's happening when DontDestroyOnLoad GameObjects are having their dependencies removed when the scene they originate in is unloaded.
• Using a more efficient method of gathering the Addressable entries for the AssetReferenceDropdown UI.
• Fixed bug surrounding how "Use AssetDatabase" build script handles deleted assets.
• Fixed issue where ContentUpdate was throwing an exception if a dependency wasn't in the previous build.
• PercentComplete calcluation updates to correctly take progress callbacks on ProviderOperations into account.
• Added support for Enable Play Mode Options in 2019.3+
• Fixed issue where diagnostic events are still being sent to the player regardless of the value of "Send Profiler Events".
• Added error checking to make sure that a group doesn't have both a PlayerDataGroupSchema and a BundledAssetGroupSchema.
• Fixed issue where InitializationObjects were causing the InitializationOperation to hang.

[1.8.2] - 2020-05-21

• Improve incremental build performance. Avoid copying archives from the build cache when source and destination creation timestamps are identical.
• Fix caching bug caused by an engine SpookyHash bug. MD5 hashing will be used until this issue is resolved.
• Improve caching performance of the ArchiveAndCompressBundles task