The <text> object displays text: a label, a metadata value, or your own text driven by variables.
| View | Name | Element |
|---|---|---|
system |
systemInfo |
The system information line (game count, favourites, hidden games) |
detailed |
logoText |
The system name, shown when logo has no image |
detailed |
md_lbl_rating, md_lbl_releasedate, md_lbl_developer, md_lbl_publisher, md_lbl_genre, md_lbl_players, md_lbl_lastplayed, md_lbl_playcount, md_lbl_favorite |
The metadata labels |
detailed |
md_players, md_playcount, md_favorite |
The metadata values rendered as plain text |
detailed |
md_description |
The game description |
detailed |
md_folder_name |
The name displayed with a folder's thumbnails |
gameclip |
logoText |
The system name |
gameclip |
md_lbl_gameName, md_lbl_systemName, md_lbl_rating, md_lbl_releasedate, md_lbl_developer, md_lbl_publisher, md_lbl_genre, md_lbl_players, md_lbl_lastplayed, md_lbl_playcount, md_lbl_favorite |
The metadata labels |
gameclip |
md_description |
The game description |
For any other text, pick your own name and add extra="true".
Each metadata value has a mandatory object type.
md_developer,md_publisher,md_genreandmd_releasedateare<scrolltext>,md_ratingis a<rating>andmd_lastplayedis a<datetime>. Declaring them as<text>does not work.
| Property | Type | Purpose |
|---|---|---|
pos |
Pair | Object position. See common properties. |
size |
Pair | Size of the text block. See below. |
origin |
Pair | Point of the object that pos refers to. |
rotation |
Float | Rotation angle in degrees, clockwise when positive. |
rotationOrigin |
Pair | Point the rotation happens around. Defaults to 0.5 0.5. |
text |
String | Text to display. Accepts ${...} variables. |
path |
Path | Path of a text file to load, instead of typing the text in text. |
backgroundColor |
Colour | Text background colour. |
fontPath |
Path | TrueType or OpenType font to use. |
fontSize |
Float | Font size, as a fraction of screen height. |
fontStyle |
String | Font style: bold, italic or bolditalic. The engine simply looks for the letter b (bold) and the letter i (italic) inside the value. |
color |
Colour | Colour applied to the object. |
alignment |
String | Horizontal alignment: left, center or right. center also centres vertically. |
forceUppercase |
Boolean | Displays text in uppercase. |
lineSpacing |
Float | Line spacing, as a multiple of the font height. Defaults to 1.5. |
multiline |
Boolean | Allows the text to wrap over several lines. |
zIndex |
Float | Drawing order, from lowest to highest. |
disabled |
Boolean | Hides the object entirely. |
<text name="md_lbl_developer, md_lbl_publisher, md_lbl_genre" color="48474D" fontSize="0.028" />
<text name="systemTitle" extra="true" text="${system}" pos="0.5 0.08" origin="0.5 0.5"
alignment="center" fontSize="0.06" forceUppercase="true" color="FFFFFFFF" zIndex="12" />
size behaves differently depending on the values:
| Value | Behaviour |
|---|---|
0 0 |
The block fits the text automatically, on a single line |
w 0 |
The text wraps so it does not exceed width w, the height adjusts |
w h |
A true "text box". If h is lower than or equal to fontSize, overflowing text is truncated with an ellipsis |