Example menu <spot>:

<spot id="menu3" url="../spotmenu.swf" static="1" salign="BC" align="BC" staticX="-100" staticY="-10" alpha="1" visible="1"
	mouseChildren="1" blockMouse="1" disableKeys="0" disableControls="0"
	onOver="pano.disableWheel=1; pano.disableKeys=1;" 
	onOut="pano.disableWheel=0; pano.disableKeys=0"
	xmlFile="menu23.xml"
/>

Tags and attributes used in plugin XML file:

In <spotmenu> tag:
size	size="124:500"	menu size, if not given menu will be autosized
bgColor	bgColor="#CFCFC0"	background color, default=no background
	bgColor="#FFFFFF-#A0A0A0"	background color gradient (top-bottom)
bgImage	bgImage="img/menubg5.jpg"	background image
borderColor	borderColor="#000000"	border color, default=no border
title	title="My FPP menu"	menu title, default=no title
itemSpace	itemSpace="5"	extra vertical space between menu items, default=0
showAtStart	showAtStart="1"	show menu at start, default=0
selectMode	selectMode="3"	menu item behaviour after being clicked: (see also under NOTES below)
		1 = selected and not clickable (default)
		2 = selected and clickable
		3 = not selected and clickable
hideOnClick	hideOnClick="0"	hide menu after clicking item, default=1
hideStyle	hideStyle="fly,collapse"	menu hiding style, supported values: "", "fly" or "collapse"
		or combination, default=""

Menu commands can be executed from FPP by setting the hotspot action="..." attribute (example: action="select=M5").
The following actions are supported:

click	click=M8	simulate menu item click, onClick command will be executed
select	select=M5	set this menu item as selected, onClick command will NOT be executed
hide	hide=T	0 or 1, anything else will toggle menu state
show	show=T	as "hide" parameter, but inverted
enable	enable=MI1	enable menu item
disable	disable=MI1	disable menu item
unselect	unselect	will unselect any previously selected menu item
item_id	L5=global.showPano5	if action is not one of the above, it will be taken as the id of a menu item and set the onClick command for that item

Parameter and attribute names are not case sensitive ("bgcolor" is equal to "BGColor").

If a background image larger than the menu is used, it will be automatically masked.

The selectMode="n" attribute controls what happens with a menu item after it has been clicked. If you want it to be selected and not clickable again, use selectMode="1" which is default. If you want it to be selected but clickable again use selectMode="2". And if you want it to be not selected and of course clickable again, use selectMode="3".

The "click=xxx" parameter can be used at any time to simulate an menu item click. The onClick command will be executed and the menu will be hidden if "hideOnClick" is set.

The "select=xxx" parameter can also be used to select a menu item. But the onClick command will NOT be executed and the menu will NOT be automatically hidden.

If the "id" attribute is not specified for menu items, the value of the "click" and "select" parameters will be matched against the menu item "text" attribute.

Newline ("\n") codes can be used in the menu item text to make it span over more than one line.

Example of plugin xml file:

<?xml version = '1.0'?>
<spotmenu
   size="200:240"
   bgColor="#FFFFFF-#A0A0A0"
   borderColor="#FFFFFF"
   itemSpace="2"
   title="My FPP menu 5"
   showAtStart="1"
   hideOnClick="1"
   hideStyle="fly"
>
   <fonts>
      <title font="Trebuchet MS" textSize="16" textColor="#FFFFFF" bgColor="#000000" bold="1" />
      <item  font="Trebuchet MS" textSize="14" textColor="#000000" />
      <selected textColor="#000000" bgColor="#FFFFFF"  />
      <mouseOver textColor="#000000" bgColor="#A0A0A0" borderColor="#000000" bold="1" />
   </fonts>
   <menuItems>
      <item id="M1" text="City Hall Tower" image="img/camera2.png" onClick="global.showFake()" onOver="pic5s.visible=1" onOut="pic5s.visible=0" />
      <item id="M2" text="Maria Hill" image="img/camera1.png" onClick="global.showFake()" onOver="pic6s.visible=1" onOut="pic6s.visible=0" />
      <item text="-" />
      <item id="M3" text="%C5SS bridge" image="img/yacht2.png" onClick="global.showFake()" onOver="pic7s.visible=1" onOut="pic7s.visible=0" />
      <item id="M4" text="Where I work" image="img/work.png" onClick="global.showFake()" onOver="pic3s.visible=1" onOut="pic3s.visible=0" />
      <item id="M5" text="The Train Bridge" image="img/train.png" onClick="global.showFake()" onOver="pic2s.visible=1" onOut="pic2s.visible=0" selected="1" />
      <item text="-" />
      <item id="M6" text="My home" image="img/home.png" onClick="global.showFake()" onOver="pic1s.visible=1" onOut="pic1s.visible=0" />
      <item id="M7" text="The Yacht Club" image="img/yacht.png" onClick="global.showFake()" onOver="pic4s.visible=1" onOut="pic4s.visible=0" />
      <item text="-" />
      <item id="M8" text="City Hall Tower" image="img/camera2.png" onClick="global.showFake()" onOver="pic5s.visible=1" onOut="pic5s.visible=0" />
      <item id="M9" text="%C5SS bridge" image="img/yacht2.png" onClick="global.showFake()" onOver="pic7s.visible=1" onOut="pic7s.visible=0" />
      <item id="M10" text="Where I work" image="img/work.png" onClick="global.showFake()" onOver="pic3s.visible=1" onOut="pic3s.visible=0" />
      <item text="-" />
      <item id="M11" text="My home" image="img/home.png" onClick="global.showFake()" onOver="pic1s.visible=1" onOut="pic1s.visible=0" />
      <item id="M12" text="The Yacht Club" image="img/yacht.png" onClick="global.showFake()" onOver="pic4s.visible=1" onOut="pic4s.visible=0" />
   </menuItems>
</spotmenu>
						

Version history: