From ec2cfdd87d7b64e9da368b7bef92090f6f9b8a93 Mon Sep 17 00:00:00 2001 From: Vanessa Dannenberg Date: Wed, 15 Aug 2018 18:02:08 -0400 Subject: [PATCH] update README to follow --- README.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 98bbfbd..48adfdc 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Simply place a panel, right-click it, and set a channel. Then send a character, a string, or one of several control words to that channel from a Mesecons Lua Controller and the mod will try to display it. The panels use the standard 7-bit ASCII character set (with a few alterations). -A single character will be displayed on the connected panel. +A single character will be displayed on the connected panel. A numeric message (i.e. not a string) will display the first digit on the connected panel. Strings will be displayed using all panels in a lineup, so long as they all face the same way, starting from the panel the Lua Controller is connected to, going left to right. The other panels in the line do not need to be connected to anything - think of them as being connected together internally. Only the panel at the far left need be connected to the Lua Controller. @@ -20,14 +20,23 @@ You can put multiple lines of panels end to end to form independent displays, so The string is padded with spaces and then trimmed to 64 characters. -Any unrecognized symbol or character outside the ASCII 32 - 129 range, whether part of a string or singularly is ignored, except as noted below. +Any unrecognized symbol or character, whether part of a string or singularly is ignored, except as noted below. + +This mod uses the full ISO-8859-1 character set (see https://en.wikipedia.org/wiki/ISO/IEC_8859-1 for details), plus a bunch of symbols stuffed into the empty 128-159 range that should be useful on a marquee: + +* 128,129: musical notes +* 130-140: box drawing glyphs +* 141-144: block shades +* 145-152: arrows +* 153-156: explosion/splat +* 157-159: smileys The panels also respond to these control messages: -* the words "off", "colon" and "period" translate to a blank space, ":", and ".", respectively. -* "del" or character code 127 displays a square with an X in it -* "allon" or character code 128 will turn on all LEDs on the panel. -* "cursor" or character code 129 will display a short, thick line at the bottom of the panel. +* the keywords "off", "colon" and "period" translate to a blank space, ":", and ".", respectively (they're leftover from the nixie tubes fork, but might be useful anyway) +* "del" is mapped to character #127, a square with an X in it. +* "allon" is mapped to character #144, the full/all-on block graphic. +* "cursor" or character code 31 will display a short, thick, flashing line at the bottom of the panel. * "off_multi" turns all panels in a lineup off * "allon_multi" turns on all LEDs of all panels in a lineup.