Differences

This shows you the differences between two versions of the page.

--- layouts [2019/10/29 04:59]
phulshof
+++ layouts [2020/03/22 11:25] (current)
phulshof [<video> Parameters]
@@ Line 87: / Line 87: @@
 |scrollTime 	|The amount of time (in seconds) it takes for an item to scroll to the next point on the menu (i.e 0.750 = 750 milliseconds)|
 |scrollAcceleration 	|The acceleration rate to scroll by when holding down the up/down/left/right scroll key|
+|minScrollTime 	|The amount of time (in seconds) it takes for an item to scroll to the next point on the menu (i.e 0.750 = 750 milliseconds). This defaults to scrollAcceleration for backwards compatibility.|
 |menuIndex      |The index at which the menu should be inserted in the menu hierarchy. If omitted, the menu will be inserted at the next index. This also allows multiple menus to be inserted at the same index, displaying multiple menus at the same time.|
@@ Line 112: / Line 113: @@
 For more information, see this [[https://bitbucket.org/teamretro/retrofe/src/default/Package/Environment/Common/layouts/Default%2016x9/layout.xml?at=default|example]]
 \\
+\\
+=====<video> Parameters=====
+The <video> tag supports the following parameters:
+^<video> tag parameters^^
+|src 	  |The location of the video to display (relative to the location of the active layout folder)|
+|numLoops |The number of times the video is played (0 = endless loop; default is 1)|
+|volume	  |The volume for the video to display (between 0 and 1; default is 1)|
+Example:
+  <video src="video.mp4" volume="0.5" x="0" y="0" height="stretch" width="stretch" layer="0"/>
 \\
 =====<image> Parameters=====
@@ Line 150: / Line 166: @@
 |imageType 	|The type of image to display if a video cannot be found: "numberButtons", "numberPlayers", "year", "title", "manufacturer", "genre".|
 |mode 	|See mode attribute for more details.|
+|volume	|The volume for the video to display (between 0 and 1; default is 1)|
 |textFallback 	|Set to true to have text displayed of a the item title if an image cannot be loaded.|
 |font 	|Location of the font (relative to the layout folder).|
@@ Line 161: / Line 178: @@
 Example:
-  <reloadableVideo imageType="screenshot" x="400" y="300" xOrigin="center" yOrigin="center" height="480" maxWidth="640" layer="3"/>
+  <reloadableVideo imageType="screenshot" volume="0.5" x="400" y="300" xOrigin="center" yOrigin="center" height="480" maxWidth="640" layer="3"/>
 \\
@@ Line 301: / Line 318: @@
 |onMenuJumpEnter 	|Action happens on entering a jump in the menu (next/previous letter/page, random).|
 |onMenuJumpExit 	|Action happens on exiting a jump in the menu (next/previous letter/page, random).|
+|onAttractEnter         |Action happens on entering attract mode.|
+|onAttract              |Action happens continuously while in attract mode.|
+|onAttractExit          |Action happens on exiting attract mode.|
 The action type can be combined with a menuIndex attribute. This will force RetroFE to only activate the animation for the specified menu index, with 0 being the main menu. Some examples:
@@ Line 310: / Line 330: @@
 | menuIndex="<2" | Activate the animation on menu index 0 and 1. |
 | menuIndex="i"  | Activate the animation when the index of the menu corresponds with the current menu index. This can only be used for animations for menu items. |
+RetroFE supports the following algorithms:
+^  action algorithms  ^^^^^
+|easeInquadratic |easeOutquadratic |easeInoutquadratic |easeIncubic |easeOutcubic|
+|easeInoutcubic |easeInquartic 	|easeOutquartic |easeInoutquartic |easeInquintic|
+|easeOutquintic |easeInoutquintic |easeInsine |easeOutsine |easeInoutsine|
+|easeInexponential |easeOutexponential 	|easeInoutexponential |easeIncircular |easeOutcircular|
+|easeInoutcircular |linear|
+Example:
+  <image src="bg.png" x="0" y="0" height="stretch" width="stretch" layer="0">
+    <onIdle>
+      <set duration="2">
+        <animate type="alpha" from="1" to="0.2" algorithm="easeinquadratic"/>
+      </set>
+      <set duration="1">
+        <animate type="alpha" from="0.2" to="1" algorithm="easeinquadratic"/>
+      </set>
+    </onIdle>
+  </image>
+\\
+=====Mode Attribute=====
+Several parameters allow for a mode attribute: system, common, layout, systemlayout, and commonlayout. This attribute can be omitted. This attribute has the following effects:
+Mode system and systemlayout use the information from the collection you're in rather than the selected item.
+Mode layout, systemlayout, and commonlayout use the art in the layouts/<layout name>/collections/<collection name>/ directory rather than collections/<collection name>/ directory.
+Mode common and commonlayout use the art in the collections/_common/medium_artwork directory rather than the collections/<collection name>/medium_artwork directory.
+The item path also depends on whether the selected item is a collection or a game; it will select the first found file.
+Example:
+You're in the Main collection, have the SNES collection selected, and are displaying a reloadableImage of type "logo":
+    No mode used:
+        collections/Main/medium_artwork/logo/SNES.png
+        collections/SNES/system_artwork/logo.png
+        collections/Main/medium_artwork/logo/default.png
+    Mode layout:
+        layouts/<layout name>/collections/Main/medium_artwork/logo/SNES.png
+        layouts/<layout name>/collections/SNES/system_artwork/logo.png
+        layouts/<layout name>/collections/Main/medium_artwork/logo/default.png
+    Mode system (not very useful in the main menu):
+        collections/Main/medium_artwork/logo/Main.png
+        collections/Main/system_artwork/logo.png
+        collections/Main/medium_artwork/logo/default.png
+    Mode systemlayout (not very useful in the main menu):
+        layouts/<layout name>/collections/Main/medium_artwork/logo/Main.png
+        layouts/<layout name>/collections/Main/system_artwork/logo.png
+        layouts/<layout name>/collections/Main/system_artwork/default.png
+    Mode common (not very useful for type logo):
+        collections/_common/medium_artwork/logo/SNES.png
+        collections/_common/medium_artwork/logo/default.png
+    Mode commonlayout (not very useful for type logo):
+        layouts/<layout name>/collections/_common/medium_artwork/logo/SNES.png
+        layouts/<layout name>/collections/_common/medium_artwork/logo/default.png
+Example:
+You're in the SNES collection, have the 1942 game selected, and are displaying a reloadableImage of type "logo":
+    No mode used:
+        collections/SNES/medium_artwork/logo/1942.png
+        collections/SNES/medium_artwork/logo/default.png
+    Mode layout:
+        layouts/<layout name>/collections/SNES/medium_artwork/logo/1942.png
+        layouts/<layout name>/collections/SNES/medium_artwork/logo/default.png
+    Mode system:
+        collections/SNES/system_artwork/logo.png
+    Mode systemlayout:
+        layouts/<layout name>/collections/SNES/system_artwork/logo.png
+    Mode common (not very useful for type logo):
+        collections/_common/medium_artwork/logo/1942.png
+        collections/_common/medium_artwork/logo/default.png
+    Mode commonlayout (not very useful for type logo):
+        layouts/<layout name>/collections/_common/medium_artwork/logo/1942.png
+        layouts/<layout name>/collections/_common/medium_artwork/logo/default.png
+Example:
+You're in the SNES collection by Nintendo, have the 1942 game by Capcom selected, and are displaying a reloadableImage of type "manufacturer":
+    No mode used:
+        collections/SNES/medium_artwork/manufacturer/Capcom.png
+        collections/SNES/medium_artwork/manufacturer/default.png
+    Mode layout:
+        layouts/<layout name>/collections/SNES/medium_artwork/manufacturer/Capcom.png
+        layouts/<layout name>/collections/SNES/medium_artwork/manufacturer/default.png
+    Mode system:
+        collections/SNES/system_artwork/Nintendo.png
+    Mode systemlayout:
+        layouts/<layout name>/collections/SNES/system_artwork/Nintendo.png
+    Mode common:
+        collections/_common/medium_artwork/manufacturer/Capcom.png
+        collections/_common/medium_artwork/manufacturer/default.png
+    Mode commonlayout:
+        layouts/<layout name>/collections/_common/medium_artwork/manufacturer/Capcom.png
+        layouts/<layout name>/collections/_common/medium_artwork/manufacturer/default.png

RetroFE Documentation

User Tools

Site Tools

Differences

Page Tools