UI Editor/Packages

From Virtual World Web Wiki
Jump to: navigation, search

A package is a collection of files (scripts, images, audio, and ui) bundled together. The Script Package format is used both by Curio and Server-side for bringing together all the relevant code and assets for a given script.

Create Workflow

Currently only the Curiosity tool has the ability to create or update a Script Package from a folder of existing files. Admin note: The next phase of Curio's UI Editor is planned to include a fully integrated Script Package editor

New Package File

  1. Open the Script Package Editor (Tools > Package Editor, or Ctrl-P)
  2. Create a new package (File > New) and choose where it will be saved
  3. Add files to the package
    • Drag files directly onto the Script Package Editor
    • Right-click Package and choose "Open Folder in Windows Explorer"
  4. Save the package when done

Edit Package File

  1. Open the Script Package Editor (Tools > Package Editor, or Ctrl-P)
  2. Open the Package ("Open File" button or File > Open)
  3. Add/remove/edit files to the package
    • Drag files directly onto the Script Package Editor
    • Right-click Package and choose "Open Folder in Windows Explorer"
    • Double-click files to open for editing
  4. Save the package when done

Uploading A New Package

Curiosity

  1. Connect to your system with Curiosity
  2. Open the Resource Manager (Tools > Resource Manager or F12)
  3. Click "New > Curio UI Script Package"
  4. Edit the Title to reflect the desired name of the Client Script
  5. Click the Browse icon next to the "Ultra" field
  6. Select the package you want to upload
  7. Save the resource ("Save" button or Ctrl-S) to upload to the server

Admin Website

Main article: Admin Website

  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

Repository

The repository feature of Curiosity streamlines the download/edit/upload process while also working to detect and prevent accidental overwrites of changes by other developers.

  1. While connected to your system open the Repository Browser (Tools > Repository Browser, or Ctrl-B)
  2. Pull the repository ("Pull" button)
  3. Browse for the package you want to edit using the tree (or right-click the Client/Server folder and choose "New" to create a new package)
  4. Double-click the package to open it in the Script Package Editor
  5. Continue as though you were editing a Package File
  6. If Auto Save is on (bottom right corner) the file will automatically upload to the server with each change. Otherwise, it will upload whenever you choose to save.