Online Documentation Amiga Formula One

HoF-Analyzer 1.5 - Contents


                                                     

                          Welcome to HoF-Analyzer !
                                                     

                   HoF-Analyzer 1.5 by Christophe Macours
                            with Blitz Basic 2.1
                         © Copyright November 1999




    Introduction       What, How, Why ?

    Distribution       Please read !

    Requirements       What you need

    Installation       Very complicated...

    Getting Started    ToolTypes description

    Using              How to use ?

    Help me!           Problems, bugs...

    Thankyous          People I want to thank

    The Author...      All about me...

    History            Program history

    The future         Future changes


Introduction


Introduction

This program allows you to dissect Rob Wilson's HoF (Hall of Fame) HTML
files. It is widely inspired by Michal Janak's HoFPoints. I appreciate
much his program but it doesn't allow a global vision of the standings and
the records encoding is rather boring. That's why I decided to start
programming, with Blitz Basic 2.1 (which is fantastic).

Since the new HTML format of the HoF, HoF-Analyzer may be a cheap
and fast way for viewing and analyzing the HoF on slower Amigas (as mine).

Here are the main features of HoF-Analyzer :

- Classification viewing (global standings and track by track) with either
  HoF times or updated times. In the latter case, all your positions and
  scores are updated.

- By clicking on an item in the listview, you can view the other data
  present in the HoF (date, setup, ...) and also save this setup as a ready
  to use standard F1GP setup file.

- You can set a desired position in the global standings and HoF-Analyzer
  will tell you for each track the needed time as well as the time
  difference between you and the driver at the desired position. Morover,
  you can compare all your times with your SplitTime virtual times.

- You can also know on what circuit you are the worst following one of these
  criteria : position, score, date, or time difference with enemy or your
  SplitTime virtual time.

- There are three ways to update your times :
  . you can paste them directly from the HoF
  . you can grep them from the SpliTime file
  . you can type them manually


Other features are in development but I'm waiting to see if the program is
appreciated. Suggestions and bugs reports are of course welcome !


Distribution


Distribution

HoF-Analyzer is Moduleware. If you like it, I invite you to send me a music
module (mod. ...) of your own, to my E-Mail address.

You can copy HoF-Analyzer as many times as you want, as long as it is kept
with the following files:

    HoF-Analyzer.info            Standard 4 colours icon
    HoF-Analyzer_MWB.info        Magic-WB 8 colours icon
    HoF-Analyzer.guide           English documentation

Of course, I cannot be held liable if this program causes any problems with
your system, even if nothing serious should happen. Have a look at the bugs
page.

For the rest, I don't advise you to cut this program into 36 pieces, or to
sell it at 30000 pounds. It's up to you...


Requirements


Requirements

Any Amiga with OS 2.0 or higher should suit. However, HoF-Analyzer has only
been tested on a Amiga 1200 and 4000, both with Kickstart 3.0 and 4Mb Fast.

The HoF HTML directory must at least contain the file scores.html and
all the 16 trackfiles with their original names. If those conditions are not
met, HoF-Analyzer won't start.

IMPORTANT: HoF-Analyzer 1.5 does no longer work with AmigaGuide files.
To use old HoF guide files, you must use HoF-Analyzer 1.4.

The reqtools.library and diskfont.library are also required.

I advise you to use the F.Giannici's CycleToMenu commodity (or any
equivalent) to make the circuits choice easier, as well as Magic Menu (by
Martin Korndörfer and Olaf `Olsen' Barthel) to have nice looking menus (they
are still ugly). You can find those tools in the appropriate directory on
Aminet.


Installation


Installation

Installation is very easy. Just copy the HoF-Analyzer executable file and
its icon in the desired directory.

Note that the program directory has nothing to do with the HoF HTML
directory. The latter one can be specified separately (see the
Getting Started section).


Getting Started


Getting Started

From Workbench:

Just double-click over the HoF-Analyzer icon to open the window.
There are different TOOLTYPES (which are NOT case sensitive):

ID=your_HoF_ID             Ex: ID=CM

This allows HoF-Analyzer to identify you.
If the chosen ID doesn't appear in the HoF, you can still comapre your
perfomances with the HoF by encoding them manually.
If that Tooltype is not specified, the ID CM is used by default :-)


HOFDIR=the_HoF_HTML_dir    Ex: HOFDIR=Work:Jeux/grandprix/HoF/October_1999/

The HoF HTML directory to work in. The program won't run if it does not
contain the file scores.html and the 16 trackfiles.
If that Tooltype is not specified, the PROGDIR: directory is used by
default. If it is not a valid directory, a path requester will appear.


REC=your_records_file      Ex: REC=Work:Jeux/HoF-Analyzer/CM_Records

The Records file to load, which contains the Manual Times. That file has
nothing to do with the Lap Records files from F1GP ! It is a file specific
to HoF-Analyzer.


SPLIT=SplitTime_file       Ex: SPLIT=Work:Jeux/SplitTime/CM_SplitTimes

The SplitTime file to load. It is a 840 bytes file containing the times
recorded by Rene Smit's SplitTime. HoF-Analyzer allows you to compare
your times with the Virtual times, and load your manual track times from it.


NEEDPOS=your_needpos       Ex: NEEDPOS=3

Determines the Global position you want to reach (i.e. the slider position)
in From HoF mode.
If that Tooltype is not specified, the From HoF needed position is your
Global position minus one.


NEEDPOS2=manual_needpos    Ex: NEEDPOS2=2

Determines the Global position you want to reach (i.e. the slider position)
in Manal mode.
If that Tooltype is not specified, the Manual needed position takes the
value of the NEEDPOS Tooltype.


MODE=mode_id               Ex: MODE=1

This ToolType allows you to start with the NeedTime calculation Mode of your
choice.
        Equal:    mode_id = 0
        Janak's:  mode_id = 1
        Split:    mode_id = 2
If that Tooltype is not specified, the calculation Mode is Equal.


WORST=worst_id             Ex: WORST=2

This ToolType allows you to start with the Worst track detection mode of
your choice.
        Pos:    worst_id = 0
        Score:  worst_id = 1
        Diff.:  worst_id = 2
        Split:  worst_id = 3
        Date:   worst_id = 4
If that Tooltype is not specified, the Worst button in on Pos.


FONTNAME=window_font_name  Ex: FONTNAME=helvetica

The Font to use in the window. This is useful if your screen font is not
cleanly proportional (i.e. the cyphers' width is not constant). If that
Tooltype is not specified, the screen font is used by default.


FONTSIZE=window_font_size  Ex: FONTSIZE=15

The size of the window font. If that Tooltype is not specified, the screen
font size is used by default.


WINX=X_pos_of_window       Ex: WINX=64

Determines the horizontal position of the window.


WINY=Y_pos_of_window       Ex: WINY=64

Determines the vertical position of the window.



From CLI:

Just type HoF-Analyzer after its path. There is no option because the config
is read from the file HoF-Analyzer.info.
So please refer the Tooltypes'descriptions above.


Using


Using

HoF-Analyzer uses two types of commands:

  - The Gadgets

  - The Menus


Using of Gadgets


Using of Gadgets

You will find below a description of the window of HoF-Analyzer. To know
more about a button, just click on it !


   Select Track: Get Times:  ID:        Time:
       Global    From HoF   ID     1m 17.338
                           
                                Score: 228.63

                            Need Global Pos:
                                     |     7

                            Need Time: Diff.:
           Standings        1m16.829 - 0.509

                                Mode: Janak's

                                    Enemy: OR

                               Diff.: + 0.364

                                  Worst Score

                                 Germany
                           


Using of Gadgets


Select Track
This button allows you to choose the kind of classification you want to be
shown into the listview. There are two kinds of classification:

  Global:     Displays the general standings of HoF.

  Any Track:  Displays the time classification of the selected track.

Key shortcut: s


Using of Gadgets


Get Times
This button gives you two possibilities:

  From HoF:  HoF-Analyzer will pick your times directly from the HoF files,
             without any modification.

  Manually:  Your "official" times will be replaced by the Manual Times,
             manually encoded or preloaded.

Key shortcut: t


Using of Gadgets


Standings
In this listview, you will find either the general classification or the
selected track classification, according to the Track button.
If you appear in the classification, the line corresponding to your ID is
automatically highlighted.
An asterisc (*) is displayed after every updated records (as in the HoF).

If you select an entry in the listview, an Info Window will appear.

  If your are in Global mode, you will see:

    Global Score: the global score of the selected driver
    Score Delta: the score difference with the previous HoF
    Last HoF Pos: the global rank in the previous HoF
    Qualified Tracks: the number of tracks records submitted
    Highest/Lowest: your best and worst track positions

  In Manual mode, these data are re-calculated.

  If any track is selected :

    Time: the laptime made by the selected driver on the selected track
    Date: the date the record was made
    Options: the HoF options - see the HoF documentation for more details
    Setup: the setup used - see your F1GP documentation for more details

  This Info Window allows you to save the setup by clicking the Save Setup
  button. Then a requester appears asking you to select a setup file to
  save. The saved file is the standard 14 bytes F1GP car setup file format
  and can then be used by F1GP or F1GP-Ed.

Important Note: In Global mode, your score is the only to be updated, the
others don't change (for example when you become first at a track). This
inconvenient may be removed in the future.


Key shortcuts:
   Up and Down arrows to move in the listview, and Enter to select the
   highlighted entry.
   Keys 1 -> 9 and a -> g to select tracks (as in SplitTime).


Using of Gadgets


ID
This gadget simply reminds you who you are :-). It has not really a defined
purpose - I sometimes wonder why I kept it...
The only way to change your ID is to edit the ID TOOLTYPE.


Using of Gadgets


Time
This gadget is only active in Manually mode. It allows you to enter your
record for the selected circuit. Your rank will change automatically, as
well as your Total Score and the Need Time.

Note that there is a faster way to edit your times, using the
Get Split Track Time menu option.

Key shortcut: i to activate the edit zone.


Using of Gadgets


Score
Your total score is printed here. In From HoF mode, the score is the same
as in the HoF, whereas in Manually mode, your score is recalculated using
your Manual Times. Note that you always get a point for having times (see
HoF rules).


Using of Gadgets


Need Global Pos
With this slider, you can specify the position you want to reach in the
general standings. HoF-Analyzer will show you a Need Time for each circuit,
using the method specified by the Mode button.

When your updates make you win one or more positions in the standings, you
may need a different Needed Position. HoF-Analyzer can memorize the slider
position for each situation (From HoF and Manually).
They can be respectively specified at startup by the NEEDPOS and NEEDPOS2
Tooltypes.

Key shortcut: Left and Right arrows.


Utilisation des Gadgets


Need Time
Printed here is the time, for the selected track, you will need to reach
the position specified by the slider.
When you have no time at a circuit, the time to reach in mode Janak's
represents the best time to get zero point.
When you have not performed many records, the Need Time may seem strange.
This is because Janak's calculation needs all the track times.

In Split mode, the Virtual laptime from SplitTime is displayed.


Using of Gadgets


Diff.
Shows the difference between your time and the Need Time. When your
time is better, the difference is negative, and vice-versa.


Using of Gadgets


Mode
This button determines the calculation method to use for the Need Times.
There are two modes available:

  Equal:    The score to reach is the same for all circuits:

            need_score_circuit_x = need_total_score / 16.


  Janak's:  HoF-Analyzer uses Michal Janak's formula, which is explained in
            HoFPoints's documentation. Here is its principle:
            The closer your are from the best time, the less you need to
            improve it. So if you have the best time, you don't need to
            improve it. However, the more your time move away from the best,
            the more you have to improve it.

An additionnal mode (Split) allows you to see your SplitTime Virual times,
which must be pre-loaded, either using the SPLIT ToolType or with the
Change Split file menu option.

Key shortcut: m


Using of Gadgets


Enemy
You can find here the ID of the driver who sits at the Needed Position.
He is your Enemy !


Using of Gadgets


Diff.
Shows the difference between your time and your Enemy's time. When your time
is better, the difference is negative, and vice-versa.


Using of Gadgets


Worst
This Cycle Button allows you to see the track(s) you are the worst. There
are three ways to do that:

  Pos     Hof-Analyzer will look for the track where your rank is the worst
          (i.e. the biggest), and display its name in the Text Gadget below.
          Note that if your worst position appears twice (or more),
          HoF-Analyzer will return you the first worst track found (in the
          normal track order).

  Score   The program will look for your worst track score.

  Diff.   HoF-Analyzer will compare the time differences between you and
          your Enemy (not the Need Time). The biggest difference is kept.

  Split   The track with the biggest difference between your track time
          and your Virtual time will be displayed.

  Date    Searches for your oldest track record, by comparing the dates in
          the HoF. In Manual mode, the tracks where you have updated your
          laptime are not included in the comparison.

Key shortcut: w


Using of Menus


Using of Menus

Please choose the Menu option you would like to know more about:


     Project               Edit                    Settings
     Load Records         Clear Records           \/ Save Window State 
     Save Records         Paste from HoF          \/ Snapshot Window   
     Change HoF dir       Get Split Track Time    Save Settings        
     Change Split file 
     About...          
     Quit              


Using of Menus


Load Records
Opens a file requester and asks you to choose a Records file containing
the Manual Times. Those Records files have nothing to do with the Lap
Records files from F1GP !
If the chosen file doesn't exist or is incorrect, there is no modification.
For people who are interested, the Records files are just text files,
easy to edit. When there is no time for a circuit, there is a - (dash)
instead.


Using of Menus


Save Records
Opens a file requester and asks you to choose a Records file that will
contain the Manual Times currently into memory. You don't need to be in
Manually mode for this operation.


Using of Menus


Change HoF dir
Opens a path requester and asks you to choose a new HoF HTML directory to
analyze. If the operation is successful, the program will recalculate some
data and your Manual Times will be kept. If not, nothing
will happen. This operation allows you to see what your rank would have been
if you had made some records some months earlier...


Using of Menus


Change Split file
Opens a file requester and asks you to choose a new SplitTime file to load.
It must be a 840 bytes file generated by Rene Smit's SplitTime.
HoF-Analyzer needs it to work with Virtual times and track times.


Using of Menus


About...
No comments... See the Author page.


Using of Menus


Quit
Exits HoF-Analyzer after confirmation. The close window gadget has the
same effect.

Key shortcut: ESC


Using of Menus


Clear Records
This option allows you to clear the  Manual Times currently in memory.
Your Total Score will thus be zero and you will only appear in the general
standings, with one point. This operation is NOT reversible !


Using of Menus


Paste Records from HoF
Very useful when using HoF-Analyzer for the first time, this function allows
you to copy all the HoF times to the Manual Times, so you don't have to
type them in.


Using of Menus


Get Split Track Time
Enables you to update the Manual Time of the selected track from the one
recorded by SplitTime. This is a fast way to update your times.


Using of Menus


Save Window State
This option specifies if the Need Global Pos, Mode, and Worst gadget status
must be saved when choosing the Save Settings menu option.


Using of Menus


Snapshot Window
This option specifies if the window position must be saved when choosing the
Save Settings menu option.


Using of Menus


Save Settings
Saves the program configuration into the TOOLTYPES. Here is what is saved:

  - The HoF HTML directory name
  - The Records file name
  - The SplitTime file name
  - The ID
  - The Need Global Pos, Mode and Worst gadget status (if Save Window State
    is activated)
  - The window coordinates (if Snapshot Window is activated)


Help me!


Help me!

As HoF-Analyzer is the first Intuition program I have created with Blitz
Basic, it is not impossible, despite everything, that bugs have resisted to
the tests. If so, please send me the bug description and your configuration.
Moreover, if you have Fonts problems (especially in the classifications),
feel free to inform me ! Finally, any suggestion is welcome !


Thankyous


Thankyous

A big thank to:

  Michal Janak for his HoFPoints, without which HoF-Analyzer wouldn't exist,
  and also for having noticed the (stupid) bug in the Need Times.

  Oliver Roberts for his critics and suggestions, his site, F1GP-Ed, etc...
  (I stop - there is really too much to write here :-)

  Alan Strang for the HoF (continue Alan !), his constructive suggestions,
  and for having also tested HoF-Analyzer.

  Rob Wilson for maintaining the HoF alive.


The Author


The Author

I'm 22 years old and studying computer engineering at the University of
Liège, Belgium. I'm fond of car racing, Amiga, athletics...

To contact me:

      Christophe Macours
      Rue des Azalées, 20
      B-5001 Belgrade
      BELGIUM

      E-Mail: s952025@student.ulg.ac.be

If you are interested in engine sound samples (especially GTs), I suggest
you to have a look at my web page:

      http://www.stud.montefiore.ulg.ac.be/~macours/samples.html

That's all...


History


History

V1.5  - 01 November 1999 (157124 bytes)

  - Updated to work with the new HTML version of the HoF
  - The Need Pos can be saved separetely for From HoF and Manual modes in
    the NEEDPOS2 Tooltype (useful if the updates make you global position
    decrease)
  - No more French documentation :-(

  - Corrected bug in the Worst Score calculation


V1.4  - 26 April 1998 (152472 bytes)

  - Added keyboard shortcuts
  - Added the Get Split Track Time menu option, which allows updating
    records without typing anything
  - Added Date option in Worst button, to detect your oldest track
    record

  - Menus are more font sensitive
  - Corrected bug in Split file reading procedure: the time displayed was
    sometimes lower than expected
  - Corrected bug when less than 16 track records (Thanks Ron!)


V1.3  - 14 December 1997 (139180 bytes)

  - Added the Split mode, which allows viewing Virtual times from SplitTime
  - Added the Split option in Worst button, to see your biggest Real-Virtual
    time difference
  - Added the Global Info Window
  - Added MODE, WORST and SPLIT ToolTypes (Thanks Alan!)
  - Added asterisc (*) after ID if record is updated (as in the HoF)

  - Menus are less ugly without MagicMenu
  - Now works if "Fonts:" drawer doesn't exist
  - Corrected some more bugs...


V1.2  - 26 October 1997 (126280 bytes)

  - Added the Record Info Window with the Save Setup button
  - Added the Worst button
  - Added the NEEDPOS Tooltype

  - The listview size depends now on the chosen Font size
  - Corrected the layout bug with Fontsizes < 9


V1.1  - 26 August 1997 (121380 bytes)

  - Added Enemy feature, which shows the time differences between you and
    the driver occupying the needed position
  - Added FONTNAME and FONTSIZE Tooltypes
  - A Bevel Box has been put around the window...

  - Fixed a bug: when your position is 1st in the general standings, your
    needed times are now correct


V1.0  - 17 August 1997 (118180 bytes)

  First public release.


V0.5ß - 22 July 1997 (120760 bytes)

  Beta version, for testing.


The Future


The Future

The new HTML format of the Hall of Fame imposed me to update HoF-Analyzer.
In the future, it may be necessary to make other updates to accommodate with
changes made by Rob. So don't hesitate to send me your suggestions
and bugS reports !

One thing I should look at is the size of the code. But this is not my
priority.


Converted on 07 Dec 1999 with RexxDoesAmigaGuide2HTML 2.1 by Michael Ranner.