Format specifications for the AGEMAME AWPVid Layout file version 1.1 (19th June 2006).

Specifications subject to amendment as the core program develops to include further AWP and SWP technologies.

The layout file is constructed around a custom XML schema, as used by MAME for rendering.

Hence, the output should be a text file, with a .lay extension, and a name matching the short name used by AGEMAME
(i.e. bfmdrwho.lay)

It is hoped that this document will allow support for writing AGEMAME layout files for later submission.


File format:

Files start with these two lines:

<?xml version="1.0"?>
<mamelayout version="2">



And the remainder of the file is layout-specific.

There are two distinct halves to the layout file, with each item being represented in each half. The first half contains the filenames and configuration information.

Every lamp, LED or reel is firstly defined as an 'element', which can take any name, but it's recommended to keep these easy to understand, and preferably using underscores instead of spaces. The filename must also be listed.


For example, a background image (all lights off), with a file name of alloff.png would be listed as

    <element name="backdrop">
         <image file="alloff.png" />
    </element>

A similar system can be used for any other graphic that needs to be permanently displayed.

For lamps, additional information needs to be provided. The current system sets lamps to one of two states:

0 - lamp off
1 - lamp on

When a lamp is turned on, the element goes from image state 0 to image state 1, causing the drawing of the relevant image, if set up as follows.

   <element name="TrailLamp1" defstate="0">
    	<image state="1" file="lampon.png" />
   </element>

For lamps with an independent alpha file (note that white is the transparent colour in these files), the middle line should be
	<image state="1" file="lampon.png" alphafile="lampmask.png"/>

For general transparency, or colour tinting use:
	<image state="1" file="lampon.png">
		<color red="1.0" green="1.0" blue="1.0" alpha="1.0">
	</image>

where 1.0 represents 100% of the values in the existing image.

However, alpha channels within the PNG's are read, which may make matters simpler.

For Bellfruit LED's (which are really driven lamps), the special LED graphics are needed (available on request).

Since elements can be used more than once, this only needs to be included in the first half once:

        <element name="LEDSET" defstate="0">
        	<image state="0" file="segxx.png" />
        </element>

        <element name="LED0" defstate="0">
        	<image state="1" file="seg00.png" />
        </element>

        <element name="LED1" defstate="0">
        	<image state="1" file="seg01.png" />
        </element>

        <element name="LED2" defstate="0">
        	<image state="1" file="seg02.png" />
        </element>

        <element name="LED3" defstate="0">
        	<image state="1" file="seg03.png" />
        </element>

        <element name="LED4" defstate="0">
        	<image state="1" file="seg04.png" />
        </element>

        <element name="LED5" defstate="0">
        	<image state="1" file="seg05.png" />
        </element>

        <element name="LED6" defstate="0">
        	<image state="1" file="seg06.png" />
        </element>

        <element name="LED7" defstate="0">
        	<image state="1" file="seg07.png" />
        </element>


A limitation of the AGEMAME format is that reel animation is difficult to achieve automatically. For simplicity, I will include the easiest form to write i.e. a reel which updates after every complete change of symbol, although I am prepared to explain methods of attaining full animation, or setting up disc and belt reels if necessary. As you can see, the default state of 96 is used to prevent premature display of any reel symbols.

Each 'state' here represents a half-step of the reel, splitting a standard 48-step reel into 96 states.
It is recommended that reel images are given 50-60% transparency when converted to PNG's, this will allow reel lamps to shine throguh more effectively, while not affecting the image when lamps are off (internally, a black background is used behind the image). Again, special reel lamp graphics are available for use in layouts.

       <element name="Reel1" defstate="96">
       <image state="0" file="DW_Cherry.png" />
       <image state="1" file="DW_Cherry.png" />
       <image state="2" file="DW_Cherry.png" />
       <image state="3" file="DW_SBar_K9.png" />
       <image state="4" file="DW_SBar_K9.png" />
       <image state="5" file="DW_SBar_K9.png" />
       <image state="6" file="DW_SBar_K9.png" />
       <image state="7" file="DW_SBar_K9.png" />
       <image state="8" file="DW_SBar_K9.png" />
       <image state="9" file="DW_Blue7.png" />
       <image state="10" file="DW_Blue7.png" />
       <image state="11" file="DW_Blue7.png" />
       <image state="12" file="DW_Blue7.png" />
       <image state="13" file="DW_Blue7.png" />
       <image state="14" file="DW_Blue7.png" />
       <image state="15" file="DW_DBar.png" />
       <image state="16" file="DW_DBar.png" />
       <image state="17" file="DW_DBar.png" />
       <image state="18" file="DW_DBar.png" />
       <image state="19" file="DW_DBar.png" />
       <image state="20" file="DW_DBar.png" />
       <image state="21" file="DW_Cherry_3.png" />
       <image state="22" file="DW_Cherry_3.png" />
       <image state="23" file="DW_Cherry_3.png" />
       <image state="24" file="DW_Cherry_3.png" />
       <image state="25" file="DW_Cherry_3.png" />
       <image state="26" file="DW_Cherry_3.png" />
       <image state="27" file="DW_Red7.png" />
       <image state="28" file="DW_Red7.png" />
       <image state="29" file="DW_Red7.png" />
       <image state="30" file="DW_Red7.png" />
       <image state="31" file="DW_Red7.png" />
       <image state="32" file="DW_Red7.png" />
       <image state="33" file="DW_SBar.png" />
       <image state="34" file="DW_SBar.png" />
       <image state="35" file="DW_SBar.png" />
       <image state="36" file="DW_SBar.png" />
       <image state="37" file="DW_SBar.png" />
       <image state="38" file="DW_SBar.png" />
       <image state="39" file="DW_TBar_1.png" />
       <image state="40" file="DW_TBar_1.png" />
       <image state="41" file="DW_TBar_1.png" />
       <image state="42" file="DW_TBar_1.png" />
       <image state="43" file="DW_TBar_1.png" />
       <image state="44" file="DW_TBar_1.png" />
       <image state="45" file="DW_Blue7.png" />
       <image state="46" file="DW_Blue7.png" />
       <image state="47" file="DW_Blue7.png" />
       <image state="48" file="DW_Blue7.png" />
       <image state="49" file="DW_Blue7.png" />
       <image state="50" file="DW_Blue7.png" />
       <image state="51" file="DW_DBar.png" />
       <image state="52" file="DW_DBar.png" />
       <image state="53" file="DW_DBar.png" />
       <image state="54" file="DW_DBar.png" />
       <image state="55" file="DW_DBar.png" />
       <image state="56" file="DW_DBar.png" />
       <image state="57" file="DW_Cherry.png" />
       <image state="58" file="DW_Cherry.png" />
       <image state="59" file="DW_Cherry.png" />
       <image state="60" file="DW_Cherry.png" />
       <image state="61" file="DW_Cherry.png" />
       <image state="62" file="DW_Cherry.png" />
       <image state="63" file="DW_SBar_2.png" />
       <image state="64" file="DW_SBar_2.png" />
       <image state="65" file="DW_SBar_2.png" />
       <image state="66" file="DW_SBar_2.png" />
       <image state="67" file="DW_SBar_2.png" />
       <image state="68" file="DW_SBar_2.png" />
       <image state="69" file="DW_DBar.png" />
       <image state="70" file="DW_DBar.png" />
       <image state="71" file="DW_DBar.png" />
       <image state="72" file="DW_DBar.png" />
       <image state="73" file="DW_DBar.png" />
       <image state="74" file="DW_DBar.png" />
       <image state="75" file="DW_TBar.png" />
       <image state="76" file="DW_TBar.png" />
       <image state="77" file="DW_TBar.png" />
       <image state="78" file="DW_TBar.png" />
       <image state="79" file="DW_TBar.png" />
       <image state="80" file="DW_TBar.png" />
       <image state="81" file="DW_Cherry_2.png" />
       <image state="82" file="DW_Cherry_2.png" />
       <image state="83" file="DW_Cherry_2.png" />
       <image state="84" file="DW_Cherry_2.png" />
       <image state="85" file="DW_Cherry_2.png" />
       <image state="86" file="DW_Cherry_2.png" />
       <image state="87" file="DW_Red7.png" />
       <image state="88" file="DW_Red7.png" />
       <image state="89" file="DW_Red7.png" />
       <image state="90" file="DW_Red7.png" />
       <image state="91" file="DW_Red7.png" />
       <image state="92" file="DW_Red7.png" />
       <image state="93" file="DW_Cherry.png" />
       <image state="94" file="DW_Cherry.png" />
       <image state="95" file="DW_Cherry.png" />
    </element>

After setting up all graphics in this manner, it is necessary to add the configuration parameters,

These are all written as
         <element name="Parameter" defstate="state" />

Where the Parameters and states must follow the scheme below:


Parameter		State

ReelSteps1		Number of steps between symbols on Reel1
ReelSymbols1		Number of visible symbols on Reel1 (usually 3 or 5)
ReelSteps2		Number of steps between symbols on Reel2
ReelSymbols2		Number of visible symbols on Reel2 (usually 3 or 5)
ReelSteps3		Number of symbol stops on Reel3
ReelSymbols3		Number of visible symbols on Reel3 (usually 3 or 5)
ReelSteps4		Number of symbol stops on Reel4
ReelSymbols4		Number of visible symbols on Reel4 (usually 3 or 5)
ReelSteps5		Number of symbol stops on Reel5
ReelSymbols5		Number of visible symbols on Reel5 (usually 3 or 5)
ReelSteps6		Number of symbol stops on Reel6
ReelSymbols6		Number of visible symbols on Reel6 (usually 3 or 5)
Width			Width of background image (used to draw screen)
Height			Height of background image (used to draw screen)

VFDX1			X coordinate of the first 16seg display
VFDY1			Y coordinate of the first 16seg display
VFDR11,VFDG11,VFDB11,	Value (in decimal notation 0-255) of the Red,Green or Blue component of the first 16seg display
			respectively when on.
VFDR01,VFDG01,VFDB01,	Value (in decimal notation 0-255) of the Red,Green or Blue component of the first 16seg display
			respectively when off.


In the second half of the file, the items set up in the first half are acted upon:

First, bounds needs to be set, again to the dimensions of the background image.

    <view name = "AWP Simulated Video" >   
       <screen index="0">
            <bounds x="0" y="0" width="467" height="673" />
       </screen>

        <backdrop element="backdrop">    
            <bounds x="0" y="0" width="467" height="673" />
        </backdrop>



Now, the names of the files become significant, as each lamp needs to be set up.

The lamping system gives each lamp an internal name LAMPXYZ, where XYZ is the number of the lamp in the decimal system, without leading zeroes, which will necessitate a hex to decimal conversion in some cases.
The dimension figures here should be self explanatory, starting coordinates, width and height
(you can also use left="", right="", top="", bottom="" if this helps) .

e.g.
        <backdrop name="LAMP68" element="LAMP68" state="0">
            <bounds x="277" y="214" width="39" height="40" />
        </backdrop>

Reels are set up as follows:

The central symbol of the reel is set up in its bounds.

        <backdrop name="Reel1" element="Reel1" state="96">
            <bounds x="85" y="491.3333" width="49" height="29.3333" />
        </backdrop>

Next the symbols above and below it are set up, the A1 suffix representing the first symbol above the centre, and B1 representing the first one below - and so on.
They all use the same element in this setup, the one we constructed earlier.

        <backdrop name="Reel1A1" element="Reel1" state="96">
            <bounds x="85" y="462" width="49" height="29.3333" />
            <color red="1.0" green="1.0" blue="1.0" alpha="0.5" />
        </backdrop>

        
        <backdrop name="Reel1B1" element="Reel1" state="96">
            <bounds x="85" y="520.6666" width="49" height="29.3333" />
            <color red="1.0" green="1.0" blue="1.0" alpha="0.5" />
        </backdrop>


The BFM LED system is set up as follows (replace the lamp numbers and bounds with the correct ones for your layout)

        <backdrop name="LEDSET" element="LEDSET" state="0">
            <bounds x="74" y="44" width="16" height="20" />
        </backdrop>
 
        <backdrop name="LAMP8" element="LED0" state="0">
            <bounds x="74" y="44" width="16" height="20" />
        </backdrop>
        
        <backdrop name="LAMP9" element="LED1" state="0">
            <bounds x="74" y="44" width="16" height="20" />
        </backdrop>

        <backdrop name="LAMP10" element="LED2" state="0">
            <bounds x="74" y="44" width="16" height="20" />
        </backdrop>

        <backdrop name="LAMP11" element="LED3" state="0">
            <bounds x="74" y="44" width="16" height="20" />
        </backdrop>

        <backdrop name="LAMP12" element="LED4" state="0">
            <bounds x="74" y="44" width="16" height="20" />
        </backdrop>

        <backdrop name="LAMP13" element="LED5" state="0">
            <bounds x="74" y="44" width="16" height="20" />
        </backdrop>

        <backdrop name="LAMP14" element="LED6" state="0">
            <bounds x="74" y="44" width="16" height="20" />
        </backdrop>

        <backdrop name="LAMP15" element="LED7" state="0">
            <bounds x="74" y="44" width="16" height="20" />
        </backdrop>


The layout must then end as follows, in order for AGEMAME to be able to read it correctly:

For each reel that exists, 
        <backdrop name="ReelSteps1" element="ReelSteps1">
        </backdrop>

        <backdrop name="ReelSymbols1" element="ReelSymbols1">
        </backdrop>


        <backdrop name="Width" element="Width">
        </backdrop>

        <backdrop name="Height" element="Height">
        </backdrop>

        <backdrop name="VFDX1" element="VFDX1">
        </backdrop>

        <backdrop name="VFDY1" element="VFDY1">
        </backdrop>

        <backdrop name="VFDR11" element="VFDXR11">
        </backdrop>

        <backdrop name="VFDG11" element="VFDXG11">
        </backdrop>

        <backdrop name="VFDB11" element="VFDXB11">
        </backdrop>

        <backdrop name="VFDR01" element="VFDXR01">
        </backdrop>

        <backdrop name="VFDG01" element="VFDXG01">
        </backdrop>

        <backdrop name="VFDB01" element="VFDXB01">
        </backdrop>


    </view>
    </mamelayout>