# Text

## Text

![Icon](/files/-LacWAicVJp9-sotMJTR)

![Sequencer Grid](/files/-LbpzRQUrLhesBKgf8PY)

![](/files/-M878Rdxz7Lcu_Z2nUeA)

The Text effect enables up to 20 lines of text, all individually controlled to be displayed. The content of the text can be static, but can also include countdown timers. Adding a '\n' to the text will display the text following it on a new line.

**Option/Settings**

| Option/Settings  | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Text**         | Contains the text that is to be displayed for the line.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| **From File**    | Set Text to be displayed from a local file.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| **From Lyrics**  | Set Text to be displayed from a Lyric Track.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| **Font**         | Defines the font that is to be used for the text. Click on the attribute to open up a window where the type of font, style, size, color and other related attributes can be defined.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| **XL Font**      | Use an OS defined font or Select one of the xLights defined fonts. The xLights defined fonts are intended to match LOR SuperStar and may look better on models with lower pixel density.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| **Movement / C** | <p>Defines the direction of the movement of the line of text. One of several options are possible such as Left, Right, Down, None, etc.</p><p>If the box next to the Movement setting i.e. ‘C’ is checked, then the text will reach the center and stop.</p><p>When the Vector option is selected, the Start Position and End Position tabs at the bottom are used to adjust the motion. 0,0 is the middle position. It defaults to offsetting with the values being percentages of the model size but if you check the Offsets in Pixels box it becomes number of pixels.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| **Speed**        | Controls the speed at which the line of text moves.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| **Effect**       | Controls the layout of the line of text. The default is ‘Normal’, however other options to rotate the text at different angles are possible.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| **Count down**   | <p>Defines whether the line of text is to be used as a Countdown Timer. The default value is ‘None’ indicating that it is not a Countdown Timer effect.</p><p>For a count down effect, the following options are possible and count down will be based from the time the effect is rendered or finally saved and not from when it is executed in the sequence. The concept of the count down timer stems from New Year’s Eve countdown displays. If one knows exactly when the countdown will start, then setting this to an appropriate date/time is a non-issue.<br></p><p>The date/time must conform the the RFC822 standard format.</p><p>Properly formatted examples are:<br>Fri, 25 Dec 2015 00:00:00 +0100</p><p>Fri, 25 Dec 2015 00:00:00 EST</p><p>Fri, 25 Dec 2015 00:00:00 MST</p><p>Fri, 25 Dec 2015 00:00:00 -0800</p><p>\<b>\</b></p><p>These must be specified in the Text field without any quotes.<br><br>seconds</p><p>100</p><p>Will execute a 100 second countdown<br></p><p>In the following examples ‘+0100’ refers to your time +GMT hours. Change accordingly. Or you can use GMT, EST etc.</p><p>to date ‘d h m s’</p><p>Fri, 25 Dec 2015 00:00:00 +0100</p><p>Will display 33d 3h 38m 14</p><p>to date ‘h:m:s’</p><p>Fri, 25 Dec 2015 00:00:00 +0100</p><p>Will display 3h 38m 14 - the time is calculated to the next day in hours, mins, secs</p><p>to date ‘m’ or ‘s’</p><p>Fri, 25 Dec 2015 00:00:00 +0100</p><p>Will display 217m - the time is calculated to the next day in minutes</p><p>to date ‘s’</p><p>Fri, 25 Dec 2015 00:00:00 +0100</p><p>Will display 13011 - the time is calculated to the next day in seconds</p><p>!to date !%tofmt</p><p>!Fri, 25 Dec 2015 00:00:00 +0100!%D</p><p>Will display 133</p> |
| **Position**     | <p>This setting is used to adjust the initial position of the text. Either the vertical (Y) or the horizontal (X) position of the text is adjusted, depending on the value of the ‘Movement’ setting. For a value of ‘None’ or a horizontal movement such as Left / Right, adjusting the setting will move the initial position of the text vertically.<br></p><p>Only the first line of text can be controlled vertically and horizontally. The other lines have a horizontal control only.<br></p><p>You can however use multiple Layers each with one or more text lines if required.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |

{% hint style="success" %}
In order to stop the text after one cycle, use the "Vector" Movement option and define your vector motion. It will complete that motion in the duration of the effect. This option can also be used to stop text at a particular point on a matrix.
{% endhint %}

### Text Replace

Specific "Keys" can be used to insert Sequence Settings Values into the text effect. These "keys" will replaced with the values specified in the Sequence Settings.

![](/files/nCI4AfXj8nG7RPUGD9iF)![](/files/FzEd7eyoowmbRRFWVtqB)

<table><thead><tr><th>Replace Key</th><th>Sequence Settings Meta Data</th><th data-hidden></th><th data-hidden></th></tr></thead><tbody><tr><td>${TITLE} or ${SONG}</td><td>Song</td><td></td><td></td></tr><tr><td>${ARTIST}</td><td>Artist</td><td></td><td></td></tr><tr><td>${ALBUM}</td><td>Album</td><td></td><td></td></tr><tr><td>${FILENAME}</td><td>Media File Name</td><td></td><td></td></tr><tr><td>${AUTHOR}</td><td>Author</td><td></td><td></td></tr><tr><td>${AUTHOREMAIL}</td><td>Email</td><td></td><td></td></tr><tr><td>${COMMENT}</td><td>Comment</td><td></td><td></td></tr><tr><td>${URL}</td><td>Music URL</td><td></td><td></td></tr><tr><td>${WEBSITE}</td><td>Website</td><td></td><td></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://manual.xlights.org/xlights/effects/off/text.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
