On 02/09/18, Richard said the following... Ri> is
there a spot where I can get the list of inbedded commands to use in
menus,and what they do ?Are you referring to
display_codes ? If so .. there is a /docs/ text.
-------------------------------------------------------------------------
Mystic Display CodesSection A.1 ------------------------------ -------------------------------------------[ Table of C
ontents ]Section DescriptionA.1 Using
Mystic Display CodesA.2 BBS and User Information Code
sA.3 Text Color MCI CodesA.4 Text Form
atting CodesA.5 Screen/Cursor Related Codes
A.6 Input Field Manipulation CodesA.7 Text Box Noti
fication CodesA.8 Miscelleanous Uncategorized Codes
A.9 Prompt Info CodesA.10 Screen Info Codes
-------------------------------------------------------------------------
A.1 USING Mystic DISPLAY CODES ----------------------------------- -------------------------------------- Mystic Disp
lay Codes are found throughout the BBS in various prompts
and display files. The purpose of these codes is to replace the code
with a corresponding value for that code. For example, if you wanted
to display the user's name, there is a code which when parsed in a
prompt or file would be replaced with the current logged in user name.
The format for all codes consists of a starting pipe character (|
) followed by two characters which are used to represent
what data Mystic will replace the code with. These codes
are CASE SENSITIVE although currently only uppercased le
tters are being used. An example of an MCI code an
d how it would be processed by Mystic would be:
Welcome the BBS, |UH. In the above example, |UH is the
MCI code for the user's handle. If the current user onl
ine had a account handle of "Joe User", then the result o
f the above example after being processed by Mystic would
be:Welcome to the BBS, Joe User.
Certain display codes require additional data to be provided after
the code. These types of codes are used to do many different things
from text formatting, to changing input fields, to saving/restoring
the remote user's screen, all the way through to popping up windows
and performaning various other BBS functions. Once aga
in it is important to note that all display codes are CASE
SENSITIVE! The following sections will cover all ty
pes of MCI codes used by Mystic BBS.
-------------------------------------------------------------------------
A.2 BBS and User Information Codes ------------------------------- ------------------------------------------ AG - Use
r's age in years AS - User's auto signature (On or Off)
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)
BI - User's birthdate in their selected date format BN - BBS na
me from System configuration CM - User's full screen node
chat setting (On or Off) CS - User's total number of calls
to the BBS CT - User's total number of calls to the BBS t
oday DA - Current date in the user's selected date format
DK - User's total downloads in kilobytes DL - User's total numb
er of downloaded files DT - User's total number of downloa
ds today FB - User's current file base name FG -
User's current file group name FK - User's total uploads i
n kilobytes FO - User's first call date in their selecte
d date format FT - Total number of files in current file b
ase (dynamic) FU - User's total number of files uploaded
HK - User's hotkey setting (On or Off) IL - User's node status invisibility (On or Off) KT - User's downloads in kilobyte
s today LO - User's last call date in their selected date
format MB - User's current message base name MD
- Menu description of the current menu (from menu flags) ME
- User's total number of e-mails sent MG - User's current
message group name ML - User's lightbar message index sett
ing (On or Off) MN - Network address of current message ba
se MP - User's total number of message posts MT
- Total number of messages in current message base (dynamic)
ND - Current node number NE - Minutes until next BBS-type ev
ent OS - Operating system (Windows, Linux, Raspberry Pi, e
tc) PC - User's current post to calls ratio PW -
Configured number of days before required password change
QA - User's selected archive format (QWK, etc) QE - User's
Generate QWKE setting (Yes or No) QL - User's Include QWK
file listing setting (Yes or No) RD - User's download rati
o for their current security level (files) RK - User's dow
nload ratio for their current security level (kilobytes) S
B - User's max allowed minutes in time bank for current security leve
l SC - User's max calls per day allowed for current securi
ty level SD - User's current security level description
SK - User's max allowed download kilobytes per day for current sec level
SL - User's current security level number SN - Configured Sysop
name SP - Configured post call ratio for the current secu
rity level ST - Configured allowed minutes per day for cur
rent security level SX - User's max allowed downloaded fil
es per day for current security level TB - User's timebank
minutes TC - Total number of calls to the BBS system
TE - User's terminal emulation (Ansi or Ascii) TI - Current tim
e of day in 12 hour format TL - User's time left in minute
s TO - User's time spent online this session (in minutes)
U# - User's number (aka permanent user index) U1 - User's optio
nal data answer for question #1 U2 - User's optional data
answer for question #1 U3 - User's optional data answer fo
r question #1 UA - User's address UB - User's fi
le listing type (Normal or Lightbar) UC - User's city, sta
te UD - User's data phone number UE - User's mes
sage editor type (Line, Full, or Ask) UF - User's Date inp
ut format (MM/DD/YY, DD/MM/YY, YY/DD/MM) UG - User's gende
r (Male or Female) UH - User's handle (alias) UI
- User's User information field UJ - User's message reader
type (Normal or Lightbar) UK - User's email address
UL - User's selected theme description UM - User's lightbar mes
sage index setting (On of Off) UN - User's real name
UP - User's Home phone number UQ - User's full screen editor qu
ote mode (Standard or Lightbar) US - User's screen size li
nes (ie 25) UX - User's computer/router/internet host name
UY - User's IP address UZ - User's zip (postal) code
VR - Mystic BBS version number XD - Days left before the use
r's account expires (or 0 if none) XS - Security level in
which the user's account will expire to -- ---------------------------------------------------------------------
-- A.3 COLOR CHANGING CODES (PIPE COLOR CODES) ---- ---------------------------------------------------------------------
The typical pipe format of <pipe>## where ## is one of the followi
ng: 00 : Sets the current foreground to Black
01 : Sets the current foreground to Dark Blue 02 : Sets the cur
rent foreground to Dark Green 03 : Sets the current foregr
ound to Dark Cyan 04 : Sets the current foreground to Dark
Red 05 : Sets the current foreground to Dark Magenta
06 : Sets the current foreground to Brown 07 : Sets the current
foreground to Grey 08 : Sets the current foreground to Da
rk Grey 09 : Sets the current foreground to Light Blue
10 : Sets the current foreground to Light Green 11 : Sets the c
urrent foreground to Light Cyan 12 : Sets the current fore
ground to Light Red 13 : Sets the current foreground to Li
ght Magenta 14 : Sets the current foreground to Yellow
15 : Sets the current foreground to White 16 : Sets the
current background to Black 17 : Sets the current backgrou
nd to Blue 18 : Sets the current background to Green
19 : Sets the current background to Cyan 20 : Sets the current
background to Red 21 : Sets the current background to Mage
nta 22 : Sets the current background to Brown 23
: Sets the current background to Grey Depending on
the terminal the 24-31 codes can have different results. Some
terminals will use iCE colors which are the non-blinking brighter
backgrounds. Others may use blinking text instead. T
ERMINALS THAT USE BRIGHT BACKGROUNDS (ICE COLORS): 2
4 : Sets the current background to Dark Grey 25 : Sets the
current background to Light Blue 26 : Sets the current bac
kground to Light Green 27 : Sets the current background to
Light Cyan 28 : Sets the current background to Light Red
29 : Sets the current background to Light Magenta 30 : Sets the
current background to light Yellow 31 : Sets the current
background to light White TERMINALS THAT USE BLINKI
NG: 24 : Sets the current background to black with
blinking foreground 25 : Sets the current background to bl
ue with blinking foreground 26 : Sets the current backgrou
nd to green with blinking foreground 27 : Sets the current
background to cyan with blinking foreground 28 : Sets the
current background to red with blinking foreground 29 : S
ets the current background to magenta with blinking foreground
30 : Sets the current background to brown with blinking foreground
31 : Sets the current background to grey with blinking foreground
T1 : Sets current color to theme's color #1 T2 : Sets current c
olor to theme's color #2 T3 : Sets current color to theme'
s color #3 T4 : Sets current color to theme's color #4
T5 : Sets current color to theme's color #5 T6 : Sets current c
olor to theme's color #6 T7 : Sets current color to theme'
s color #7 T8 : Sets current color to theme's color #8
T9 : Sets current color to theme's color #9 T0 : Sets current c
olor to theme's color #0 --------------------- ---------------------------------------------------- A.4 Te
xt Formatting Codes ----------------------------------------- -------------------------------- Text formatting co
des 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, and
must always be two characters. $C## - Centers the value
of the next display code with a width of ## $D##C - Dupli
cates character C ## times $L## - Left pad the next displ
ay code with spaces to ## characters $R## - Right pad the
next display code with spaces to ## characters $X##C - Du
plicate character C until column ## $c##C - Centers
the value of the next display with a width of ## using
character C $l##C - Left pad the next display code with ch
aracter <C> to ## characters $r##C - Right pad the next di
splay code with character <C> to ## chars Examples
(pay attention to the quotes):|UN translates to..
......: "User Name"|$R30|UN translates to...: "Us
er Name"30|UN translates to...: "User N
ame"|$L30|UN translates to...: "User Name"
30- translates to.....: "------------------------------"
|$X30- translates to.....: "------------------------------"
|UN|$X30. translates to..: "User Name....................."
30.|UN translates to...: ".........User Name..........."
|$r30.|UN translates to..: "User Name....................."
|$l30.|UN translates to..: ".....................User Name"
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. If you use $X30- on column 10, it will create 20 characters
so it is dependant on the current location of the cursor.
-------------------------------------------------------------------------
A.5 Screen/Cursor Related Codes ---------------------------------- --------------------------------------- Note: ## sh
ould be replaced by the number noted in the description, and
must always be two characters. For example, to move to column 1 on th
e current line you would send |[X01 [A##
- Move the cursor up ## lines [B## - Move the cursor down #
# lines [C## - Move the cursor forward (to the right) ## c
olumns [D## - Move the cursor backwards (to the left) ## c
olumns [K - Clear from the current cursor position to th
e end of the line [L - Move cursor and erase data backwa
rds from current column to column ## [X## - Move cursor to
X coordinate ## [Y## - Move cursor to Y coordinate ##
BS - Sends 1 destructive backspace sequence (ASCII 8-32-8) CL
- Clears the screen (ANSI 1,1 locate and [2J or ASCII 12)
CR - Send a carrage return and line feed (move to next line)
RA - Restore the saved text attribute color RS - Restore
the saved user's terminal screen SA - Save the current
text attribute color SS - Save the entire user's termina
l screen -------------------------------------------- ----------------------------- A.6 Input Field Manipulation
Codes ------------------------------------------------------ ------------------- Input field codes effect the ne
xt input field of its type, and are generally used in prom
pt strings that are send prior to asking the user for inpu
t. -N - Forces the next Yes/No prompt to default
to a No answer -Y - Forces the next Yes/No prompt to def
ault to a Yes answer IF - Turns off the input field back
ground color for the next inputprompt. IN## -
Sets the scrolling input field size for the next input prompt to
## characters. If the maximum size of the input field is larger
than this, Mystic will scroll the text inside so that it can
accept more characters without taking up more than ## on screen.
IS## - Limits the actual maximum number of characters allow for an
input prompt to ## characters. --------------- ---------------------------------------------------------- A
.7 Text Box Notification Codes ----------------------------- -------------------------------------------- Text Bo
x codes are used to pop up a quick notification box, using the
configured box type of the current theme for visuals. I
n addition to just displaying a box, Mystic is able to use its remote
screen imaging to save the space behind the box and restore it once the
box is closed, depending on the type of code used. This prevents any
corruption of the users screen regardless of what they are doing when
they receive the notification. User and BBS data MCI codes
, along with pipe color codes can be used within these boxe s.#B<header>#<notification>#Th
e #B code opens a notification box with a <header> and <notification>
string, following by an "OK" prompt for the user to press a key. After
the user pressed a key, Mystic will automatically restore the user's
original screen content that was overwritten by the box.
Example:|#BThis is a header#This is a test notific
ation box!##I<header>#<notification>#
This box is similar to the #B notification, except that it does n
otrestore the user's screen content after displaying, an
d it does notwait for the user to press a key. One use
for this might be duringa new message scan "Scanning" pr
ompt, for example. |#BNew Message Scan#Scanning:
...# --------------------------------- ---------------------------------------- A.8 Miscellaneous
Unsorted Codes --------------------------------------------- ---------------------------- AO - Used in display
files to disable aborting of the display file BE - Send
s a ^G character to the terminal (beep code on some terms)
DE - Delay for half a second PA - Send the pause prompt
and wait for a key to be pressed PB - Purge the current
input buffer PI - Display a pipe symbol (|) PN
- Wait for a key to be pressed without prompting PO -
Used in display files to disable pausing for that display file
QO - Replaced with a randomly generated Quote of the Day RP##
- Sets the internal screen pause line counter to ## XX -
Returns no value DF<file>| - Send display file <fil
Example: |DFmyansi| DI## - Sets the baud rate of
the current display file, using thefollowing scale:
00 - = No baud emulation01 - 09 = 300 baud
10 - 19 = 1200 baud20 - 29 = 2400 baud30 - 39
= 4800 baud40 - 49 = 9600 baud50 - 59 = 1
9200 baud60 - 69 = 28800 baud70 - 79 = 384
60 baud80 - 89 = 57600 baud90 - 99 = 11520
0 baud ---------------------------------------------- --------------------------- A.9 Prompt Info Codes - ---------------------------------------------------------------------
--- Prompt Info codes are used within the prompts f
ound in a theme's prompt file. The value of each prompt i
s dynamic, and changes depending on each specific prompt.
The prompt editor and the prompt file itself will have comments wh
ich show what each Prompt Info code's value means for that
prompt. For an example, lets look at prompt #334:
334 Jump to which message? (1-): In this prompt,
&1 is replaced by the current message number, and &2 is r
eplaced by the total number of messages in the base. These values
are noted in the comments for that particular prompt in both the editor
and the prompt file. Prompt Info codes currently range f
rom &0-&9, and from &A-&E --------------------------- ---------------------------------------------- A.10 Screen
Info Codes ------------------------------------------------- ------------------------ Note: These codes are slow
ly being depreciated because they're annoying to use. The
newer templates will have screen coordinates defined within
a .INI-like text file.
--- Mystic BBS v1.12 A38 2018/01/01 (Linux/64)
* Origin: flupH | fluph.darktech.org (21:1/105)