top of page
UNIHUD Documentation

1. First Time Product Setup

Updated: Mar 18, 2023



Starting from the beginning is always daunting but setting up your product is an easy process that includes at most three key components. This tutorial takes a high level approach to what is needed to be done to make your product UNIHUD enabled.



If you have not done so already, unpack the UNIHUD Interop Kit. Make sure to set your Receiver Script, Oxhead Client and TPAK Installer scripts to "No Transfer". These scripts will delete themselves if they are set to be Transferable in a product.


Product Components

A UNIHUD enabled product itself consists at most 3 components:

  1. The UNIHUD Receiver Script (stored in the product)

  2. SURFACE Notecard (stored remotely)

  3. Optional TEXTURE Notecard (stored remotely)

The Receiver Script, other than being obvious that it is needed to bring your product into the UNIHUD realm, is the only item that is required to be stored in the product.


The SURFACE and TEXTURE Notecards are to be stored in your accounts inventory. We will later explain how the Receiver Script can load these Notecards.


SURFACE NOTECARD

In order for the product to be used with either the UNIHUD or an OXHEAD powered HUD, the Receiver Script needs to load the SURFACE Notecard. A SURFACE Notecard is mandatory as it tells the Receiver Script about how the product is set up for the UNIHUD system.


It includes how the faces on the product are organized and what the UNIHUD skin textures are, if any. Optionally the Notecard can store a lighting channel configuration for Nanite System's open ornamental status lighting protocol. and a "Party Key". The Party Key is a unique random value which is used to uniquely identify the product for OXHEAD powered HUD's. The creator provides this Party Key.


TEXTURE NOTECARD

If your product utilizes Textures, the TEXTURE Notecard is where all of the texture details are located for your product. This Notecard contains all of the UUID's of your textures and describes how and where these textures are used on your product. Don't worry! The process in making TEXTURE Notecards is UUID-less.


TEXTURE Notecards organize your products textures into UVW groups whether the textures are albedo/colour, normal and shine. If your texture groups are material based (bump and shine maps) additional settings exist to set the environmental and glossiness factors for these materials. Albedo/colour maps can be set to different alpha blending modes too. If your product does not use textures, you do not need a TEXTURE Notecard.


Enabling your product

When you have your product Notecards ensure that they have full permissions. Do not be worried here, the notecards are not accessible by anyone else in your inventory. Informing the receiver script about them is done in one of two ways:

  • Populate the product's description with the Notecards' UUIDs in this format:

[SURFACE UUID]_[TEXTURE UUID]

NOTE: Don't include the square brackets, but do include the underscore (_) or a comma between the UUIDs.


OR

  • Use a PRODUCT bootstrap script (supplied in the kit) and populate the surface and texture fields with the UUID's of the Notecards.

Once these are in place on your product, copy in the Receiver Script to your product and it will immediately proceed to load the Notecards.

Once the Notecards have been loaded, your product is ready to use!



69 views0 comments

Related Posts

Comments


bottom of page