diff --git a/docs/help.html b/docs/help.html index 923a478..019c65c 100644 --- a/docs/help.html +++ b/docs/help.html @@ -15,27 +15,28 @@ a:active {color:#b06}
- ACTION ALIAS ALL BELL BREAK
- BUFFER BUTTON CASE CAT CHARACTERS
- CHAT CLASS COLORS COMMANDS COORDINATES
- CONFIG CONTINUE CR CURSOR DAEMON
- DEBUG DEFAULT DELAY DRAW ECHO
- EDIT EDITING ELSE ELSEIF END
- ESCAPE CODES EVENT FOREACH FORMAT FUNCTION
- GAG GREETING GREP HELP HIGHLIGHT
- HISTORY IF IGNORE INDEX INFO
- KEYPAD KILL LINE LIST LISTS
- LOCAL LOG LOOP MACRO MAP
- MAPPING MATH MATHEMATICS MESSAGE METRIC SYSTEM
- MOUSE MSDP MSLP NOP PARSE
- PATH PATHDIR PCRE PORT PROMPT
- READ REGEXP REPEAT REPLACE RETURN
- RUN SCAN SCREEN SCREEN READER SCRIPT
- SEND SESSION SESSIONNAME SHOWME SNOOP
- SPEEDWALK SPLIT SSL STATEMENTS SUBSTITUTE
- SUBSTITUTIONS SUSPEND SWITCH SYSTEM TAB
- TEXTIN TICKER TIME VARIABLE WHILE
- WRITE ZAP
+ ACTION DEFAULT IGNORE MSLP SHOWME
+ ALIAS DELAY INDEX NOP SNOOP
+ ALL DRAW INTRODUCTION PARSE SPEEDWALK
+ BELL ECHO INFO PATH SPLIT
+ BREAK EDIT KEYPAD PATHDIR SSL
+ BUFFER EDITING KILL PCRE STATEMENTS
+ BUTTON ELSE LINE PORT SUBSTITUTE
+ CASE ELSEIF LIST PROMPT SUBSTITUTIONS
+ CAT END LISTS READ SUSPEND
+ CHARACTERS ESCAPE CODES LOCAL REGEXP SWITCH
+ CHAT EVENT LOG REPEAT SYSTEM
+ CLASS FOREACH LOOP REPLACE TAB
+ COLORS FORMAT MACRO RETURN TEXTIN
+ COMMANDS FUNCTION MAP RUN TICKER
+ COORDINATES GAG MAPPING SCAN TIME
+ CONFIG GREETING MATH SCREEN VARIABLE
+ CONTINUE GREP MATHEMATICS SCREEN READER WHILE
+ CR HELP MESSAGE SCRIPT WRITE
+ CURSOR HIGHLIGHT METRIC SYSTEM SEND ZAP
+ DAEMON HISTORY MOUSE SESSION
+ DEBUG IF MSDP SESSIONNAME
+
@@ -393,7 +394,7 @@ a:active {color:#b06}
\ An input line starting with a backslash is sent verbatim if you are
connected to a server. This character can be configured with
- #config, and is itself send verbatim when the verbatim config mode
+ #config, and is itself sent verbatim when the verbatim config mode
is enabled.
Related: colors, escape, function, mathematics, pcre and variable.
@@ -1196,36 +1197,35 @@ Related: port
MOUSE EVENTS
- DOUBLE-CLICKED <MOUSE> %0 row %1 col %2 -row %3 -col %4 word %5 line
- LONG-CLICKED <MOUSE> %0 row %1 col %2 -row %3 -col %4 word %5 line
- MOVED <MOUSE> %0 row %1 col %2 -row %3 -col %4 word %5 line
- PRESSED <MOUSE> %0 row %1 col %2 -row %3 -col %4 word %5 line
- SHORT-CLICKED <MOUSE> %0 row %1 col %2 -row %3 -col %4 word %5 line
- RELEASED <MOUSE> %0 row %1 col %2 -row %3 -col %4 word %5 line
- SCROLLED <MOUSE> %0 row %1 col %2 -row %3 -col %4 word %5 line
- TRIPLE-CLICKED <MOUSE> %0 row %1 col %2 -row %3 -col %4 word %5 line
+ DOUBLE-CLICKED <MOUSE> %0 row %1 col %2 -row %3 -col %4 word %5 line
+ LONG-CLICKED <MOUSE> %0 row %1 col %2 -row %3 -col %4 word %5 line
+ MOVED <MOUSE> %0 row %1 col %2 -row %3 -col %4 word %5 line
+ PRESSED <MOUSE> %0 row %1 col %2 -row %3 -col %4 word %5 line
+ SHORT-CLICKED <MOUSE> %0 row %1 col %2 -row %3 -col %4 word %5 line
+ RELEASED <MOUSE> %0 row %1 col %2 -row %3 -col %4 word %5 line
+ SCROLLED <MOUSE> %0 row %1 col %2 -row %3 -col %4 word %5 line
+ TRIPLE-CLICKED <MOUSE> %0 row %1 col %2 -row %3 -col %4 word %5 line
MAP <MOUSE EVENT>
Mouse events can be prefixed with MAP to only trigger when the mouse
event occurs inside the VT100 map region.
-
SWIPED [DIR]
%0 dir %1 button %2 row %3 col %4 -row %5 -col
%6 row %7 col %8 -row %9 -col %10 rows %11 cols
OUTPUT EVENTS
- BUFFER UPDATE, DISPLAY UPDATE
+ BUFFER UPDATE, DISPLAY UPDATE
These events have no additional arguments.
- RECEIVED LINE %0 raw text %1 plain text
- RECEIVED OUTPUT %0 raw text
- RECEIVED PROMPT %0 raw text %1 plain text
+ RECEIVED LINE %0 raw text %1 plain text
+ RECEIVED OUTPUT %0 raw text
+ RECEIVED PROMPT %0 raw text %1 plain text
PORT EVENTS
- CHAT MESSAGE, PORT MESSAGE
+ CHAT MESSAGE, PORT MESSAGE
%0 raw text %1 plain text
PORT CONNECTION %0 name %1 ip %2 port
@@ -1235,67 +1235,66 @@ Related: port
SCAN EVENTS
- SCAN CSV HEADER %0 all args %1 arg1 %2 arg2 .. %99 arg99
- SCAN CSV LINE %0 all args %1 arg1 %2 arg3 .. %99 arg99
- SCAN TSV HEADER %0 all args %1 arg1 %2 arg3 .. %99 arg99
- SCAN TSV LINE %0 all args %1 arg1 %2 arg3 .. %99 arg99
+ SCAN CSV HEADER %0 all args %1 arg1 %2 arg2 .. %99 arg99
+ SCAN CSV LINE %0 all args %1 arg1 %2 arg3 .. %99 arg99
+ SCAN TSV HEADER %0 all args %1 arg1 %2 arg3 .. %99 arg99
+ SCAN TSV LINE %0 all args %1 arg1 %2 arg3 .. %99 arg99
SCREEN EVENTS
- SCREEN FOCUS
- %0 focus (0 or 1)
-
- SCREEN LOCATION %0 rows %1 cols %2 height %3 width
+ SCREEN DIMENSIONS %0 height %1 width
+ SCREEN FOCUS %0 focus (0 or 1)
+ SCREEN LOCATION %0 rows %1 cols %2 height %3 width
SCREEN MOUSE LOCATION
%0 row %1 col %2 -row %3 -col %4 pix row %5 pix col
%6 -pix row %7 -pix col %8 location
- SCREEN RESIZE %0 rows %1 cols %2 height %3 width
- SCREEN SPLIT %0 top row %1 top col %2 bot row %3 bot col
- SCREEN UNSPLIT %0 top row %1 top col %2 bot row %3 bot col
+ SCREEN RESIZE %0 rows %1 cols %2 height %3 width
+ SCREEN SIZE %0 rows %1 cols
+ SCREEN SPLIT %0 top row %1 top col %2 bot row %3 bot col
+ SCREEN UNSPLIT %0 top row %1 top col %2 bot row %3 bot col
SESSION EVENTS
- SESSION ACTIVATED %0 name
- SESSION CONNECTED %0 name %1 host %2 ip %3 port %4 file
- SESSION CREATED %0 name %1 host %2 ip %3 port %4 file
- SESSION DEACTIVATED %0 name
- SESSION DISCONNECTED %0 name %1 host %2 ip %3 port
- SESSION TIMED OUT %0 name %1 host %2 ip %3 port
-
+ SESSION ACTIVATED %0 name
+ SESSION CONNECTED %0 name %1 host %2 ip %3 port %4 file
+ SESSION CREATED %0 name %1 host %2 ip %3 port %4 file
+ SESSION DEACTIVATED %0 name
+ SESSION DISCONNECTED %0 name %1 host %2 ip %3 port
+ SESSION TIMED OUT %0 name %1 host %2 ip %3 port
SYSTEM EVENTS
- DAEMON ATTACH TIMEOUT %0 file %1 pid
- DAEMON ATTACHED %0 file %1 pid
- DAEMON DETACHED %0 file %1 pid
- PROGRAM START %0 startup arguments
- PROGRAM TERMINATION %0 goodbye message
+ DAEMON ATTACH TIMEOUT %0 file %1 pid
+ DAEMON ATTACHED %0 file %1 pid
+ DAEMON DETACHED %0 file %1 pid
+ PROGRAM START %0 startup arguments
+ PROGRAM TERMINATION %0 goodbye message
- READ ERROR %0 filename %1 error message
- READ FILE %0 filename
- WRITE ERROR %0 filename %1 error message
- WRITE FILE %0 filename
+ READ ERROR %0 filename %1 error message
+ READ FILE %0 filename
+ WRITE ERROR %0 filename %1 error message
+ WRITE FILE %0 filename
- SYSTEM CRASH %0 message
- SYSTEM ERROR %0 name %1 system msg %2 error %3 error msg
- UNKNOWN COMMAND %0 raw text
- SIGUSR %0 signal
+ SYSTEM CRASH %0 message
+ SYSTEM ERROR %0 name %1 system msg %2 error %3 error msg
+ UNKNOWN COMMAND %0 raw text
+ SIGUSR %0 signal
TELNET EVENTS
IAC <EVENT>
IAC TELNET events are made visible using #config telnet info.
- IAC SB GMCP %0 module %1 data %2 plain data
- IAC SB GMCP <MODULE> %1 data %2 plain data
- IAC SB MSSP %0 variable %1 data
- IAC SB MSDP %0 variable %1 data %2 plain data
- IAC SB MSDP [VAR] %0 variable %1 data %2 plain data
- IAC SB NEW-ENVIRON %0 variable %1 data %2 plain data
- IAC SB ZMP <VAR> %0 variable %1 data
- IAC SB <VAR> %0 variable %1 raw data %2 plain data
+ IAC SB GMCP %0 module %1 data %2 plain data
+ IAC SB GMCP <MODULE> %1 data %2 plain data
+ IAC SB MSSP %0 variable %1 data
+ IAC SB MSDP %0 variable %1 data %2 plain data
+ IAC SB MSDP [VAR] %0 variable %1 data %2 plain data
+ IAC SB NEW-ENVIRON %0 variable %1 data %2 plain data
+ IAC SB ZMP <VAR> %0 variable %1 data
+ IAC SB <VAR> %0 variable %1 raw data %2 plain data
TIME EVENTS
@@ -1307,12 +1306,12 @@ Related: port
VARIABLE EVENTS
- VARIABLE UPDATE <VAR> %0 name %1 new value %2 path
- VARIABLE UPDATED <VAR> %0 name %1 new value %2 path
+ VARIABLE UPDATE <VAR> %0 name %1 new value %2 path
+ VARIABLE UPDATED <VAR> %0 name %1 new value %2 path
VT100 EVENTS
- VT100 SCROLL REGION %0 top row %1 bot row %2 rows %3 cols %4 wrap
+ VT100 SCROLL REGION %0 top row %1 bot row %2 rows %3 cols %4 wrap
To see all events trigger use #info event on. Since this can get
rather spammy it's possible to gag event info messages.
@@ -1614,6 +1613,43 @@ Related: port
INDEX
+ ████████┐██████┐███┐ ██┐████████┐██████┐███┐ ██┐
+ └──██┌──┘└─██┌─┘████┐ ██│└──██┌──┘└─██┌─┘████┐ ██│
+ ██│ ██│ ██┌██┐ ██│ ██│ ██│ ██┌██┐ ██│
+ ██│ ██│ ██│└██┐██│ ██│ ██│ ██│└██┐██│
+ ██│ ██████┐██│ └████│ ██│ ██████┐██│ └████│
+ └─┘ └─────┘└─┘ └───┘ └─┘ └─────┘└─┘ └───┘
+ ██┐ ██┐
+ ██│ ██│
+ ████████┐████████┐
+ └──██┌──┘└──██┌──┘
+ ██│ ██│
+ └─┘ └─┘
+
+ (T)he K(I)cki(N) (T)ickin D(I)kumud Clie(N)t
+
+
+ What is TinTin++?
+
+ TinTin++ is a client program specialized to help playing muds. This is
+ a souped up version of TINTIN III with many new features.
+
+ Giving Credit Where Credit is Due
+
+ None of this work would be possible, without the work done by Peter
+ Unold. He was the author of TINTIN III, the base of TinTin++. Hats off
+ to ya Peter. You started the ball rolling.
+
+ Introduction
+
+ If you're new to TinTin++ a good place to start is the introduction,
+ which should be linked below.
+
+Related: introduction
+
+
+ INTRODUCTION
+
On this page you'll find an introduction to using TinTin++. Additional
information can be found in the individual help sections.
@@ -3592,6 +3628,10 @@ Example: #action {~\e[1;37m%1} {#var roomname %1}
#prompt will write to the default split line, which is one row above
the input line, typically at row -2.
+ If the row number is set to 0, #prompt will behave like #substitute.
+ This is useful to let tintin know that a prompt was received so you
+ can use #config packet_patch with minimal interference.
+
The col number is optional and can be used to set the column index.
A positive col number draws the given number of columns from the left,
while a negative col number draws from the right. If you leave the
@@ -3639,6 +3679,10 @@ Example: #action {~\e[1;37m%1} {#var roomname %1}
Variables are stored in &1 to &99 with &0 holding the matched
substring.
+ The #regex command is not a proper statement like #if, when using
+ #return or #break in the {true} argument it won't terminate any loop
+ the #regex command is nested within.
+
^ force match of start of line.
$ force match of end of line.
\ escape one character.
@@ -3663,7 +3707,7 @@ Example: #action {~\e[1;37m%1} {#var roomname %1}
%a match zero to any number of characters including newlines.
%A match zero to any number of newlines.
- %c match zero to any number of color codes.
+ %c match zero to any number of ansi color codes.
%p match zero to any number of printable characters.
%P match zero to any number of non printable characters.
%u match zero to any number of unicode characters.
@@ -4132,6 +4176,9 @@ easiest way to accomplish that.
columns will be used for the scrolling region, leaving a right bar
with a width of 20 columns.
+ To avoid displaying problems it's suggesed to use #prompt to capture
+ the prompt sent by the MUD.
+
Comment: You can display text on the split line(s) with the #prompt and
#show {line} {row} commands.
@@ -4404,7 +4451,7 @@ Related: all, Related: echo, event and format.
diff --git a/docs/tutorial.html b/docs/tutorial.html
index 17cd34e..7e31ea8 100644
--- a/docs/tutorial.html
+++ b/docs/tutorial.html
@@ -15,13 +15,12 @@ a:active {color:#b06}
- CHARACTERS COLORS COORDINATES EDITING
- ESCAPE CODES GREETING INDEX INTRODUCTION
- KEYPAD LISTS MAPPING MATHEMATICS
- METRIC SYSTEM MOUSE MSDP MSLP
- PCRE REPEAT SCREEN READER SESSIONNAME
- SPEEDWALK STATEMENTS SUBSTITUTIONS SUSPEND
- TIME
+ INDEX EDITING MAPPING MSLP SPEEDWALK
+ INTRODUCTION ESCAPE CODES MATHEMATICS PCRE STATEMENTS
+ CHARACTERS GREETING METRIC SYSTEM REPEAT SUBSTITUTIONS
+ COLORS KEYPAD MOUSE SCREEN READER SUSPEND
+ COORDINATES LISTS MSDP SESSIONNAME TIME
+
@@ -41,7 +40,7 @@ a:active {color:#b06}
██│ ██│
└─┘ └─┘
- (T)he K(I)cki(N) (T)ick D(I)kumud Clie(N)t
+ (T)he K(I)cki(N) (T)ickin D(I)kumud Clie(N)t
What is TinTin++?