Metaverse Assets (Components Documentation) - ReachCloudDevelopers/MetaverseCloudEngine.Unity.SDK GitHub Wiki

What are Metaverse Assets?

Meta Assets are an object type within the Reach ecosystem. Think of a meta asset as a bundle comprised of art and behavior that can then be interacted with in the digital world.

There are 3 kinds of Meta Assets which will be detailed below:

  • Meta Space
  • Meta Prefab
  • Land Plot

Each Meta Asset, while sharing some functionality, has unique characteristics that set it apart from other Meta Assets.

Metaverse Asset Components

Meta Space

This component allows to upload your Unity scene to the REACH Explorer as a Meta Space.

Fields

  • Blockchain Source - If this asset should be tied to the blockchain, this would be the source ID. For Cardano, this is known as the "Asset Unit". NOTE: Only 1 metaverse asset can be uniquely tied to an NFT, and the user who wishes to tie the asset to an NFT must own that NFT in the wallet linked to their Reach Account.
  • Blockchain - The blockchain that the source will be found on.
  • Meta Data - Information about this Meta Space that can be queried via the Reach Cloud Engine API.
    • Name - The name of this asset.
    • Description - The asset's description.
    • Unlisted - Will this asset appear in public listings (i.e. the Dashboard)?
    • Private - Is this asset only accessible to contributors?
    • Cardano References - What Cardano blockchain assets is this asset linked to?
      • Policies - If you want to allow users with any of the given policies to be able to access your asset from their Inventory.
      • Assets - If you want to allow users with a specific Cardano asset to be able to access your asset from their Inventory.
    • Blockchain Join Behavior - If you want a user to join an isolated instance when loading the meta space from the inventory select "Join Private Instance", otherwise if they should join a public instance with others select "Join Public Instance".
    • Crypto Related - This field is necessary to comply with some distribution platform's terms of service. Check this field to hide your meta space if it displays Crypto Currency related content.
    • Load On Start Prefabs - A convenience field that allows you to specify Meta Prefabs that will load in your scene upon join. Each prefab will be spawned at 0,0,0 as a child of the "Meta Space" game object.
    • VR Support - Specify the kind of support VR has.
    • AR Support - Specify the kind of support AR has. (NOTE: If "Not Supported", this meta space will not appear on phones that are compatible with AR)
  • Runtime - The runtime state options for the meta space.
    • Auto Start - Should the meta space automatically start?
    • Auto End - Should the meta space automatically end?
    • Allow Connections After Start - After the meta space has started, should new connections be allowed?
  • Player Spawn - Global spawn options of the meta space.
    • Auto Spawn Player - Should the player be automatically spawned after a Player Group is joined?
    • Default Player Prefab - If no override player prefab is specified in the Player Group, this will be the player prefab used.
  • Network - Networking options for the meta space.
    • Total Max Players - The total number of players that can join this space. Set to -1 to allow unlimited (number of players that can join will also be based on your subscription).
  • Player Groups - Player groups are like "Teams" in PvP games. They allow you to specify options for spawning your players and visual appearance.
    • Display Name - The display name of the Player Group from the group selection menu.
    • Identifier - The player group's unique identifier (must be unique across all groups in the list).
    • Image - An icon that is displayed for this group in the group selection menu.
    • Player Prefab - A group specific player prefab for this group.
    • Min Players - The minimum number of players this group needs before the meta space can be started.
    • Max Players - The maximum number of players this group is allowed to have. -1 means unlimited.
    • Allow User Avatars - Are user avatars (Ready Player Me, Avatar SDK, etc.) allowed to be used by players in this group?
    • Custom Avatars - If the user has no avatar, this 3D model will be used (Should be humanoid if using the default SDK player prefab).
    • Spawn Order - This field will soon be deprecated.

Meta Prefab

(Documentation coming soon)

Land Plot

(Documentation coming soon)