Asset: Difference between revisions

From Resonite Wiki
Created a page for Assets. Marked it as a stub as I feel this could use a bit more information.
 
No edit summary
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{stub}}
{{stub}}


an '''Asset''' in the context of [[Resonite]], is an object that represents content, either from a user importing it or built into resonite.
An '''Asset''', is any object within a Resonite Creation that is not stored within the Resonite [[Data Model]].


== Examples ==
Some examples of assets are:
Some examples of assets are:
{| class="wikitable"
{| class="wikitable"
Line 8: Line 9:
! Asset Type !! Description
! Asset Type !! Description
|-
|-
| Texture || a 2D image.
| Texture/Image || Images/textures.
|-
|-
| Audio || audio data asset.
| Audio || Sound Effects and other sound sources
|-
|-
| Font || Font files used for rendering text
|-
| Mesh || Mesh information, the triangles that make up a model etc.
|}
|}


Assets are usually stored in the [[Assets_(Slot)|Assets Slot]] in a world, and are regularly garbage collected to optimize a [[World|world]].
== Non-Assets ==
It can often be unclear what is an isn't an asset. Some commonly mistaken items are:
 
* Materials
** These are not assets but instead objects within the Resonite [[Data Model]] that link directly to [[Shaders]].
* Slots
** These are part of the Resonite [[Data Model]] itself.
 
== Asset Variants ==
 
Assets you bring into Resonite will eventually have variants created for them through the [[Asset_Variant|asset variant system]]. Variants, are used to make Resonite content more performant or efficient.
 
== De-duplication ==
 
Assets are de-duplicated, an asset saved in your inventory multiple times will only be counted against your storage quota once. De-duplication is based on the [[Hash]] of the Asset so any change, however small could result in an additional asset stored which does count against your storage quota.
 
{{Note|The space shown in the [[Inventory]] tab of the [[Dash]] for a Resonite creation shows how much it would take if it (or its parts) were not de-duplicated.|warning}}


== Importing ==
== Importing ==


Users can [[Importing Assets|import]] many different asset types, either by pasting Ctrl+V, using the [[File Browser]], or dragging and dropping it into Resonite itself, and then using the Resonite dialog to bring it in. As long as the file type is [[Supported Formats|supported]], Resonite will process it.
Users can [[Importing Assets|import]] assets, either by pasting the asset from their clipboard, using the [[File Browser]], or dragging and dropping them into Resonite itself. As long as the file type is [[Supported Formats|supported]], Resonite will process it.


== Exporting ==
== Exporting ==


Assets and data can be brought out of Resonite in many different ways:
Assets and data can be exported from Resonite in many different ways:
* The [[File Browser]]
* The [[File Browser]]
* Exporting from the [[Context menu|Context Menu]]
* Exporting from the [[Context menu|Context Menu]]
Line 31: Line 51:


== Types ==
== Types ==
<!-- TODO: De-duplicate with the examples table above -->
Assets are used in [[Type:IAssetProvider`1|IAssetProviders]] are used to reference an asset like a [[Reference Type|reference type]] in [[Component|components]] and [[ProtoFlux]].


Assets are used in [[Type:IAssetProvider`1|IAssetProviders]] are used to reference an asset like a [[Reference Type|reference type]] in [[Component|components]] and [[ProtoFlux]].
This is often useful when using [[Complex Types in Components|complex types]].


== Metadata ==
== Metadata ==


Assets contain metadata and this can be used to access information about the asset.
Assets contain metadata and this can be used to access information about the asset. You can use [[Components]] to get or set this metadata information.
 
== Assets In Worlds ==
Assets are usually stored in the [[Assets_(Slot)|Assets Slot]] in a world, and are regularly garbage collected to optimize a [[World|world]].

Latest revision as of 01:59, 7 June 2024

This article or section is a Stub. You can help the Resonite Wiki by expanding it.


An Asset, is any object within a Resonite Creation that is not stored within the Resonite Data Model.

Examples

Some examples of assets are:

Asset Type Description
Texture/Image Images/textures.
Audio Sound Effects and other sound sources
Font Font files used for rendering text
Mesh Mesh information, the triangles that make up a model etc.

Non-Assets

It can often be unclear what is an isn't an asset. Some commonly mistaken items are:

  • Materials
    • These are not assets but instead objects within the Resonite Data Model that link directly to Shaders.
  • Slots

Asset Variants

Assets you bring into Resonite will eventually have variants created for them through the asset variant system. Variants, are used to make Resonite content more performant or efficient.

De-duplication

Assets are de-duplicated, an asset saved in your inventory multiple times will only be counted against your storage quota once. De-duplication is based on the Hash of the Asset so any change, however small could result in an additional asset stored which does count against your storage quota.

The space shown in the Inventory tab of the Dash for a Resonite creation shows how much it would take if it (or its parts) were not de-duplicated.

Importing

Users can import assets, either by pasting the asset from their clipboard, using the File Browser, or dragging and dropping them into Resonite itself. As long as the file type is supported, Resonite will process it.

Exporting

Assets and data can be exported from Resonite in many different ways:

Types

Assets are used in IAssetProviders are used to reference an asset like a reference type in components and ProtoFlux.

This is often useful when using complex types.

Metadata

Assets contain metadata and this can be used to access information about the asset. You can use Components to get or set this metadata information.

Assets In Worlds

Assets are usually stored in the Assets Slot in a world, and are regularly garbage collected to optimize a world.