home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 25 / amigaformatcd25.iso / websites / f1_gp / ftp / splittime.lha / SplitTime.doc < prev   
Text File  |  1997-08-05  |  15KB  |  367 lines
  1.  
  2.                            SplitTime v1.7
  3.  
  4.                                  by
  5.  
  6.                               Rene Smit
  7.  
  8.                              August 1997
  9.  
  10.  
  11. This document describes SplitTime, a public domain utility which gives you
  12. three split times during your laps in World Circuit/Formula One Grandprix.
  13.  
  14. If you have any comments, buglists or suggestions feel free to mail me at
  15.   rsdi@xs4all.nl
  16.  
  17. My home page is located at
  18.   http://www.xs4all.nl/~rsdi/
  19.  
  20.  
  21.  
  22. Disclaimer
  23. ----------
  24. I hereby state that I am not responsible for any damage or loss of
  25. data, whether or not caused by using either SplitTime or PrintSplits.
  26.  
  27.  
  28.  
  29. Distribution
  30. ------------
  31. You may copy SplitTime to everyone as long as you copy the original
  32. lha file containing the following files:
  33.  
  34. - SplitTime        (c) 1995-97 Rene Smit
  35. - SplitTime.doc
  36. - PrintSplits        (c) 1995    Rene Smit
  37. - libs/f1gp.library    (c) 1995-97 Oliver Roberts
  38.  
  39. The f1gp.library was made by Oliver Roberts. The version of the library
  40. included here is 35.2.
  41.  
  42.  
  43.  
  44. What's new?
  45. -----------
  46. Fixed in v1.7:
  47. - Fixed an Enforcer hit. SplitTime would unhook from f1gp even after you
  48.   quit f1gp, which could result in a crash.
  49. Added in v1.6:
  50. - Command line options to specify the position of the indicator light.
  51. Added in v1.5:
  52. - Should now really work with all versions of F1GP, and with kickstart 1.3.
  53.  
  54. Version 1.3 is a special "F1GP Accessoires disk" version, released in
  55. December 1995. Version 1.4 is the same except for some minor changes,
  56. like a friendlier way of sending signals, which are not noticable by the
  57. user.
  58.  
  59. Added in v1.3/v1.4:
  60. - Autosave option.
  61. - Safer way of displaying split times.
  62. - Added split times in race.
  63. - Changed the virtual lap time row to a virtual times column.
  64. - Added a light on the dashboard that indicates if a split is improved.
  65.  
  66.  
  67. What is SplitTime?
  68. ------------------
  69. SplitTime is a utility that displays split times at every quarter of a
  70. track while you drive F1GP (so you need that game to use it). Not only
  71. the splittimes are displayed, but also the best splittimes before they
  72. show up (like on TV). Note that I use 3 split times on every track and
  73. that they are exactly at 25%, 50% and 75%, while on TV they now use
  74. only 2 split times (intermediates) at specific points on the track.
  75.  
  76.  
  77. Why do I need it?
  78. -----------------
  79. This utility let's you know how well you're on your way while driving a
  80. lap, so you don't have to drive the whole lap before knowing if you drove
  81. well. Normally, you have your own physical markers and locations at which
  82. you look at the timer to know how fast you're on your way, but now you can
  83. forget those and use these very accurate splittimes instead. If you finish
  84. a lap and forget the split times you drove, don't worry, they can be
  85. viewed in the SplitTime window, as well as some other info.
  86.  
  87.  
  88. Is this all?
  89. ------------
  90. No, this is not all. Besides showing (best) splittimes it also keeps track
  91. of the best split differences, calculated by looking at the time between
  92. two consecutive splittimes. The four best differences are always remembered
  93. and from these, virtual split times are calculated, which means that you are
  94. able to see what time you could have driven if you had done a perfect lap.
  95.  
  96. All times can be saved to disk so nothing will be lost. This means that
  97. once you have improved a splittime you will see it on your display from
  98. then on every time you are gonna play f1gp again. The car number is saved
  99. with each split difference, so if more people are driving with the same
  100. datafile and they use different car numbers, you can see to whom each split
  101. difference belongs. Also, the lap in which it was driven is stored so you
  102. can see in which lap you drive a certain part best and determine how you
  103. can best warm up your tyres. Note that f1gp does not reset the lap number
  104. to 1 if you drive into your pit position in qualify, instead of pressing
  105. 'q'.
  106.  
  107.  
  108. What do I require?
  109. ------------------
  110. - Any Amiga. People using kickstart 1.x will miss the commandline options,
  111.   and will have default options.
  112. - F1GP by Microprose, any version (European F1GP, World Circuit or the
  113.   A600 WWW version).
  114. - Oliver Roberts' f1gp.library, necessary for SplitTime to work.
  115.   f1gp.library is included with SplitTime in the directory 'libs'. You need
  116.   to copy the library to your libs: directory. If you already have one from
  117.   the latest f1gp-ed, you don't need to do that as the f1gp.library supplied
  118.   with f1gp-ed is always the same or newer as the one included here.
  119.  
  120.  
  121. How do I start it?
  122. ------------------
  123. Start this program after f1gp is run and it shows 'please wait', from cli
  124. or workbench (although SplitTime doesn't support tooltypes yet).
  125. It is also possible to run it without f1gp, in which case only the times
  126. can be viewed, but it's better to use PrintSplits for that (see below).
  127.  
  128. For the options you need to start SplitTime from the cli with the following
  129. synopsis:
  130.  
  131.   SplitTime NAME,DELAY/N,AU=AUTOUPDATE/S,AS=AUTOSAVE/S,NORACE/S,NOLIGHT/S,
  132.             QUIT/S,LEFT/N,TOP/N,QUIET/S,LX=LIGHTX/N,LY=LIGHTY/N
  133.  
  134. This is what each option does (KS 2.0+ only; to KS 1.x users it will
  135. appear as none of these options are specified, except for the QUIT option):
  136.  
  137. NAME
  138.     Specify filename for the datafile. If not specified, the filename
  139.     s:SplitTime.dat will be used. If the file does not exist, it will
  140.     be created when the data is saved from within the program.
  141.     Old versions will be converted.
  142.  
  143. DELAY/N
  144.     Display suspend delay, the time that the (split)time is shown on
  145.     the dashboard before it's replace by the clock again. Default 5
  146.     seconds (the game originally uses 10 secs for the laptime). It may
  147.     not be negative or more than 10 seconds.
  148.  
  149. AU=AUTOUPDATE/S
  150.     If specified, SplitTime wil automatically update the window contents
  151.     if an improvement has been made while you were driving.
  152.  
  153. AS=AUTOSAVE/S
  154.     If specified, SplitTime wil automatically save the split times.
  155.     This option will enable the AUTOUPDATE option, and will save the
  156.     times at the same moment as the automatic update occurs.
  157.  
  158. NORACE/S
  159.     Will disable split times in the race.
  160.  
  161. NOLIGHT/S
  162.     Will disable the little light that indicates a split improvement.
  163.  
  164. QUIT/S
  165.     If specified, SplitTime will automatically quit if f1gp quits. The
  166.     data will be saved before it does so. Kickstart 1.x users will have
  167.     this enabled.
  168.  
  169. LEFT/N
  170.     Specify left offset for window.
  171.  
  172. TOP/N
  173.     Specify top offset for window.
  174.  
  175. QUIET/S
  176.     Tell SplitTime to shut up.
  177.  
  178. LX=LIGHTX/N
  179.     Specify the x position of the indicator light, ala F1GP-Ed
  180.     cockpit graphics coordinates.
  181.     Has to be between 0 and 320 (exclusive), else a default
  182.     position is used (for y position too). Kickstart 1.x users will
  183.     always have the default position, which is (227, 112).
  184.  
  185. LY=LIGHTY/N
  186.     Specify the y position of the indicator light.
  187.     Has to be between 87 and 184 (exclusive).
  188.  
  189.  
  190.  
  191. How do I use it?
  192. ----------------
  193. When f1gp is found, a window is opened. The window will be full of '-:--.---'
  194. lines when you start it, but after driving a lap they will already be filled
  195. with times. At the top is a line that tells you the name of the currently
  196. selected track ('not selected' at first). The bottom line will give you some
  197. info about what's going on. In between there is the real data. There are
  198. seven columns: Spl, Car, Lap, BestDiff, VirtTime, BestTime and LastTime.
  199.  
  200. The 'Spl' column contains the split number for each row. There are four
  201. rows (1/4 ... 4/4).
  202.  
  203. The 'Car' and 'Lap' columns contain the car number and lap number in which
  204. each best split difference is done. The lap is always 2 or higher in non-race
  205. sessions since the first lap is a warm-up lap. For the race the lap will be
  206. 1 or higher.
  207.  
  208. The 'BestDiff' column shows you the best split difference, i.e. it shows how
  209. much time it took to drive the corresponding quarter of the track, and this
  210. only gets updated when it's improved.
  211.  
  212. The 'VirtTime' column is derived from the 'BestDiff' column and shows the
  213. virtual split times you could have driven if the best split differences had
  214. been done in one go. The 4th one is your virtual laptime (this one was shown
  215. in previous versions).
  216.  
  217. The 'BestTime' column contains the best split time at each quarter of the
  218. track. The one at the bottom will match your best laptime, and for this one
  219. additional info is being stored (although not shown) like the setup, traction
  220. control on or off, and more. This info can be viewed with the external
  221. split data viewer PrintSplits (use the VERBOSE option).
  222.  
  223. The column most to the right, 'LastTime', contains the split times that have
  224. been driven the last time. Once you cross the first split with your car they
  225. will be cleared again.
  226.  
  227. As you drive laps and switch back to the workbench to look at the SplitTime
  228. window, you can click the mouse button in the window or press <return>
  229. while it is selected to get an update of your times. If the AUTOUPDATE option
  230. was specified, the times will be updated automatically and the workbench
  231. screen will be brought to front to let you watch them. You'll see that the
  232. improved times will be highlighted in order to help you notice where you
  233. drove better than the previous time.
  234. Note that the autoupdate updates the times when the system is enabled, i.e
  235. after you press <esc>, so only times that have been updated since the last
  236. time you left cockpit will be highlighted. If the AUTOSAVE option was
  237. specified the times will be saved as well (look out, you cannot revert
  238. the data anymore).
  239.  
  240. Besides this, you can be kept up to date of your performance while you're
  241. driving too. A little light on the right (above the 'player' light), will
  242. have a certain colour after each split. If you improve a split time but
  243. not a split diff, it will be grey. If you improve a split diff but not a
  244. split time it will be dark yellow. If you improve both the split time and
  245. split diff it will be light yellow. Else it will be off (black). If you
  246. find this light distracting you can turn it off with the NOLIGHT option.
  247. And if you think it's in the wrong place (for example with a new cockpit),
  248. you can change its position with the LIGHTX and LIGHTY options.
  249.  
  250. The window doesn't have any buttons, but every command can be given by
  251. pressing a key while the window is activated. For normal use you don't even
  252. have to touch a key, as clicking the mousebutton on the window will select
  253. the track that you just drove on (if you did so) and will update all the
  254. times. The times are saved automatically when f1gp quits and the QUIT option
  255. has been specified when you started SplitTime. If you didn't, then the times
  256. can only be saved with the 's' key or have them saved automatically when
  257. you quit by pressing the <escape> key. There are no filerequesters, but the
  258. data will be saved to s:SplitTime.dat or to the file that was specified
  259. on the commandline. The same goes for the 'load' command ('l' key).
  260. If you want to quit but don't want to save the data you can use the close
  261. button of the window, or use ctrl-c in the shell you started SplitTime from.
  262.  
  263. Here is the list of keystrokes:
  264.  
  265. 1..9a..g    select a track:
  266.         1=Phoenix, 2=Interlagos, ..., g=Adelaide.
  267. crsr up        select first track (Phoenix).
  268. crsr down    select last track (Adelaide).
  269. crsr left    select previous track.
  270. crsr right    select next track.
  271. 's'        save all data to disk.
  272. 'l'        load all data (no questions asked!).
  273. <return>    update display (or click the mousebutton in the window).
  274. <del>        clear all times of currently selected track (you will be
  275.         asked for confirmation, press 'y' to confirm).
  276. F1-F4        will erase the corresponding split difference.
  277. F6-F9        same as F1-F4, but will erase a split time.
  278. <esc>        save (if something has changed) all data and quit.
  279.  
  280.  
  281. Kickstart 1.x users won't be able to use the cursor keys or the function
  282. keys due to a system bug.
  283.  
  284.  
  285. What about my old datafile?
  286. ---------------------------
  287. If you have used SplitTime v1.0 before this one you have probably a datafile
  288. for it. SplitTime v1.3 can load the old datafile, but it won't have the new
  289. data I added (setup and stuff). If you save it again, it will be converted
  290. to a new datafile.
  291. The datafile format hasn't changed anymore since v1.1.
  292.  
  293.  
  294. How do I print the data?
  295. ------------------------
  296. I have made an external print program named PrintSplits which will print
  297. your data to standard output (use the redirection option or the copy to
  298. clipboard option of the shell to get it into a file).
  299.  
  300. Usage:
  301.  
  302. PrintSplits NAME/K,TRACK/N,VERBOSE/S,LIST/S
  303.  
  304. NAME/K
  305.     Name of the datafile. You have to specify the keyword NAME, else
  306.     ReadArgs thinks it's the track number :)
  307.     If not specified, "s:SplitTime.dat" will be tried.
  308.  
  309. TRACK/N
  310.     Track number of which you want to print the data.
  311.     If not specified, data of all tracks will be printed.
  312.  
  313. VERBOSE/S
  314.     If specified, some extra information will be printed like the
  315.     setup and horsepower used for the best lap (4th best split time).
  316.     It will also print if traction control was on or off.
  317.  
  318. LIST/S
  319.     If specified, only a list of all the tracks with each track
  320.     number will be printed, so you can see what number to specify
  321.     for a track.
  322.  
  323.  
  324.  
  325. Some notes about using SplitTime
  326. --------------------------------
  327. Sometimes the split time is clocked in the middle of a corner. This can
  328. be annoying since the time then depends on the moment you brake for the
  329. corner. For example, if you brake too late into the corner, the split time
  330. will be good, but the next split time will probably be a bad one since
  331. you exit the badly taken corner with lower speed. Such split times mess
  332. up the virtual record a bit in a way that it tells you that you can drive
  333. a certain time, but that it's not the case in reality.
  334. Of course it's possible for me to change the locations at which the splits
  335. are clocked, but I wanted to keep them this way because then they would
  336. be the same as on the pc. I may have changed it though in a next version.
  337. Whenever you mess up a split time or difference like this, you are able
  338. to clear each individual difference with keys F1 to F4, and each split time
  339. with keys F5 to F9 (not with kickstart 1.x). Or clear everything in one go
  340. with the <del> key.
  341.  
  342. When driving with different setups, frame frates or other configurations,
  343. the virtual times can be affected also. It is advised to use a different
  344. datafile for each configuration so you can always compare the virtual
  345. record or individual split times/differences.
  346.  
  347. It is better _not_ to quit and/or (re)start SplitTime in the middle of a
  348. session. Although nothing serious can go wrong it is possible that the
  349. best laptime the game keeps track of will be erased by SplitTime, or
  350. the other way round.
  351.  
  352.  
  353.  
  354. People I want to thank
  355. ----------------------
  356.  
  357. Thanks go to:
  358.  
  359. - Grant Reeve for helping me and beta-testing.
  360. - Oliver Roberts for beta-testing and support.
  361. - Dave Wright for testing with kickstart 1.3.
  362. - Edo Nijmeijer, Maarten van Schouwen, Patrick Giesbergen and
  363.   Robert Schaftlein, also for beta-testing.
  364. - Trevor Kellaway, who also made SPLITTIM on the pc which gave
  365.   me the idea to code it for the Amiga.
  366. - All the people who gave me feedback!
  367.