Getting Started

An overview of MVML, it's API's and helpers, and how to integrate it into your website.


MVML isn't natively supported by browsers yet. Our API converts it into HTML and JavaScript for you.


To use the API, just download and unpack it into the root of your application.



To use the API, just add an <mvml> tag and include these scripts:

<script src="js/mvml/dependencies.js"></script>
<script src="js/mvml/api.js"></script>
<script src="js/mvml/load.js"></script>
If there's a src attribute in the tag, it'll load the MVML from an external file. Otherwise it'll take the MVML from the inner text. Remember that MVML is sensitive to indentation and best-practice HTML formatting interferes with that See the source of this page for an example.


Just like HTML, MVML is built out of a syntax of tags. In order to build worlds, you'll need to understand these.


Just like HTML is essentially XML, MVML is essentially YAML. This is important because unlike XML, YAML is very strict on indentation. Even missing a space could cause an error which forces us to write legibly.

# Valid:
title: Hello metaverse!
- primative: sphere
- primative: box
  color: red

# Broken
 title: Hey metaverse
- primative:
- primative: box
color: red


You create worlds in MVML by stringing together components such as the scene tag or player tag. Knowing how to use these is important.

Unfortunately I don't have full documentation of this yet. Until I do, please read spec.mvml which uses each component and its properties at least once. You can see it rendered here.