Catalog.json: Difference between revisions

[[Category:Unity]]

'''catalog.json''' is a [[Wikipedia:JSON|JSON]] file used by the [[com.unity.addressables]] package in the [[Unity]] game engine. It is a list of all assets used in a game.

The name of the file can be different in each game. Most often it is <code>catalog_data.json</code>, but other options like <code>catalog_catalog.json</code> have also been found. The suffix (like <code>data</code> or <code>catalog</code>) can be chosen by the game developer, and some games can even have multiple content catalogs with different suffixes.

     {{DataStructureField||string|An internal ID. May be a weird path, for example: <code>{UnityEngine.AddressableAssets.Addressables.RuntimePath}/Android/crilocaldata_assets_all.bundle</code>; a 32-character-long hexadecimal string, for example: <code>033f3660efceadd40b8cd2845b485652</code>; an asset path, for example: <code>Assets/CriData/Addressables/dice20.daily.0.acb{{=}}4493e0.asset</code>; a short name, for example: <code>EfficientBlur</code>; a {{Tooltip|URL|The URL does not have to be reachable; it is not used for downloading assets, it is only used as an ID.}}, for example: <code><nowiki>http://rizastcdn.pigeongames.cn/default/Android/1a2a40bd550976c58c842045215f204e.bundle</nowiki></code>; and it probably can be any other UTF-8 string.}}

   }}

   {{DataStructureField|m_resourceTypes|array|A list of all of the types of assets in the catalog. (This field ''is'' lowercase.)|

     {{DataStructureField||object type object|An object type, for example: <code>{"m_AssemblyName": "UnityEngine.CoreModule, Version{{=}}0.0.0.0, Culture{{=}}neutral, PublicKeyToken{{=}}null", "m_ClassName": "UnityEngine.TextAsset"}</code>. See [[#Object type object structure]] for details.}}

== Binary formats ==

=== Key data binary format ===

       {{DataStructureField|key_type|uint8|1-byte number, indicating the type of the key. Known key types are: <code>0</code> - [[Wikipedia:UTF-8|UTF-8]] key; <code>1</code> - [[Wikipedia:UTF-16|UTF-16]] key; <code>4</code> - int32 key.}}

       {{DataStructureField|key_content|union||

         {{DataStructureField|numeric_content|uint32|Only present if key type is <code>4</code>. This field is the key's name.}}

       }}

=== Bucket data binary format ===

<!-- fun fact, this format consists entirely out of uint32 values. fun! -->

<!-- fun fact, this format also consists entirely out of uint32 values. fun! -->

{{DataStructure|

       {{DataStructureField|internal_id_index|uint32|4-byte integer, index into the <code>m_InternalIds</code> array inside the parent [[catalog.json]] file.}}

       {{DataStructureField|resource_provider_index|uint32|4-byte integer, index into the <code>m_ProviderIds</code> array inside the parent [[catalog.json]] file.}}

       {{DataStructureField|bundled_asset_provider_crc|uint32|4-byte integer. This field is used only if the resource provider for this asset is <code>UnityEngine.ResourceManagement.ResourceProviders.BundledAssetProvider</code>. If that is the case, this field's value is seemingly random, ranging from 0 to 4294967295, most likely being some kind of CRC check. If the resource provider is different, this field's value is 0. {{verify}}}}

       {{DataStructureField|extra_data_block_offset|uint32|4-byte integer, offset into the <code>ExtraData</code> binary blob. Points to the beginning of an extra data entry associated with this entry.}}

       {{DataStructureField|resource_type_index|uint32|4-byte integer, index into the <code>m_resourceTypes</code> array inside the parent [[catalog.json]] file.}}

     }}

       {{DataStructureField|class_name_length|uint8|1-byte integer, length of the following string.}}

       {{DataStructureField|class_name|string|UTF-8 string, the length is stored in the <code>class_name_length</code> field.}}

     }}

   }}

==== AssetBundleRequestOptions object structure ====

{{DataStructure|