Using IMML¶

Introduction¶

This is a guide for designers and artists who use IMML, VastScript (LUA scripting) and some plug-ins for interaction. This guide describes IMML in the manner which it is viewed and edited. Developers who are interested in the actual platform and how it interprets the IMML specification, please consult the API, as well as the example on how IMML is used in the VastPark Platform. Do note that as a specification, IMML can be used beyond the VastPark platform.

This guide contains

• Reading Basic IMML Syntax
• IMML Conventions
• Introduction to IMML Elements

For a more detailed guide: Please see Detailed Description of IMML Features

Reading Basic IMML Syntax¶

IMML is composed of elements and attributes.The following examples are simplified.

<IMML> </IMML> is the parent element, all IMML has to come in within these 2 elements.

Other elements are nested within (child elements), for example :
<Model> </Model>

Most elements have attributes
These are written as follows. (for an attribute called 'name'):
Name="I am your Virtual World"

Attributes are written within the starting tag of an element:

<IMML Name="I am your Virtual World"> </IMML>

A simple IMML file looks like this:

(insert picture of code)

(insert picture of park)

You can download this example and open it in the VastPark player. Hit View>Source on the top bar to see the IMML describing the world at any time.

IMML Conventions¶

• Case Sensitive
• Must Close Tags
• Must be properly nested
• Attribute values must always be in quotation marks
• There are 5 predefined symbols that are 'reserved' symbols in XML, to use these pre-defined
  symbols, they should be replaced with the following predefined entity references:

Symbol: Meaning: Replace with:
< less than <

greater than >
& ampersand &
' apostrophe '
" quotation mark "

• (advanced users) IMML uses LF to indicate next line.

Note that all this is the same as XML conventions: http://www.w3schools.com/XML/xml_syntax.asp)

Introduction to IMML Elements¶

IMML contains several pre-defined element types.
(an element in XML is any set of text, open and closed within "<" and ">" tags like this: <ThisisAnElement> </ThisisanElement>)

IMML has 4 main categories of elements:

• List
• the 4
• types
• here

Add a diagram

For detailed listing of these elements and their attributes, go to Detailed Description of IMML Features