@database JWWSInstall.guide
@$VER: JWWSInstall v1.02 documentation (c) 1998 John Girvin
@smartwrap

@rem -----------------------------------------------------
@node main "JWWSInstall - Main index"

@{jcentre}
@{b}JWWSInstall - Jimmy White's Whirlwind Snooker HD Installation Package@{ub}

@{b}(c) 1998 John Girvin@{ub}

@{b}Version 1.02@{ub}

@{i}For your own sake, please read the @{"usage notes" link notes} before attempting
to use this package. There are some important points you may miss
or get wrong if you don't!@{ui}
@{jleft}

@{u}Table of Contents@{uu}

    @{" Description                " link description}
    @{" Price and Distributability " link pricedist}
    @{" Usage notes                " link notes} @{b}IMPORTANT!@{ub}

    @{" Installing                 " link installing}
    @{" Playing                    " link playing}

    @{" Troubleshooting            " link trouble}
    @{" Known problems             " link problems}

    @{" Author information         " link author}
    @{" Project history            " link history}
    @{" Future plans               " link future}
    @{" Acknowledgements           " link acknowledge}

@endnode

@rem -----------------------------------------------------
@node description "JWWSInstall - Description"
@toc main

This is version 1.02 of a hard drive installation package for the
Archer Maclean/Virgin Games game "Jimmy White's Whirlwind Snooker".
Supports loading and saving of game positions and scores to hard
drive.

Supports the following versions of the game:
   - original version
   - Beau Jolly "The Greatest" compilation version
   - Hit Squad budget re-release version

@endnode

@rem -----------------------------------------------------
@node notes "JWWSInstall - Usage notes"
@toc main

@{b}JWWSInstall is provided "as is" and is used at your own risk.

The author is not liable for any loss or damage caused by the
use or misuse of this program. It almost certainly *wont* destroy
your Amiga, but if it does (or does anything else untoward) then
I cannot be held responsible.@{ub}

Requires version 43.3 or later of the "Installer" program.
This is available for free download from Aminet in the "util/misc"
subdirectory:
ftp://wuarchive.wustl.edu/pub/aminet/util/misc/Installer-43_3.lha

Requires approximately 500K of free space on your hard drive.
Please do not attempt installation if you have less than this
amount free on the partition you intend to install Jet Set
Willy II on.

Requires version 0.608 or later of the WHDLoad package by Bert
Jahn. v0.608 is included in this archive and will be installed
along with the game when you use the installer.

You will require an @{i}original@{ui} copy of the game disk!
This installer is unlikely to work with any pirate versions of the
game, nor will I ever modify it to do so.

Do not attempt to crunch or pack the game files (the files found in
the "data" subdirectory) or the JW_Snooker slave program. The WHDLoad
program may be packed like any normal program.

After installation is complete, you may delete the directory
produced by extracting this archive ("JWWSInstall"). All files
required for running the game will be found in the directory
created during installation.

@endnode

@rem -----------------------------------------------------
@node installing "JWWSInstall - Installing"
@toc main

@{b}Have you read the @{"usage notes" link notes} yet?@{ub}

@{u}INSTALLING THE GAME@{uu}

Extract all files in the archive to your system. They will be
extracted to a drawer called "JWWSInstall"

Open the newly created "JWWSInstall" drawer and double click
on the "Install_JWWS" icon found there.

Follow the instructions given to you by the Installer program!

When running the installer it is advisable to disable any virus
checking software you may have running. The original game disk
uses a non-standard bootblock which will most likely cause your
virus checker to complain and this could interefere with the
installation process. It is not necessary to disable such programs
before playing the game once it is installed.

During the installation process, multitasking must be disabled
temporarily while the game data is copied from the floppy to
your hard disk. For this period you will not be able to do
anything else with your Amiga. @{b}DON'T PANIC@{ub} - its normal.

The game will be installed to a directory you select on your
hard drive. You will be alerted @{"if installation fails" link trouble} for any
reason.


@{u}INSTALLING SAVED GAMES@{uu}

You have the option to install saved game positions and score
information during the main game installation process or at a
later date.

An installer script will be placed in the directory you choose
to install the game in and clicking on its icon will allow you
to @{b}overwrite@{ub} any current saved game information held on your
hard drive with new information read from a saved game floppy.

@{b}@{u}ANY EXISTING SAVED GAME DATA WILL BE DESTROYED BY THIS PROCEDURE!@{uu}@{ub}

You have been warned.

@endnode

@rem -----------------------------------------------------
@node playing "JWWSInstall - Playing"
@toc main

        @{" From Workbench  " link play_wb}
        @{" From Shell      " link play_shell}
        @{" In-game options " link play_ingame}

@endnode

@rem -----------------------------------------------------
@node play_wb "JWWSInstall - Playing from Workbench"
@toc playing

Open the "JW_Snooker" drawer created during installation and click
on the "JW_Snooker" icon. The game will now load and run.

When you first start the game you will be asked to enter a word
from the game manual. You do not have to enter the correct word,
simply pressing RETURN at this point is enough.

@endnode

@rem -----------------------------------------------------
@node play_shell "JWWSInstall - Playing from Shell"
@toc playing

"CD" (change directory) to the "JW_Snooker" drawer
created during installation.

The following command will start the game:

    WHDLoad SLAVE=JW_Snooker NOVBRMOVE PRELOAD

When you first start the game you will be asked to enter a word
from the game manual. You do not have to enter the correct word,
simply pressing RETURN at this point is enough.

@endnode

@rem -----------------------------------------------------
@node play_ingame "JWWSInstall - In-game options"
@toc playing

When the game is running, the following keys may be used:

        @{b}F9@{ub}  = quit and make a coredump (for debugging only)
        @{b}F10@{ub} = quit the game and return to Workbench.

@endnode

@rem -----------------------------------------------------
@node trouble "JWWSInstall - Trouble shooting"
@toc main

Please read the @{"usage notes" link notes} and @{"known problems" link problems} sections of
this document if you have not done so already. They contain
important information which may help resolve your problem.

If you are using a pirate copy of the game, stop reading now.
I will make no fixes for pirate copies the game. Don`t even ask.

If you are going to send a bug report (email preferred) please
include at least the following information:
- version of the game (eg. 1 MB English Version ECS), number of
  disks etc.

- configuration of your machine including type of Amiga, CPU, CPU
  speed, amount of chip and fast memory, gfx chipset (OCS/ECS/AGA),
  special hardware, kickstart version

- description of what happens eg: error while installing, error while
  starting, gfx errors, keyboard hangs, game crashes on level 15 etc.
  It helps if you describe @{i}exactly@{ui} when the error happens
  and if it happens all the time or just intermittently.

@endnode

@rem -----------------------------------------------------
@node problems "JWWSInstall - Known problems"
@toc main

- the installer is written in as system friendly a way as possible,
  but the game is not. Owners of heavily expanded Amigas may have
  problems running the game, but this is not the fault of JWWSInstall
  and there is little I can do about it :( Try the usual system
  degrading tricks if you run into difficulties.

- the exit and coredump keys only work in the main game.

@endnode

@rem -----------------------------------------------------
@node history "JWWSInstall - History"
@toc main

1.00  First release version.
      Released to Aminet in January 1998.

1.01  Added options to install saved games.
      Released to Aminet in January 1998.

1.02  Added support for two more game versions.
      Released to Aminet in February 1998.

@endnode

@rem -----------------------------------------------------
@node future "JWWSInstall - Future developments"
@toc main

- Add support for other versions of the game.

- Improve the manual protection patch so the window doesnt
  even appear.

@endnode

@rem -----------------------------------------------------
@node pricedist "JWWSInstall - Price and distributability"
@toc main

One email message - JWWSInstall is emailware.
If you use it then let me know!

I'd also appreciate a postcard of your home town, especially
if you live outside of the UK! This isnt required, but it
would be @{i}nice@{ui}.

Cash donations, gifts etc. are also appreciated; these tend
to also buy you faster and more positive responses to help
and change requests...

(c) 1998 John Girvin. No modifications may be made to either
the program or its accompanying files/documentation without my
explicit prior consent.

Freely Distributable, provided all files are included unchanged
in any distribution and no more than minimal handling/media
costs are charged.

@endnode

@rem -----------------------------------------------------
@node author "JWWSInstall - Author information"
@toc main

@{b}Name:@{ub}      John Girvin

@{b}E-Mail:@{ub}    girv@girvnet.demon.co.uk

@{b}WWW:@{ub}       http://www.girvnet.demon.co.uk

@{b}SnailMail:@{ub} J. Girvin,
                    25 Moorgate Street,
                    Belfast BT5 5BZ,
                    Northern Ireland,
                    United Kingdom.

@endnode

@rem -----------------------------------------------------
@node acknowledge "JWWSInstall - Acknowledgements"
@toc main

"Jimmy White's Whirlwind Snooker" is (c) Archer Maclean/Virgin Games.

WHDLoad is (c) Bert Jahn.
Bert's homepage, with the latest version of WHDLoad plus installers
for many games and demos can be found at:
http://www.fh-zwickau.de/~jah/whdload.html

JWWSInstall uses GPatch 2.2 (c) 1997 by Ralf Gruner
(ralf.gruner@t-online.de)

Thanks to "Den of Iniquity" for lending me his original disks, drawing
a nice NewIcon for the install and for the chats about sci-fi books etc.

Thanks to Ian McDonald, also for lending me his original disks.

Thanks to Mr. Lamer for mailing me the checksum code from Archer Maclean's
Pool, which helped deprotecting Jimmy White's Snooker.

@endnode