Client

From Multiverse

Navigation Note

The navigation boxes on the right group articles into logical categories and duplicate most of the links shown to the left. Use them to navigate easily among related articles.

Contents 1 Using the Multiverse Client 1.1 Using the Multiverse Client 1.2 Troubleshooting 1.3 Development with the Client 1.4 Reference 2 Customizing client user interface 2.1 Character creation 2.2 UI reference documents 3 Client scripting 3.1 Reference 4 Client rendering scripts 4.1 Particle effects 4.2 Material scripts 4.3 Compositor scripts 4.4 Shaders

Using the Multiverse Client

Using the Multiverse Client

Install & Run  •  Supported Graphics Cards  •  Release Notes  •  Client FAQ  •  Troubleshooting  •  Connecting to a World  •  Client Metering  •  Using the Client Log File  •  Debugging Client Errors

Reference

Command Line Syntax  •  World Settings File  •  Patcher Page Reference  •  Client Logging

If you are new to the Multiverse platform, see Getting Started.

Using the Multiverse Client

• Installing and Running the Client - includes configuration information.
• How a Client Connects to a World - overview of the process and how the Multiverse Network works.
• Using the Client - end-user documentation for the client (includes default key bindings).
• Voice Chat System
• Configuring Voice Chat

Troubleshooting

• Client Troubleshooting - look here if you are having trouble running the Client or connecting to a server.
• Client Logging - general information on how client logging works.
• Using the Client Log File - how to read the client log files.
• Debugging Client Errors - troubleshooting with the log files.

Development with the Client

• Running the Client from the Command-Line - for greater control over how the client operates, use the command line instead of the desktop icon.
• Using Client Timing Meters - for profiling and testing.

Reference

• Client Release Notes - lists known bugs, new features, and other important information.
• Supported Graphics Cards - information on graphics cards supported by the Client.
• World Settings File Reference - duplicates the response from the Multiverse master server.
• Client FAQ - frequently asked questions.

Customizing client user interface

User Interface Development

Overview  •  Managing Widgets  •  Event Handling  •  Using Widget Templates  •  Customizing Key Bindings  •  Localizing UI Text  •  Character Creation Framework  •  Minimap Component  •  Scripting Avatar Appearance

Reference

Widgets  •  Property Elements  •  Imageset Files

Tutorials

Hello World  •  Creating a Button  •  Creating a Menu  •  Creating a Help Dialog  •  Using Radio Buttons

• Overview of Developing Client UI - introduction to the Multiverse Client's UI framework, and tips for UI developers.
• Event Handling - concepts and introduction to Client event handling.
• Positioning and Managing UI Widgets - how to position and size widgets.
• Using Widget Templates - widgets can inherit properties from virtual widget templates.
• Customizing Key Bindings - how to make keystrokes invoke events.
• Displaying International Characters - for localization.
• Minimap Component - how to customize for your world.

Also, see Client UI Tutorials.

Character creation

• Character Creation Framework
  • CharacterCreation.CharacterCreationContext
  • CharacterCreation.CharacterSelectionContext
• Changing Avatar Appearance With Material Scripting

UI reference documents

User Interface Widgets
Browser Button CheckButton EditBox FontString Frame LayeredRegion	Region Script ScrollFrame ScrollingMes-   sageFrame Slider StatusBar Texture

• Widget Reference - for XML elements that define UI widgets.
• Property Element Reference - for XML elements within widget elements that define properties of widgets.
• Imageset Files - define texture images that can be used in widget elements.

Client scripting

Client Scripting

Overview  •  Coordinated Effects  •  Fireball Example  •  Terrain Decals  •  Compositors  •  About Shadows  •  Client Animation System  •  Creating Your Own Animations  •  Scripting Avatar Appearance

Reference

Client Scripting API  •  Client Commands

• Client Scripting API - introduction and overview.
• Coordinated Effects - for projectiles, spells, special attacks, and so on.
  • Coordinated Effects Example - Fireball - a comprehensive example.
• Terrain Decals - Example of creating a compass terrain decal.
• About Shadows - the Multiverse shadow system.
• Client Commands - reference information on client-only commands.
• Client Parameters - Mostly superceded by the Client scripting API; still useful for some things.
• Displaying In-World Video and Web Pages
• Volumetric Regions
• Client Animation System
  • Creating Your Own Animations

Reference

Client Scripting API
ClientAPI Module
AmbientLight AnimableValue Animation AnimationState Camera ColorEx Compositor Decal DefaultInputHandler FogConfig GuiInputHandler HardwareCaps Interface	Light Material Model MorphAnimationTrack MorphKeyFrame Network NodeAnimationTrack NodeKeyFrame OceanConfig ParticleSystem Pass PropertyAnimationTrack PropertyKeyFrame	Quaternion RaySceneQuery RaySceneQueryResult SceneNode ShadowConfig SoundSource SystemStatus Technique TextureUnit Vector3 Voice World WorldObject
Character Creation Framework
CharacterCreation	CharacterCreationContext	CharacterSelectionContext
Video and Web Content
Movie MovieCodec	MovieManager MovieTexture	MovieTextureManager WebBrowser

MARS Client Scripting Library
MarsAbility MarsAction MarsClassAbility MarsCommand MarsContainer MarsCursor MarsEvent MarsGroup	MarsQuest MarsSkill MarsTarget MarsTrade MarsTraining MarsUnit MarsVoice
Additional Modules
MarsStandardCommands
Examples
InstancePortal

Client rendering scripts

Particle Scripts

Syntax  •  Attributes  •  Emitters  •  Affectors

Material Scripts

Techniques  •  Texture Units  •  Passes  •  Vertex and Fragment Programs  •  Calling Vertex and Fragment Programs  •  Copying Materials

Compositor Framework

Compositor Scripts  •  Compositor Techniques  •  Compositor Target Passes  •  Compositor Passes

Shaders

Writing Custom Shaders  •  Built-in Shaders  •  Troubleshooting

The Multiverse Client uses several kinds of scripts to render scenes and effects, including material scripts, particle scripts, and shader scripts.

Particle effects

• Particle Effects and Projectiles - overview of the Multiverse particle system.
• Particle Scripts - syntax of particle scripts.
• Particle System Attributes - attributes determine how a particle effect looks.
• Particle Emitters - emitters determine the area from which a particle effect appears to originate.
• Particle Affectors - affectors modify the appearance and location of particles during their lifetime.

Material scripts

• Overview of Material Scripts
• Techniques
• Texture Units
• Passes
• Vertex and Fragment Programs (Shaders)
• Calling Vertex and Fragment Programs
• Copying Materials

Compositor scripts

• Compositor Framework - compositors apply shader-based filters to a scene, to create special effects such as "bloom" or heat vision.
• Compositor Scripts
• Compositor Techniques
• Compositor Target Passes
• Compositor Passes

Shaders

• Built-in Shaders - description of shaders provided with the basic asset repositories.
• Writing Custom Shaders - basic information if you want to write your own shader scripts in CG or HLSL.
• Troubleshooting Shaders - some tips and tricks.