displaycodes
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
displaycodes [2016/03/21 09:23] – g00r00 | displaycodes [2023/01/07 19:46] – [Screen/Cursor Related Codes] added LC + LF avon | ||
---|---|---|---|
Line 16: | Line 16: | ||
The additional data required for these types of codes will vary and will be documented specifically within the sections that follow. | The additional data required for these types of codes will vary and will be documented specifically within the sections that follow. | ||
+ | |||
+ | ====== Display Code Formatting ====== | ||
+ | |||
+ | Text formatting codes are most often used within the prompts file to create aligned lists of data, for things such as the user list or who's online, etc. These codes, like many other display codes, set up the circumstances in which the display code after it are displayed. | ||
+ | |||
+ | Note: ## should be replaced by the number noted in the description, | ||
+ | |||
+ | < | ||
+ | | ||
+ | $D##C - Duplicates character C ## times | ||
+ | | ||
+ | | ||
+ | | ||
+ | $X##C - Duplicate character C until column ## | ||
+ | $c##C - Centers the value of the next display with a width of ## using | ||
+ | | ||
+ | $l##C - Left pad the next display code with character <C> to ## characters | ||
+ | $r##C - Right pad the next display code with character <C> to ## chars | ||
+ | | ||
+ | </ | ||
+ | |||
+ | Examples: | ||
+ | |||
+ | < | ||
+ | |UN translates to........: "User Name" | ||
+ | |||
+ | |$R30|UN translates to...: "User Name " | ||
+ | |$C30|UN translates to...: " | ||
+ | |$L30|UN translates to...: " | ||
+ | |||
+ | |$D30- translates to.....: " | ||
+ | |$X30- translates to.....: " | ||
+ | |||
+ | |UN|$X30. translates to..: "User Name....................." | ||
+ | |||
+ | |$c30.|UN translates to...: " | ||
+ | |$r30.|UN translates to..: "User Name....................." | ||
+ | |$l30.|UN translates to..: " | ||
+ | </ | ||
+ | |||
+ | The difference between $D and $X is that D duplicates a set number of characters, while $X duplicates that character until a certain column is reached. | ||
+ | |||
====== BBS and User Information Codes ====== | ====== BBS and User Information Codes ====== | ||
Line 22: | Line 64: | ||
AV - User's chat availability for user to user chat (Yes or No) | AV - User's chat availability for user to user chat (Yes or No) | ||
BD - User's baud rate (returns TELNET or LOCAL) (may be removed) | BD - User's baud rate (returns TELNET or LOCAL) (may be removed) | ||
- | BI - User' | + | BI - User' |
+ | BL - BBS location as set in System Configuration | ||
BN - BBS name from System configuration | BN - BBS name from System configuration | ||
CM - User's full screen node chat setting (On or Off) | CM - User's full screen node chat setting (On or Off) | ||
Line 30: | Line 73: | ||
DK - User's total downloads in kilobytes | DK - User's total downloads in kilobytes | ||
DL - User's total number of downloaded files | DL - User's total number of downloaded files | ||
+ | DP - User's default protocol or blank if one is not set | ||
DT - User's total number of downloads today | DT - User's total number of downloads today | ||
FB - User's current file base name | FB - User's current file base name | ||
+ | FDxx Returns the flag description where xx defines the set and the flag. | ||
+ | For example FD1A would return the description for flag set 1, flag A. | ||
FG - User's current file group name | FG - User's current file group name | ||
FK - User's total uploads in kilobytes | FK - User's total uploads in kilobytes | ||
+ | FLxx Returns the ON/OFF prompt depending on the user flag state. The xx | ||
+ | defines the set and the flag, for example: FL1A would return on/off | ||
+ | state of the user's A flag in flag set 1. | ||
FO - User's first call date in their selected date format | FO - User's first call date in their selected date format | ||
+ | FS - User's file group (short name) | ||
FT - Total number of files in current file base (dynamic) | FT - Total number of files in current file base (dynamic) | ||
FU - User's total number of files uploaded | FU - User's total number of files uploaded | ||
Line 44: | Line 94: | ||
MD - Menu description of the current menu (from menu flags) | MD - Menu description of the current menu (from menu flags) | ||
ME - User's total number of e-mails sent | ME - User's total number of e-mails sent | ||
+ | MF - Shows number of draft messages saved for the current user | ||
MG - User's current message group name | MG - User's current message group name | ||
ML - User's lightbar message index setting (On or Off) | ML - User's lightbar message index setting (On or Off) | ||
- | MN - Network | + | MN - Network |
MP - User's total number of message posts | MP - User's total number of message posts | ||
+ | MS - User's message group (short name) | ||
MT - Total number of messages in current message base (dynamic) | MT - Total number of messages in current message base (dynamic) | ||
+ | MU - Total unread personal messages * | ||
+ | MW - Total personal messages * | ||
+ | NA - number of active users currently logged in | ||
ND - Current node number | ND - Current node number | ||
NE - Minutes until next BBS-type event | NE - Minutes until next BBS-type event | ||
+ | NT - maximum number of allowed nodes/ | ||
OS - Operating system (Windows, Linux, Raspberry Pi, etc) | OS - Operating system (Windows, Linux, Raspberry Pi, etc) | ||
PC - User's current post to calls ratio | PC - User's current post to calls ratio | ||
Line 69: | Line 125: | ||
SX - User's max allowed downloaded files per day for current security level | SX - User's max allowed downloaded files per day for current security level | ||
TB - User's timebank minutes | TB - User's timebank minutes | ||
- | TC - Total number of calls to the BBS system | + | TC - Total number of calls to the BBS system |
TE - User's terminal emulation (Ansi or Ascii) | TE - User's terminal emulation (Ansi or Ascii) | ||
TI - Current time of day in 12 hour format | TI - Current time of day in 12 hour format | ||
TL - User's time left in minutes | TL - User's time left in minutes | ||
TO - User's time spent online this session (in minutes) | TO - User's time spent online this session (in minutes) | ||
+ | TM - Displays current time in HH:MM 24-hour format | ||
+ | TS - Displays current time in HH:MM:SS 24-hour format | ||
U# - User's number (aka permanent user index) | U# - User's number (aka permanent user index) | ||
U1 - User's optional data answer for question #1 | U1 - User's optional data answer for question #1 | ||
- | U2 - User's optional data answer for question #1 | + | U2 - User's optional data answer for question #2 |
- | U3 - User's optional data answer for question #1 | + | U3 - User's optional data answer for question #3 |
UA - User's address | UA - User's address | ||
UB - User's file listing type (Normal or Lightbar) | UB - User's file listing type (Normal or Lightbar) | ||
Line 92: | Line 150: | ||
UM - User's lightbar message index setting (On of Off) | UM - User's lightbar message index setting (On of Off) | ||
UN - User's real name | UN - User's real name | ||
+ | UO - User's country of origin (as detected by IP/Country blocking) | ||
UP - User's Home phone number | UP - User's Home phone number | ||
UQ - User's full screen editor quote mode (Standard or Lightbar) | UQ - User's full screen editor quote mode (Standard or Lightbar) | ||
Line 101: | Line 160: | ||
XD - Days left before the user's account expires (or 0 if none) | XD - Days left before the user's account expires (or 0 if none) | ||
XS - Security level in which the user's account will expire to | XS - Security level in which the user's account will expire to | ||
+ | |||
+ | * The MW/MU code values are only populated after the MC menu command is executed. | ||
====== Color Codes (Pipe Colors) ====== | ====== Color Codes (Pipe Colors) ====== | ||
Line 179: | Line 240: | ||
Note: ## should be replaced by the number noted in the description, | Note: ## should be replaced by the number noted in the description, | ||
+ | | ||
+ | | ||
[A## - Move the cursor up ## lines | [A## - Move the cursor up ## lines | ||
[B## - Move the cursor down ## lines | [B## - Move the cursor down ## lines | ||
Line 188: | Line 251: | ||
[Y## - Move cursor to Y coordinate ## | [Y## - Move cursor to Y coordinate ## | ||
| | ||
+ | | ||
| | ||
+ | | ||
| | ||
+ | | ||
+ | | ||
+ | | ||
| | ||
| | ||
| | ||
- | | + | |
+ | |||
+ | Each theme can optionally have a font type defined for it. When a theme | ||
+ | font type is defined, Mystic will swap to that font when the theme is | ||
+ | loaded (support depends on the terminal used). | ||
+ | that can be used for font manipulation: | ||
+ | |||
+ | SF## - Set the current terminal font where ## is: | ||
+ | |||
+ | 01 - Default | ||
+ | 02 - IBM CP437 > Switch to IBM CP437 font | ||
+ | 03 - Topaz > Switch to Amiga Topaz | ||
+ | 04 - Topaz+ | ||
+ | 05 - MicroKnight | ||
+ | 06 - MicroKnight+ > Switch to Amiga MicroKnight+ | ||
+ | 07 - mo' | ||
+ | 08 - p0t NOoDLE | ||
+ | |||
+ | TF - Resets terminal font to theme' | ||
====== Input Field Manipulation Codes ====== | ====== Input Field Manipulation Codes ====== | ||
Line 202: | Line 288: | ||
| | ||
| | ||
+ | | ||
| | ||
prompt. | prompt. | ||
Line 213: | Line 300: | ||
</ | </ | ||
- | ====== Text Box Codes ====== | + | ====== Text Box / Pick List Codes ====== |
- | Text Box codes are used to pop up a quick notification box, using the configured ANSI box style which is configured in each theme. | + | Text Box codes are used to pop up a quick notification box, using the configured ANSI box style which is configured in each theme. Pick lists create a horizontal or vertical list of options that are presented to the user to select via hotkey or lightbars. |
In addition to just displaying a box, Mystic is able to use its remote screen imaging to save what the user's screen looks like before displaying the box, and then restore the user's screen after the box is closed. | In addition to just displaying a box, Mystic is able to use its remote screen imaging to save what the user's screen looks like before displaying the box, and then restore the user's screen after the box is closed. | ||
Line 221: | Line 308: | ||
User and BBS data MCI codes, along with pipe color codes can be used within these boxes! | User and BBS data MCI codes, along with pipe color codes can be used within these boxes! | ||
- | **# | + | **#B< |
+ | The #B code opens a < | ||
+ | |||
+ | Example: | ||
< | < | ||
- | | + | |#B#1#12#This is a header#This is a test notification box!# |
- | | + | </code> |
- | the user pressed a key, Mystic will automatically restore the user' | + | |
- | | + | |
- | | + | **# |
+ | |||
+ | Create a horizontal menu with an optional description line below it | ||
+ | similar to the " | ||
+ | similar to what might be found in Searchlight BBS. | ||
+ | |||
+ | The < | ||
+ | of the selection. | ||
+ | the item is selected. | ||
+ | assigned to a selection and represents the color of the description text. | ||
+ | |||
+ | As with other places where an attribute number is defined the value can | ||
+ | be calculated be the following formulate FG + (BG * 16) so FG color of white | ||
+ | (16) or a blue (1) background would be 15 + (1 * 16) which is 31. | ||
+ | |||
+ | < | ||
+ | key-text where key is the hotkey and text is what is lightbar selectable. | ||
+ | |||
+ | A horizontal lightbar menu with two light bar options would look like this: | ||
+ | |||
+ | < | ||
+ | |||
+ | The above would create a horizontal lightbar menu with two options called | ||
+ | " | ||
+ | a hotkey of B. The text would be attribute 7 (grey) and the highlighted | ||
+ | text would be white on blue background (attr 31). The third field would | ||
+ | not be used because there is no description defined for any of the options | ||
+ | and the fourth option is says to default to the second option (Option B) | ||
+ | when opening the menu. | ||
+ | |||
+ | Descriptions can be applied to each option by putting those values in | ||
+ | brackets in the item name. The description will be displayed on the line | ||
+ | under the lightbar menu: | ||
+ | |||
+ | < | ||
+ | |||
+ | Pipe color codes can be used in the option names and will be rendered as | ||
+ | expected when the item is not highlighted. | ||
- | |#BThis is a header#This is a test notification | + | **#I#< |
+ | |||
+ | This box is similar to the #B notification, except that it does not restore the user's screen content after displaying, and it does not wait for the user to press a key. One use for this might be during a new message scan " | ||
+ | |||
+ | Example: | ||
+ | < | ||
+ | | ||
</ | </ | ||
- | **#I< | + | **#V#< |
+ | |||
+ | Performs a pop up vertical selection box, with the selected item hotkey being pushed into the input buffer, and the screen restored to its original state after selection. | ||
+ | |||
+ | Syntax: |# | ||
+ | |||
+ | < | ||
+ | |||
+ | Example: | ||
+ | |||
+ | |# | ||
+ | |||
+ | Creates a pop up lightbar box in style 2, starting at X30 Y10 that has three options: | ||
< | < | ||
- | This box is similar to the #B notification, | + | |
- | | + | |
- | wait for the user to press a key. One use for this might be during | + | |
- | a new message scan " | + | | C Selection C |
- | | + | `-----------------' |
- | Example: | + | |
- | + | ||
- | |#INew Message Scan# | + | |
</ | </ | ||
+ | When an item is selected, Mystic sets the color to black on black and pushes the hotkey into the input buffer, so that the prompt it replaced gets the input key. | ||
+ | |||
+ | |||
+ | **# | ||
+ | |||
+ | Draws a box using a specific theme style. | ||
+ | < | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | </ | ||
+ | **# | ||
+ | |||
+ | Performs a popup Yes/No box and the result will be used as the following YES/NO answer. | ||
+ | |||
+ | < | ||
+ | Syntax: | ||
+ | Example: |# | ||
+ | </ | ||
+ | |||
+ | The above example will pop up a Y/N box using style 2 with a header of " | ||
+ | |||
+ | After the YES/NO box, Mystic will restore the screen to the original state before the box was shown. | ||
+ | |||
+ | |||
+ | ====== Miscellaneous Codes ====== | ||
+ | |||
+ | This section contains codes that are the special snowflakes of Mystic BBS! They do not fit well into any of the other categories of codes, so they find a home here. While they may be different, it does not mean that they' | ||
+ | |||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | HXxx - Sends a hex byte. For example ASCII 254 is FE in hex so HXFE would send | ||
+ | out ASCII 254. | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | RP## - Sets the internal screen pause line counter to ## | ||
+ | | ||
+ | |||
+ | | ||
+ | used if there is any text to be parsed after the DF code is encountered. | ||
+ | | ||
+ | |||
+ | DI## - Sets the baud rate emulation of the current display file, using the | ||
+ | following scale: | ||
+ | | ||
+ | 00 = No baud emulation (full speed) | ||
+ | 01 - 09 = 300 baud | ||
+ | 10 - 19 = 1200 baud | ||
+ | 20 - 29 = 2400 baud | ||
+ | 30 - 39 = 4800 baud | ||
+ | 40 - 49 = 9600 baud | ||
+ | 50 - 59 = 19200 baud | ||
+ | 60 - 69 = 28800 baud | ||
+ | 70 - 79 = 38460 baud | ||
+ | 80 - 89 = 57600 baud | ||
+ | 90 - 99 = 115200 baud | ||
+ | |||
+ | QO - Replaced with a randomly generated Quote of the Day | ||
+ | |||
+ | | ||
+ | | ||
+ | | ||
+ | |||
+ | * | ||
+ | This is sample Mystic BBS quote #1. | ||
+ | This is also quote #1 | ||
+ | * | ||
+ | This is sample Mystic BBS quote #2. | ||
+ | * | ||
+ | This is sample Mystic BBS quote #3. | ||
====== Prompt Information Codes ====== | ====== Prompt Information Codes ====== | ||
- | Prompt Information codes are used within the prompts found in a theme' | + | Prompt Information codes are used within the prompts found in a theme' |
- | The prompt editor and the prompt file itself will have comments that show what each Prompt Info code's value means for that particular prompt. | + | The prompt editor and the prompt file itself will have comments that show what each code translates to for that particular prompt. |
+ | ; &1 = Current message number | ||
334 Jump to which message? (1-|& | 334 Jump to which message? (1-|& | ||
- | In this prompt, &1 is replaced by the current message number, and &2 is replaced by the total number of messages in the message base. These values are noted in the comments for that particular prompt in both the prompt editor and the text-based prompt file itself. | + | In this prompt, |
Prompt Information codes can range from |& | Prompt Information codes can range from |& | ||
+ | |||
+ | ====== Screen Info Codes (Depreciated) ====== | ||
+ | |||
+ | Screen Info codes follow the format of |!# where # is a number between 0 and 9. These codes are found in the old style of ANSI templates used within various "full screen ANSI" functions of Mystic BBS, and they are used to define screen location and attributes used within that specific function. | ||
+ | |||
+ | These codes are not going to be documented here, as they have been depreciated. | ||
+ | |||
+ | In other words they are still used in the old-style templates but moving forward they will no longer be used in any new functions added into Mystic BBS. |
displaycodes.txt · Last modified: 2024/02/29 23:26 by avon