This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
layouts [2017/06/23 02:26] phulshof [Mode Attribute] |
layouts [2019/10/29 05:02] phulshof |
||
---|---|---|---|
Line 14: | Line 14: | ||
- | The global settings.conf file contains the default layout used by RetroFE. It is however possible to give a collection a completely different layout by adding the layout.xml and layout artwork to the /layouts/<layout name>/collections/<collection name>/layout/ directory. A splash.xml is not required/used for a collection's layout. This way you can give each collection a completely different look and feel. | + | The global settings.conf file contains the default layout used by RetroFE. It is however possible to give a collection a completely different layout by adding the layout.xml and layout artwork to the /layouts/<layout name>/collections/<collection name>/layout/ directory. A splash.xml is not required/used for a collection's layout. This way you can give each collection a completely different look and feel. |
+ | |||
+ | RetroFE will first search for a layout XML file that matches the screen ratio, so e.g. layout 16x9.xml or layout 4x3.xml. If that file is not found, it will default to layout.xml. | ||
\\ | \\ | ||
\\ | \\ | ||
Line 22: | Line 24: | ||
<layout> | <layout> | ||
- | <!-- Sound parameters --> | ||
<sound/> | <sound/> | ||
- | <!-- Menu structure --> | ||
<menu/> | <menu/> | ||
- | <!-- Video --> | ||
<video/> | <video/> | ||
- | <!-- Image --> | ||
<image/> | <image/> | ||
- | <!-- Text --> | ||
<text/> | <text/> | ||
- | <!-- Video connected to the selected item --> | ||
<reloadableVideo/> | <reloadableVideo/> | ||
- | <!-- Image connected to the selected item --> | ||
<reloadableImage/> | <reloadableImage/> | ||
- | <!-- Text connected to the selected item --> | ||
<reloadableText/> | <reloadableText/> | ||
- | <!-- Scrolling text connected to the selected item --> | ||
<reloadableScrollingText/> | <reloadableScrollingText/> | ||
</layout> | </layout> | ||
Line 120: | Line 113: | ||
\\ | \\ | ||
\\ | \\ | ||
- | |||
=====<image> Parameters===== | =====<image> Parameters===== | ||
Line 159: | Line 151: | ||
|mode |See mode attribute for more details.| | |mode |See mode attribute for more details.| | ||
|textFallback |Set to true to have text displayed of a the item title if an image cannot be loaded.| | |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). | + | |font |Location of the font (relative to the layout folder).| |
|fontColor |Default RGB color of the font (in hex, i.e. “6699AA”).| | |fontColor |Default RGB color of the font (in hex, i.e. “6699AA”).| | ||
|fontSize |Default font size of to display if not specified by a component.| | |fontSize |Default font size of to display if not specified by a component.| | ||
Line 172: | Line 164: | ||
\\ | \\ | ||
- | |||
=====<reloadableImage> Parameters===== | =====<reloadableImage> Parameters===== | ||
Line 214: | Line 205: | ||
\\ | \\ | ||
- | |||
=====<reloadableScrollingText> Parameters===== | =====<reloadableScrollingText> Parameters===== | ||
Line 271: | Line 261: | ||
|containerHeight|Height of the cropping container.| | |containerHeight|Height of the cropping container.| | ||
|layer|Layer on which the item should be displayed: 0 = back, 19 = front | | |layer|Layer on which the item should be displayed: 0 = back, 19 = front | | ||
+ | |menuScrollReload|Reload the art while the menu is scrolling when set to yes/true | | ||
RetroFE supports 20 layers of images (0-19) to allow items to overlap in a controlled fashion. | RetroFE supports 20 layers of images (0-19) to allow items to overlap in a controlled fashion. | ||
Line 306: | Line 297: | ||
|onGameEnter |Action happens on starting a game.| | |onGameEnter |Action happens on starting a game.| | ||
|onGameExit |Action happens on quitting a game.| | |onGameExit |Action happens on quitting a game.| | ||
+ | |onPlaylistEnter |Action happens on entering a playlist.| | ||
+ | |onPlaylistExit |Action happens on exiting a playlist.| | ||
+ | |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).| | ||
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: | 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 311: | Line 306: | ||
| menuIndex="0" | Activate the animation on the main menu. | | | menuIndex="0" | Activate the animation on the main menu. | | ||
| menuIndex="1" | Activate the animation on first submenu. | | | menuIndex="1" | Activate the animation on first submenu. | | ||
- | | menuIndex="!0" | Activate the animation on every index except for the main menu. | | + | | menuIndex="%%!%%0" | Activate the animation on every index except for the main menu. | |
| menuIndex=">1" | Activate the animation on menu index 2, 3, 4, ... | | | menuIndex=">1" | Activate the animation on menu index 2, 3, 4, ... | | ||
| menuIndex="<2" | Activate the animation on menu index 0 and 1. | | | 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. | | | 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: | RetroFE supports the following algorithms: | ||
Line 328: | Line 322: | ||
Example: | Example: | ||
- | <!-- Flaming background, slowly pulsating using transparency. --> | ||
<image src="bg.png" x="0" y="0" height="stretch" width="stretch" layer="0"> | <image src="bg.png" x="0" y="0" height="stretch" width="stretch" layer="0"> | ||
<onIdle> | <onIdle> | ||
Line 345: | Line 338: | ||
Several parameters allow for a mode attribute: system, common, layout, systemlayout, and commonlayout. This attribute can be omitted. This attribute has the following effects: | 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 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. | + | 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. | The item path also depends on whether the selected item is a collection or a game; it will select the first found file. | ||
Line 422: | Line 417: | ||
layouts/<layout name>/collections/_common/medium_artwork/manufacturer/Capcom.png | layouts/<layout name>/collections/_common/medium_artwork/manufacturer/Capcom.png | ||
layouts/<layout name>/collections/_common/medium_artwork/manufacturer/default.png | layouts/<layout name>/collections/_common/medium_artwork/manufacturer/default.png | ||
- | |||