User Tools
layouts
Differences
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 [2018/06/20 14:33] phulshof [General Parameters] |
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 316: | 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 333: | 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 350: | 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 427: | 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 | ||
| - | |||
layouts.txt · Last modified: 2021/09/03 17:14 by phulshof
Page Tools
