INTRODUCTION

         On this page you'll find an introduction to using TinTin++. Additional
         information can be found in the individual help sections.

         Starting and Ending

         The syntax for starting TinTin++ is: ./tt++ [command file]

         Read more about the command file in the files section below. Remember
         one thing though. All actions, aliases, substitutions, etc, defined
         when starting up TinTin++ are inherited by all sessions.

         If you want to exit TinTin++ type '#end' or press ctrl-d on an empty
         line.

         For the WinTin++ users, if you want to paste text use shift-insert,
         text is automatically copied upon selection. This is typical Linux
         behavior, but it can take some getting used to.


         Basic features

         I'll start by explaining some of the very basic and important features:

         All TinTin++ commands starts with a '#'.

Example: #help -- #help is a client command, and isn't send to the server.

         All TinTin++ commands can be abbreviated when typed.

         #he -- Typing #he is the same as typing #help though it's suggested to
         use at least 3 letter abbreviations just in case another command is
         added that starts with 'he'.

         All commands can be separated with a ';'.

         n;l dragon;s;say Dan Dare is back! -- do these 4 commands
         There are 3 ways ';'s can be overruled.

         \say Hello ;) -- Lines starting with a '\' aren't parsed by TinTin++.
         say Hello \;) -- The escape character can escape 1 letter.
         #config verbatim on -- Everything is sent as is except '#' commands.

         Connecting to a server

Command: #session {session name} {server address} {port}

Example: #session someone tintin.sourceforge.net 4321

         You can have more than one session, in which case you can switch
         between sessions typing #<session name>.

         You can get a list of all sessions by typing: #session. The current
         active session is marked with (active). Snooped sessions with
         (snooped). MCCP sessions (compression) with (mccp 2) and (mccp 3).


         Split

Command: #split

         The split command will create a separated input and output area.

         Using the #prompt command you can capture the prompt and place it on
         the split line. To get rid of the split interface you can use #unsplit
         which will restore the terminal settings to default.


         Alias

Command: #alias {name} {commands}

         The syntax of the #alias command is almost like alias in csh.
         Use this command to define aliases. The variables %0, %1.. %9 contain
         the arguments to the aliased command as follows:
         the %0 variable contains all the arguments.
         the %1 variable contains the 1st argument
         ....
         the %9 variable contains the 9th argument

Example: #alias greet say Greetings, most honorable %1

         If you want an alias to execute more commands, you must use braces.

Example: #alias ws {wake;stand}

         To delete an alias use the #unalias command.

         WARNING! TinTin++ doesn't baby sit, and hence does not check for
         recursive aliases! You can avoid recursion by escaping the entire
         line.

Example: #alias put \put %1 in %2

         Or by using the send command.

Example: #alias put #send put %1 in %2


         Action

Command: #action {action-text} {commands}

         Use this command to define an action to take place when a particular
         text appears on your screen. There are 99 variables you can use as
         wildcards in the action-text.

         These variables are %1, %2, %3 .... %9, %10, %11 ... %97, %98, %99.

Example: #action {You are hungry} {get bread bag;eat bread}

Example: #action {%1 has arrived.} shake %1 -- shake hands with people arriving.

Example: #action {%1 tells you '%2'}
                   {tell bob %1 told me '%2'} -- forward tells.

Example: #action {tells you} #bell -- beep on tell.

         You can have TinTin++ ignore actions if you type '#ignore actions on'.

         You can see what commands TinTin++ executes when an action triggers
         by typing '#debug actions on'.

         You can remove actions with the #unaction command.


         Command files

         When you order TinTin++ to read a command file, it parses all the text
         in the file. You can use command files to keep aliases/actions in,
         login to a server (name, password etc..) and basically all kinds of
         commands.

         You can make the command files with either a text editor (suggested),
         or use the #write command to write out a file.

         Commands for files:

         #read filename -- read and execute the file.

         #write filename -- write all actions/aliases/substitutes/etc known for
         the current session to a file.

Example:
         #session x mymud.com 1234
         myname
         mypassword
         #split
         #action {^You are hungry.} {eat bread}

         If you save the above five lines to a file named 'mymud.tin' you can
         use 'tt++ mymud.tin' to start tintin and execute the file, connecting
         you to your mud, logging in, enabling split mode, and setting an action
         to eat a bread whenever you go hungry.

         Highlight

Command: #highlight {text} {color}

         This command works a bit like #action. The purpose of this command is
         to substitute text from the server with color you provide. This command
         is a simplified version of the #substitute command.

Example: #high {Snowy} {light yellow}

Example: #high {%*Snowy%*} {light yellow}

         Use #unhigh to delete highlights.


         Speedwalk

         If you type a command consisting ONLY of letters and numbers n, e, s,
         w, u, d - then this command can be interpreted as a serie of movement
         commands.

Example: ssw2n -- go south, south, west, north, north

         If you have problems with typing some commands that actually ONLY
         consists of these letters, then type them in CAPS. For example when
         checking the NEWS or when asked to enter NEW as your name.

         You must enable speedwalking with: #config speedwalk on.


         Ticker

Command: #ticker {name} {commands} {seconds}

         The name can be whatever you want it to be, and is only required for
         the unticker command. The commands will be executed every x amount of
         seconds, which is specified in the interval part.

Example: #tick {tick} {#delay 50 #show 10 SECONDS TO TICK!;#show TICK!!!} {60}

         This creates a ticker with the name {tick} which will print TICK!!!,
         as well as print a warning when the next tick will occure.

         You can remove tickers with #untick


         Repeating Commands

         You can repeat a command, the syntax is: #number command

Example: #5 cackle -- if you just killed bob the wizard.
Example: #10 {buy bread;put bread bag} -- repeat these 2 commands 10 times.
Example: #100 ooc w00t w00t!!!!! -- nochannel yourself.


         History

         TinTin++ has a limited subset of the csh history features.

         ! -- repeat the last command
         !cast -- repeat the last command starting with cast
         ctrl-r -- enter the reverse history search mode.


         Map commands

         TinTin++ has a powerful highly configurable automapper. Whenever
         you type n/ne/e/se/s/sw/w/nw/n/u/d tt++ tries to keep track of your
         movement.

         Commands for map:

         #map create -- create a map.
         #map goto 1 -- go to the first room in the map, created by default.
         #map map -- display the map.
         #map undo -- undo your last map alteration.
         #map write <filename> -- save the map to file.
         #map read <filename> -- load a map from file.

         There are many other map options and it's beyond the scope of this
         help section to explain everything there is to know, but I'll give
         a set of commands that will get most people started.

         #map create
         #split 12 1
         #map flag unicode on
         #map flag vt on
         #map goto 1

         These commands will create a 12 row vt100 split section at the top of
         your screen where a map drawn using unicode characters is displayed.

Example: #action {There is no exit in that direction.} {#map undo}

         The map will be automatically created as you move around.


         Help

Command: #help {subject}

         The help command is your friend and contains the same helpfiles
         inside TinTin++ as are available on the website. If you type #help
         without an argument you will see the various available help subjects
         which try to explain the TinTin++ commands and features in greater
         detail. Entries in cyan describe commands, while entries in white
         describe various features, often in greater detail.


         That's all for the introduction, enjoy

Related: characters, colors, coordinates, editing, escape_codes, greeting, keypad, lists, mapping, mathematics, screen_reader, sessionname, speedwalk, statements, suspend and time.