Difference between revisions of "Infrastructure Guide"

Revision as of 16:50, 11 February 2019

This is the main documentation for the Virtual World Web infrastructure. Programming guides, API documentation, scripting documentation and more. This guide is split into 3 major sections meant for different audiences.

VWW Business Documentation

High-level summary documents describing the Virtual World Web platform and technologies. These will be best suited to managers, marketing folks, investors, or new team members tying to get a better understanding of the VWW.

• Executive Summary
• Technology Stack

VWW Operating Manual

The operating manual for the virtual world web. This area is for scene editors, content creators, world operations, site admins, quest builders, and the like. It will get technical, but will stay away from things that only matter to programmers and stick to "front-end" topics.

• Quick Start Guides
  • Introduction to the Admin
  • Working With Worldspace
  • Controlling Access
  • Using Curiosity
  • Using the Transfer System
  • Scene Editing In Curio
  • Creating and Importing Unity Scenes
  • Creating and Importing Props
  • Creating and Importing Skinned Meshes
  • Using The Game Cloud
  • Creating Scenes for Curio

• Virtual World Web Features
  • Document Object Model
    • Scripts
    • Curves
    • Physics
    • Attribution
    • Layer System
  • Avatars
  • Object Types
  • Inventory and Containers
  • Components
    • Creature Manager
    • Game Cloud
    • World Builder

VWW Technical Manual

This is the technical and reference manual for the VWW. There is written documentation for the major programmable systems explaining how to build a UI script, world script, or component, as well as how the DOM and other key systems work under the hood. There is automatically generated documentation for all API surfaces. Finally those automatically generated documents are augmented with remarks in related/linked but separate documents.

Concepts

• Network Architecture - Explains the VWW Network architecture.
• Software Development Kit - Information about the VWW SDK, its folder layout, tools, and more.

Programming Guides

These sections provide written explanations of major programmable systems, with step-by-step guides to help you get started.

• World Scripting Guide - Write JavaScript that adds interactivity and exciting game features to your scenes. These scripts run on the server, can be updated without a server restart, and can interact directly with users, scene objects, the server and server components.
• Component Programming Guide - Write your own server plug-ins (components) in C# that are loaded directly into the server and admin. These components can do virtually anything. Much of the VWW default functionality is provided by components.
• Curio UI Scripting Guide - Write JavaScript and design UI components that run on connected clients. These scripts can interrupt navigation to display messages or web content. They can be launched in response to world world script events (like clicking on something in world). They can also make up the user-visible part of a custom server component.
• UI Editing Guide - Discusses the process of using the UI Editor to create and edit UI. The created UI can then be displayed by a Curio UI scripts (client-side JavaScript).

Programming Reference

These sections document various programming interfaces. Much of this documentation is auto-generated from source comments, with additional commentary added where further clarification is needed.

• Document Object Model Reference
• World Scripting Reference
• Curio UI Scripting Reference
• Component Programming Reference
• Remote API Reference

Administration

• Server Administration Guide