home *** CD-ROM | disk | FTP | other *** search
/ Sunny 1,000 Collection / SUNNY1000.iso / Files / W31 / Misc / WINTIN10.ZIP / TINTIN.DOC < prev    next >
Encoding:
Text File  |  1995-08-30  |  14.0 KB  |  328 lines

  1. This document was written by Peter Unold. I (john l. miller) have included                                
  2. it in the WinTin release for those who don't already know how to use TinTin.
  3. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -   
  4.                                 
  5.                                 T I N T I N
  6.                                    I I I
  7.                  (T)he K(I)cki(N) (T)ick D(I)kumud Clie(N)t
  8.  
  9. This is version 3.0 of TINTIN. Lotsa stuff has been changed since the last
  10. release. New features have been added. But TINTIN is still a small, fast
  11. client special designed to help dikumud-players in their slaughtering.
  12.  
  13. ======================================Me==================================
  14. You can email me at: pjunold@daimi.aau.dk
  15. Feel free to mail if you discover any bugs, have any probs with the prog or 
  16. have suggestions for any new(and useful) tintin-commands then lemmie hear.
  17.  
  18. ===============================Compiling TINTIN===========================
  19. Before compiling you might wanna change some of the default values for your
  20. tintin setup. Look at the top of the file called 'tintin.h' for more info.
  21.  
  22. I assume you have placed all the files in a directory. Then you type
  23. 'make'. After a moment there'll be a new file in the directory - 'tintin'.
  24. OK if you the program compiled without any problems, then go to next section
  25. and read on.
  26.  
  27. Oh no! TINTIN didn't compile at first try. No worry - there's lots of 
  28. informations in the makefile. Editing this file should get you going.
  29. If you know nothing about c- and unix-programming, then ask someone at your
  30. site who does. TINTIN III is really not a complicated program, and you 
  31. properly just have to comment or uncomment a few flags in the makefile. 
  32. If no one at your site can help, then feel free to gimmie a mail.
  33.  
  34. ========================Starting and ending TINTIN========================
  35. The syntax for starting tintin is: tintin [commandfile]
  36. Read more about the commandfile in the 'files' section below. Remember one
  37. thing though. ALL ACTIONS, ALIASES AND SUBSTITUTIONS DEFINED WHEN STARTING
  38. UP TINTIN, ARE INHERITED BY ALL SESSIONS.
  39.  
  40. If you wanna get out of tintin after starting it type: #end
  41.  
  42. =================================Basic features===========================
  43. I'll start by explaining some of the very basic and important features:
  44.  
  45. All TINTIN commands starts with a '#'. (can be changed with #char though)
  46. Example:
  47. #help         <=#help is a command directed to the client and not the mud.
  48.  
  49. All TINTIN commands can be abrevated when typed.
  50. Example:
  51. #he           <=typing #he is the same as typing #help
  52.  
  53. All commands can be seperated with a ';'.
  54. Example:
  55. n;l green;s;say Dan Dare is back!    <=do these 4 commands
  56.  
  57. There are 2 ways the command-split-at-';'s can be overruled. 
  58. 1) typing '\;' on a line will be translated to a single ';'
  59. Example:
  60. say Hello \;)      <=say Hello ;)
  61.  
  62. 2) ';'s inside a "<---->" sentence will be parsed as normal ';'s
  63. Example:
  64. say "hello ;) How's going?" <=say hello ;) How's going.
  65.  
  66. The last method is important when for example having an alias to execute
  67. more commands. More on that later.
  68.  
  69. ===================Connecting to a mud - the #session command==============
  70. Command: session [[sessionname] mud-address]
  71. Usage: #session 
  72.  
  73. This is the command you use to connect to the muds. The session that  
  74. you startup will become the active session. That is, all commands you
  75. type, will be send to this session.
  76.  
  77. Here's a small example to get you started: 
  78. It shows how I log into austin diku with 2 chars and play a bit with them.
  79.  
  80. %tintin                                   <=startup tintin
  81. #session snowy austin.daimi.aau.dk 4000   <=define a session named 'snowy',
  82. <<usual login stuff>>                       and connect to austin diku
  83. #session zork austin.daimi.aau.dk 4000    <=define a new session name 'zork'
  84. <<usual login stuff>                        and connect to austin diku
  85.  
  86. When I type commands now, they are send to the char I loged in with.
  87. I can change the active char, by typing #sessionname
  88.  
  89. #snowy                                     <=make the char in the 'snowy'
  90.                                              session the active one.
  91.  
  92. When I type commands now, they are send to the 'snowy' char.
  93.  
  94. If I wanna send a command to a session that isn't active, without having 
  95. the trouble to activate it, I can type #sessionname command
  96. #zork say anybody here wanna die???    <=the 'zork' char will say this
  97. #zork "puke mayor;kill mayor"          <=and do this..
  98.  
  99. If I wanna see the text that a session recives without switching to it, I can
  100. type: #snoop sessionname. Remove the snoop by typing #snoop sessioname again.
  101. #snoop zork                                <=snoop the zork session
  102. #snoop zork                                <=unsnoop zork session
  103.  
  104. If I want all sessions to recieve same command I type: #all command
  105. #all shout dikuMUD at 300mph or DON'T dikuMUD!  
  106.  
  107. You can get a list of all session by typing: #session. The current active 
  108. session is marked with (active). Snooped sessions with (snooped).
  109.  
  110. ====================================Alias==================================
  111. Command: alias
  112. Usage: #alias [aliased-command] [unaliases-command(s)]
  113.  
  114. The syntax of the #alias command is almost like alias in csh.
  115. Use this command to define aliases. The variables &0, &1.. &9 contains
  116. the arguments to the aliases-command as follows:
  117. the &0 variable contains ALL the arguments.
  118. the &1 variable contains the 1. argument
  119. ....
  120. the &9 variable contains the 9. argument
  121.  
  122. Example: #alias nice say Hello Mr &1
  123.  
  124. typing: > nice Ole Bole 
  125. then &0 =Ole Bole
  126.      &1 =Ole
  127.      &2 =Bole
  128. Thus the alias would be evaluated to: say Hullo Mr Ole
  129.  
  130. If there're no variables on the right-side of the alias definition, any
  131. arguments following the aliases-command will be appended to the unaliases-
  132. command. 
  133. Example:
  134. #alias ff cast 'fireball'
  135. >ff mayor
  136. evaluates to: cast 'fireball' mayor
  137.  
  138. If you want an alias to execute more commands, you must use "s:
  139.  
  140. #alias ws "wake;stand"    <=remember the ';'s inside "s don't end the argument.
  141.  
  142. Other examples:
  143. #alias eb "get bread bag;eat bread"       <=define alias
  144. #alias eb                                 <=show alias
  145. #alias                                    <=list all aliases
  146. #alias put pu &1 in &2                    <=for dikuII maybe...
  147.  
  148. To delete an alias use the #unalias command.
  149. #unalias eb                               <=delete the eb alias.
  150.  
  151. WARNING! TINTIN III doesn't check for recursive aliases! That is surpose you type
  152. something like: #alias yo yo
  153. and then do a: yo
  154. then TINTIN goes into an endless loop.. #&*^@$&*^@$*^&@$#&*
  155.  
  156.  ====================================Action================================
  157. Command: action
  158. Usage: #action [action-text] [action-command(s)]
  159.  
  160. Use this command to define an action to take place when a particular text
  161. appears on your screen. There're 10 variables you can use as wildcards in
  162. the action-text. These variables are &0, &1, &2....&9. 
  163.  
  164. Examples: 
  165.  
  166. #action BLEEDING recite recall                    <=recall when you get that 
  167.                                                     nasty BLEEDING text.
  168.  
  169. #action "are hungry" "get bread bag;eat bread"    <=auto-eat
  170.  
  171. #action "&0 has arrived." shake &0                <=shake hands with people
  172.                                                     that arrives.
  173.                    
  174. #action "&0 says '&1'" "say &0 said &1"           <=repeat all says.
  175.  
  176. #action "tells you" #bell                         <=beep when you gets a tell
  177.  
  178. #action                                           <=show actions
  179. #action ws                                        <=show action
  180. #unaction ws                                      <=delete action
  181.  
  182. You can have tintin ignore the actions if you type '#ignore'. Turn the 
  183. ignoring off by typing '#ignore' again.
  184.  
  185. You can see what commands TINTIN executes when an action triggers,
  186. by typing '#echo'. Turn this feature off by typing '#echo' again.
  187.  
  188. ===============================Substitutes================================
  189. Command: #substitute     (remember you can abrevate commands....)
  190. Usage: #substitute [text] [substitute text]
  191.  
  192. This command works a bit like #action. The purpose of this command is to
  193. substitute text from the mud with some text you provide. You can think of 
  194. this command, as a kind of extended gag-command. 
  195.  
  196. Examples:
  197. Suppose you want all the occurences of the word 'Snowy' to be substituted
  198. with 'The King'. Then you'll type: 
  199. #subs &0Snowy&1 &0The King&1
  200.  
  201. Now suppose the mud sends you the line: Snowy har arrived.
  202. Then your substitution would get triggered and the variables would contain:
  203. &0 =nothing (there wasn't anything in front of the word 'Snowy')
  204. &1 = has arrived.
  205. Substituted into the line is then:
  206. The King has arrived.
  207.  
  208. There IS in fact a serious purpose for this command. People using a setup like:
  209. Home<--------SLOW modem------->School<------FAST modem------------>mud site
  210. complain that they keep loosing their link, when the mud sends to much text too
  211. fast(as in fights on grimne-diku for example). The problem is that their own 
  212. modem is too slow for the transfer. People like that can use the #sub command
  213. to reduce the amount of data transfered.
  214.  
  215. Example: (grimne diku)
  216.  
  217. #sub &0POWERMAD&1    &0PM&1
  218. #sub &0Black&1       &0B&1
  219. #sub &0obliterates&1 &0obr&1
  220.  
  221. if the diku sends the line: Black obliterates POWERMAD.
  222. you'd see: B obr PM.
  223. If you didn't want to see anything from the lines with Black you'd do a:
  224. #sub Black .          (i never liked this dot syntax...)
  225. and you''ll never see the lines.
  226.  
  227. Use #unsub to delete substitutions.
  228.  
  229. ================================Speedwalk===================================
  230. If you type a command consisting ONLY of letters n, e, s, w, u, d - then 
  231. this command will be interpreted as a serie of directions you wanna go.
  232. Example: >sswn
  233. go south, south, west, north
  234.  
  235. IF who have problems with typing some commands that actually ONLY consists
  236. of these words, then type'em in CAPS.
  237.  
  238. Example: (can you make up more examples than this? Gnort told me this one...)
  239. NEWS
  240.  
  241. If you don't like this speedwalk feature at all, then you can toggle it on/off
  242. with #speedwalk.
  243.  
  244. ===================================Ticker===================================
  245. Every 75 seconds on a standard dikumud a so called tick occures. You 
  246. regenerate faster hp/mana/mp if you`re sleeping/resting during a tick. So it's 
  247. pretty nice to know when the next tick occures. TINTIN helps you with that. 
  248. When you turn the ticker on in a session, you'll get warnings just before a 
  249. tick occures. The real ticklenght isn't 100% stable. So you have to set the 
  250. syncronize the ticker now and then. Use #tickset for that.
  251.  
  252. commands for ticker:
  253. #tickon              <=turns the ticker on in a session
  254. #tickoff             <=turns the ticker off in a session
  255. #tick                <=shows #seconds to next tick
  256. #tickset             <=reset the ticker
  257. #ticksize            <=set lenght of ticks. The ticklenght is not 75secs on
  258.                        some modified dikumuds.
  259.  
  260. Here's some useful aliases/actions related to the ticker:
  261.  
  262. #alias ? #tick
  263. #action "are hungry" "#tickset;say HA! my tickcounter is now perfectly set!"
  264.  
  265. NOTICE the #ticksay. #ticktell etc. commands from v2.0 has been removed. You
  266. can find an example of how to implement these commands with aliases in the
  267. coms file.
  268.  
  269. ===============================Commando files===============================
  270. When you order TINTIN to read a commandofile, TINTIN parse all the text in
  271. the file. You can use comandofiles to keep aliases/actions in, login to a 
  272. mud(name, password etc..) and basically all kinds of commands(unlike v2.0).
  273. You can make the commandofiles with either a texteditor, or use the 
  274. #writecoms commando to write out a file.
  275.  
  276. commands for files:
  277. #read filename            <=read and execute the file.
  278.  
  279. #write filename           <=write all actions/aliases/substitutes known for 
  280.                             current session to a file.
  281.  
  282. #writesession filename    <=write all actions/aliases/substitutes known for
  283.                             current session BUT not enherited to a file.
  284.  
  285. =============================Repeating commands============================
  286. You can repeat a command/commandline. The syntax is: #number command
  287.  
  288. examples:
  289. #5 cackle
  290. #10 "buy bread;put bread bag"        <=buy 10 breads and fill'em into a bag
  291. #1000 shout assholes!!!!!            <=noshout yourself.
  292.  
  293. ===================================History================================
  294. TINTIN has a limited subset of the csh history features. 
  295. #history          <=show the last 15 commands
  296. ! or !!           <=repeats the last command
  297. !5                <=execute 5. last command
  298. !cast             <=execute the last command in list starting with `cast`
  299.  
  300. =============================Path commands================================
  301. TINTIN tries to keep track of your movement. That is whenever you type
  302. either north/south/east/west/up/down, TINTIN will push the direction into
  303. a queue(the path). 
  304.  
  305. commands for path:
  306. #mark            <=mark beginning of path(ie reset queue)
  307. #path            <=show the path
  308. #return          <=go one step back in the path
  309. #unpath          <=forget last move in the path
  310. #action "Alas, you cannot go that way..." #unpath
  311.  
  312. real life example.. tatataaaa:
  313. You want a fast run to the master mindflayer and back. You go to dump
  314. and type: #mark. Then you run down and kill the master. To go back you
  315. just type: #30 #return
  316. You could ofcoz just as well have recalled outta there, but... Hell it's just
  317. an example.
  318.  
  319. ==============================Other commands===============================
  320. #boss                     <=fill screen with serious looking stuff
  321. #char new-char            <=change the tintin-char. The tintin-char is the 
  322.                             char infront of all tintin-commands.
  323. #help                     <= ...
  324. #nop                      <=for comments in coms-files
  325. #system unix-command      <=execute a unix-command
  326. #z                        <=cut link to current session. A faaaaast way out
  327.  
  328.