GIML_Structure

The GIML structure

This article explains the construction of typical GML-files. Also, you may need some background images, item images and sound files. A GIML file should have .gml or .giml as file ending and is built up on JSON.

Contents

• Introduction
• Direct Links
• It's plain JSON
• Global Values
• The Sounds
• The Locations/Rooms
• The Items
• The Panels
• • Panel Buttons
• Example File

Introduction

The interpreter usually loads some values from a .gml-file. It then uses the directory of this file as base directory and loads all the other images and stuff seen from there.

Those commands and values are created as is, when they are needed or could be used, and no warrantries given. ;)

The interpreter makes use of the JavaScript jBash console system to call the functions from the GML-items. GIMLI uses jBashs command registering and issuing mechanism for its own needs. Maybe there will be another, own, parser later, which also takes care of the actual (issuing) item. Right now, only global commands can be issued. You can make use of command parameters, though.

The scripts will NOT be loaded right now, you need to load and register them manually. Later there will be a script directory given in the gml file.

Direct Links

You can add a room name as key to your (HTML-)URL*. E.g.: .../index.html?my_room_1. It just gets the first parameter without value - the key is the value. The interpreter will then jump to this room (Here: my_room_1) instead of the start room given in your GML-files. So, you can interlink to your desired room between different GIML-pages on different servers, or even between HTML and GIML pages. It checks very primitive right now. ;)

*As mentioned on other places, this is just a JavaScript-Prototype for the GIML-structure. You need to call index.html in the interpreter-directory to get the interpreter "up and running". The GML-page will be loaded/called from inside the index.html until GIML has native browser support. You need to modify the path to your GML in the index.html right now, not "from outside" like in a "normal" URL call. But you can change the room from "outside", that is what this chapter is about. Also, it does not work very well right now, because the loading process maybe "intercepts" the direct link call.

It's plain JSON

GML files are written in the JSON format so they can be loaded by just anything and are human readable and easy to edit.

The script-functions for the items are written in JavaScript which makes them compatible for all browsers. They will be loaded into the jBash-command structure to be used with the items. See the built-in jump (GIMLI) and link (jBash) commands.

That means, you register your JavaScript function into jBash and then use jBash for scripting.

All GIML command names will be converted to uppercase.
All jBash commands will be converted to lowercase.

Since Version 0.5.x, all scripts have to be in an array (SCRIPT-"event" in ITEMS and PANELS). So you can use multible script lines. IF condition is in planning phase ;). All versions < 0.5 use ONE script line and no array.

Next: Global values