The <carousel> object describes the system list, the home screen of EmulationStation. It works in two modes: the classic logo carousel, and a text list enabled by textOnly.
| View | Name | Element |
|---|---|---|
system |
systemcarousel |
The system list |
This object cannot be created with extra="true".
| Property | Type | Purpose |
|---|---|---|
type |
String | Carousel scroll direction: horizontal, vertical or vertical_wheel. |
size |
Pair | Object size. |
pos |
Pair | Object position. See common properties. |
origin |
Pair | Point of the object that pos refers to. |
color |
Colour | Carousel background colour. |
fontPath |
Path | Font used by textOnly mode and by systems without a logo. |
fontSize |
Float | Font size, as a fraction of screen height. Used by textOnly mode and by systems without a logo. |
fontColor |
Colour | Fallback text colour of the classic carousel. |
logoScale |
Float | Scale factor applied to the selected logo. |
logoRotation |
Float | Logo rotation angle, in degrees. |
logoRotationOrigin |
Pair | Point the logos rotate around. |
logoSize |
Pair | Logo size inside the carousel. |
textOnly |
Boolean | Replaces the carousel with a text list of systems. |
forceUppercase |
Boolean | Displays system names in uppercase. textOnly mode only. |
logoAlignment |
String | Logo alignment inside the carousel. In textOnly mode, horizontal text alignment. |
maxLogoCount |
Float | Number of logos displayed at once. |
selectorColor |
Colour | Colour of the selector bar. textOnly mode only. |
selectedColor |
Colour | Colour of the selected system. textOnly mode only. |
primaryColor |
Colour | Colour of unselected systems on even rows. textOnly mode only. |
secondaryColor |
Colour | Colour of unselected systems on odd rows. textOnly mode only. |
selectorHeight |
Float | Height of the selector bar. 0 = one row height. textOnly mode only. |
selectorOffsetX |
Float | Horizontal offset of the selector bar. textOnly mode only. |
selectorOffsetY |
Float | Vertical offset of the selector bar. textOnly mode only. |
textOffsetX |
Float | Horizontal offset of the system names. textOnly mode only. |
lineSpacing |
Float | Row height, as a multiple of the font height. textOnly mode only. |
horizontalMargin |
Float | Left/right text inset. textOnly mode only. |
defaultTransition |
String | Forces the transition style between systems: instant, fade or slide. |
zIndex |
Float | Drawing order, from lowest to highest. |
<carousel name="systemcarousel"
type="horizontal" pos="0 0.38375" size="1 0.2325" origin="0 0"
color="FFFFFFD8" logoSize="0.25 0.155" logoScale="1.2" maxLogoCount="5"
logoAlignment="center" defaultTransition="slide" zIndex="40" />
This is the default mode. The type property sets the scroll direction:
| Value | Effect |
|---|---|
horizontal |
Logos scroll horizontally. Default value |
vertical |
Logos scroll vertically |
vertical_wheel |
Logos scroll vertically along an arc |
logoAlignment accepts top, bottom or center when type is horizontal, and left, right or center when type is vertical or vertical_wheel.
logoRotation and logoRotationOrigin only apply to the vertical_wheel mode.
Systems with no logo in the theme are displayed as text, using the fontPath / fontSize font and the fontColor colour.
With textOnly="true", the carousel is replaced by a vertical list of system names, rendered exactly like the game list: a selector bar behind the selected system, and distinct colours for selected and unselected entries.
The
textOnlymode is new in Recalbox 10.1.
The list fills the box defined by pos, size and origin. In this mode, type, logoSize, logoScale, logoRotation and maxLogoCount are ignored, and logoAlignment acts as the horizontal text alignment (left, right, center).
The following properties only serve this mode: primaryColor, secondaryColor, selectedColor, selectorColor, selectorHeight, selectorOffsetX, selectorOffsetY, lineSpacing, horizontalMargin, textOffsetX and forceUppercase.
<carousel name="systemcarousel" textOnly="true"
pos="0.05 0.15" size="0.4 0.7" origin="0 0"
color="00000000" fontPath="./art/Exo2-Bold.otf" fontSize="0.045" lineSpacing="1.6"
primaryColor="E6E6E6FF" secondaryColor="C6C6C6FF" selectedColor="FFFFFFFF"
selectorColor="FFFFFF33" selectorHeight="0" selectorOffsetX="0" selectorOffsetY="0"
logoAlignment="left" horizontalMargin="0.02" textOffsetX="0" forceUppercase="true" />
| Property | Default |
|---|---|
type |
horizontal |
pos |
0 0.38375 |
size |
1 0.2325 |
origin |
0 0 |
color |
FFFFFFD8 |
logoSize |
0.25 0.155 |
logoScale |
1.2 |
logoRotation |
7.5 |
logoRotationOrigin |
-5 0.5 |
logoAlignment |
center |
maxLogoCount |
3 |
zIndex |
40 |
textOnly |
false |
forceUppercase |
false |
fontColor |
E6E6E6FF |
primaryColor |
E6E6E6FF |
secondaryColor |
C6C6C6FF |
selectedColor |
FFFFFFFF |
selectorColor |
FFFFFF33 |
selectorHeight |
0 (one row height) |
selectorOffsetX, selectorOffsetY, textOffsetX, horizontalMargin |
0 |
lineSpacing |
1.5 |
defaultTransition forces the transition style between systems and greys out the matching menu option. Without this property, the user setting applies.