1
0
mirror of https://github.com/mt-mods/led_marquee.git synced 2024-11-14 05:40:22 +01:00

update README accordingly

This commit is contained in:
Vanessa Dannenberg 2018-08-20 20:34:36 -04:00
parent 3ba2dbd1bd
commit 87ebd877b8

View File

@ -59,7 +59,7 @@ During a scroll event, the printed string is padded with spaces (one in auto mod
If you need vertical scrolling, you will have to handle that yourself (since the size of a screen/wall is not hard-coded).
A byte value of 0 to 27 in a string will change colors (i.e. string.char(0 to 27) ).
To change colors, put a "/" followed by a digit or a letter from "A" to "R" (or "a" to "r") into your printed string. Digits 0 to 9 trigger colors 0 to 9 (obviously :-) ), while A/a through R/r set colors 10 to 27. Any other sequence is invalid and will just be printed literally. Two slashes "//" will translated to a single char(30) internally, and displayed as a single slash (doing it that way makes the code easier).
Color values 0 to 11 are:
@ -71,9 +71,9 @@ Colors 24 - 27 are white, light grey, medium grey, and dim grey (or think of the
The last color that was used is stored in the left-most/upper-left "master" panel's metadata, and defaults to red. It should persist across reboots.
A byte value of 28 in a string will act as a line feed (I would have used 10, but that's a color code :-P )
char(10) will do its job as linefeed/newline.
A byte value of 29 in a string signals a cursor position command. The next two byte values select a column and row, respectively. The next character after the row byte will be printed there, and the rest of the string then continues printing from that spot onward with normal line wrapping, colors and so forth. Note that any string that does NOT contain cursor positioning commands will automatically start printing at the upper-left.
char(29) signals a cursor position command. The next two byte values select a column and row, respectively. The next character after the row byte will be printed there, and the rest of the string then continues printing from that spot onward with normal line wrapping, colors and so forth. Note that any string that does NOT contain cursor positioning commands will automatically start printing at the upper-left.
Any number of color, line feed, and cursor position commands may be present in a string, making it possible to "frame-buffer" a screen full of text into a string before printing it.