@database WBCycle.guide

@$VER: WBCycle guide 1.0
@author "Steve Hargreaves"
@(c) "Copyright © 2001 Steve Hargreaves"

@node "main" "WBCycle V1.0"
                                @{b}WB Cycle@{ub}
                            by Steve Hargreaves

                          @{" Introduction          " link "Introduction" 0}
                          @{" Distribution          " link "Distribution" 0}

                          @{" Requirements          " link "Requirements" 0}
                          @{" Features              " link "Features" 0}
                          @{" What's New and To Do  " link "New" 0}
                          @{" Installation          " link "Installation" 0}
                          @{" Configuration         " link "Configuration" 0}
                          @{" Usage                 " link "Usage" 0}
                          
                          @{" Contacting the Author " link "Author" 0}
@next "Introduction"
@endnode

@node "Introduction" "Introduction"
@prev "Main"
                                             @{b}Introduction@{ub}

I was going through one of them phases, you know the type, when you look at your Workbench and think,
"How can I tart this up a bit". I already had VisualPrefs running, Birdie used up too much precious
Chip Mem for patterned borders. I had my window and desktop patterns installed, but I wanted more.

Then I came across a little prog on Aminet called WBPal, which cycled your active Window border from
pale blue to dark blue. "Nice", I thought, "but a little limited". So I sat down and started writing.
The result, WBCycle.

WBCycle is a little commodity which will cycle any (user definable) WB colour through a user definable
spectrum at a user definable speed.

I like it, I hope that you do.

Steve Hargreaves.  
@next "Distribution"
@endnode

@node "Distribution" "Distribution"
@prev "Introduction"
@{b}Distribution@{ub}

  WBCycle is freeware

  This package may be distributed via whatever means you want, provided
  the archive remains intact and none of the files in it are modified.

  @{b}Disclaimer@{ub}

  By using this product, you accept the full responsibility for any damage
  or loss that might occur through its use.  The author cannot be held responsible.
@next "Requirements"
@endnode

@node "Requirements" "System Requirements"
@prev "Distribution"
@{b}System Requirements@{ub}

An AGA Amiga
(I'm not sure if it will work on GFX cards. Please let me know.
@next "Features"
@endnode

@node "Features" "Features"
@prev "Requirements"
@{b}Features@{ub}

-	It's a commodity
-	Configurable through tooltypes
-	Low CPU usage
-	Small executable

@next "New"
@endnode

@node "New" "What's New and To Do"
@prev "Features"
@{b}New in Version 2.0@{ub}

-	Each colour registers high, low and speed values are independantly configurable.

-	Fixed a bug which caused a crash if you tried to run multiple copies. Only the original
	copy will run. Multiple copies will simply exit quietly.

-	Fixed the commodity interface so that WBcycle can be de-activated and re-activated from Exchange.

-	Cleaned up the code a bit

-	More error checking of the TOOLTYPES

@{b}To do:-@{ub}

-	Fix the last commodity bug (see @{"Usage" link "Usage" 0}).

-	Possibly include a GUI to set the prefs, removing the need for tooltypes.

-	Possibly include graphics card support, but this will have to wait until either I get one, or I
	can get the necessary details to code it.

-	Possibly an ECS version, if there's any demand.
@next "Installation"
@endnode

@node "Installation" "Installation"
@prev "Features"
@{b}Installation@{ub}

Pretty easy:-

1.	Copy WBCycle (and its' icon) to wherever you want (I suggest WBStartup)
2.	Errm, that's it.
@next "Configuration"
@endnode

@node "Configuration" "Configuration"
@prev "Installation"

Configuration is through tooltypes, of which there are ten:-

@{b}RSPEED, GSPEED and BSPEED@{ub}= The speed at which the colour cycles for each register. I wouldn't
recommend  going too high (128 is probably max, but 1 works for me). I use a value of 1.
Values greater than 32 may induce Migraine/epilepsy - You have been warned.

@{b}RLOW, GLOW and BLOW@{ub}=	  The lowest that each RGB component will cycle to. Valid range is 0 - 255,but
your HIGH tooltype MUST be higher than this, and if the difference between the two is too low, then the effect
will be diminished, though see below re restricting cycling to one or two RGB components.

@{b}RHIGH, GHIGH and BHIGH@{ub}=  The highest that each RGB component will cycle to. Valid range
is 0 - 255, but your LOW tooltype MUST be lower than this, and if the difference between
the two is too low, then the effect will be diminished, though see below re restricting cycling to one
or two RGB components..

@{b}REG@{ub}=	  The colour register to be cycled. Defaults to 0 if no value given.

You may want to experiment, but the defaults will cycle through the range.

If you want to restrict cycling to one RGB register, then set the other two one
value apart.eg:-

RLOW=64
RHIGH=65
GLOW=64
GHIGH=65
BLOW=64
BHIGH=255

will cycle from a low grey to blue and back again. 

Except when restricting cycling, all three RGB components will never be the same value at the same
time. This is deliberate, and avoids a black or white (and in fact all shades of grey in between).
This is to try and avoid making text unreadable when you are cycling a text background (window border,
icon text background etc.)

Define REG as the colour register of your active Workbench window, or whichever colour you want to
cycle.
@next "Usage"
@endnode

@node "Usage" "Usage"
@prev "Configuration"
@{b}Usage@{ub}

This is pretty easy,too.

Double click it's icon (or start from WBStartup) to get it going.
Use "Remove" from Exchange to stop it. 

NB. If you have de-activated WBCycle (using exchange) then you must re-activate it before you can
remove it. I'll fix this in the next release.

@next "Author"
@endnode

@node "Author" "Contacting the Author"
@prev "Usage"
@{b}Contact Info

  @{b}EMail:@{ub
}
          Steve@hargreavess.freeserve.co.uk

  @{b}Other stuff by me@{ub}
    
		- Blitzdock - a dockbar utility

		- PlaceMouse - place your mouse wherever you want at startup

		- ScalosEject - an Eject popup menu item for supported drives usable for Scalos (See
		  www.scalos.org

		- AmigaDraughts - Draughts on the Amiga - one or two player.

		- CDEject - Similar to ScalosEject, but places an Eject Appicon on WB
@endnode