UI Editor/Admin Website

From Virtual World Web Wiki
Jump to: navigation, search

The Admin Website serves many roles, but for the purpose of UI editing it provides a central place to download, update, and configure UI packages.

Creating New Packages

Clientscripts webpage.PNG
  1. Navigate to the Client Scripts page on the Admin site (Misc > Client Scripts)
  2. Click "Create Client Script" in the top right
  3. Choose a Resource and enter an identifier for the Client Script
  4. Press "Create" to save the new Client Script to the system

Configuring Packages

Clientscripts config.PNG
  1. Navigate to the Client Scripts page on the Admin site (Misc > Client Scripts)
  2. Choose the script you want to configure by clicking its identifier in the list
  3. Provide static Metadata by entering keys and values in the field
  4. (Optional) Provide translation data by updating the list of Translation Identifier Prefixes according to your translation

Delivering Packages

Client scripts provided by server components are generally delivered by the component at an appropriate time (login, when entering scene edit, etc).

For client scripts not associated with a particular component, they can be configured to be delivered when entering a particular region of world space (from a single room to the entire world) or when the user becomes part of an entity group (from a single persona to Everyone).

Delivering to a Worldspace

  1. Configure the package as above
  2. Make sure the "IsForWorldspace" checkbox is on
  3. Navigate to the region of Worldspace you want the package delivered to
  4. Click the "Client Scripts" tab
  5. Click the "Link Client Script" button
  6. Select the script from the ClientScriptID
  7. (Optional) Provide additional Metadata by entering key/value combinations in the provided area
  8. Finish by clicking "Add"

Delivering to an Entity Group

  1. Configure the package as above
  2. Make sure the "IsForEntities" checkbox is on
  3. Navigate to the persona or entity group you want the package delivered to
  4. Click the "Client Scripts" tab
  5. Click the "Link Client Script" button
  6. Select the script from the ClientScriptID
  7. (Optional) Provide additional Metadata by entering key/value combinations in the provided area
  8. Finish by clicking "Add"