Brilliance ReadMe
-----------------

$VER: Brilliance_ReadMe 20.1 (01.06.94)
$Release 2.0
$Revision: 1.12 $
$Date: 1994/06/01 11:18:04 $


Introduction
------------

This file contains additional Brilliance documentation.  At present it
contains only tool types descriptions.


Tool Types
----------

This section describes the tool types used by Brilliance, their load and
save behavior, ranges, and default settings.

Please note that all tool types are to be typed as shown.  Uppercase and
lowercase letters are significant and must be used as per the examples.
Any unknown or unsupported tool types entered will be ignored.  The order
in which they appear is not important.

Syntax:

    M..N         Used to describe a range of numbers from which to choose
                 a number from.  (e.g. 3..14 describes a range from 3 to 14
                 inclusive)  Any number chosen within the specified range
                 is valid.

item1|item2...   Used to denote a list of items from which exactly one item
                 may be chosen.  (e.g. Red|Green|Blue is a list from which
                 a user may select Red, Green or Blue as a valid choice)

   <item>        Describes a spot were the labeled item is to be placed.
                 (e.g. <license> - put the license number at this location)

  {<item>}       Replace with any number of things suitable for <item>
                 separated by spaces.  (e.g. {<animal>} might be replaced
                 by: cat dog bird horse pig)

      =          Used as a separator between the tool type name and its
                 value or attribute.  It is used after the last letter of
                 the tool type name and the first character of its value.


Preferences Requester Items
---------------------------

These items describe Preferences requester settings.  They are saved into
the program icon during Save Preferences and are loaded during program
startup.

    PREFS.AUTOSCROLL_SCREENS=On|Off
        Setting of Autoscroll Screens gadget.  Defaults to Off.

    PREFS.CREATE_ICONS=On|Off
        Setting of Create Icons gadget.  Defaults to On.

    PREFS.FLIP_FRAMES=1..9999
        Setting of Animation Flip Frames value.  Defaults to 5.

    PREFS.NOVICE_WARNINGS=On|Off
        Setting of Novice Warnings gadget.  Defaults to On.

    PREFS.RELATIVE_COORDS=On|Off
        Setting of Relative Coordinates gadget.  Defaults to On.

    PREFS.UNDO_KBYTES=0..999999
        Setting of Undo Buffer Size gadget in KBytes.  Defaults to 1K.

    PREFS.WORKBENCH=On|Off
        Setting of Workbench gadget.  Defaults to Off.


Runtime Editable Items
----------------------

These items describe program options that are saved to the program icon
during Save Preferences, but are not directly editable from within the
Preferences requester.  They are also loaded during program startup.

    BUFFER.TRUE_COLOR_DEPTH=15|24
        True color buffer depth.  Defaults to be in sync with default
        screen depth.  (TrueBrilliance only)

    MENU_KEY.1={<menu>}
    MENU_KEY.2={<menu>}
        .
        .
    MENU_KEY.9={<menu>}
        Menu hotkey descriptions containing the set of menus for each key.
        Substitute {<menu>} with any combination of the below menu keywords
        separated by spaces.

        (e.g. MENU_KEY.2=Brush AnimBrush Distort)

        Menus Names:
            Airbrush
            Animation
            AnimBrush
            AntiAlias
            Brush
            Buffer
            Distort
            DrawMode
            Ellipse
            Gradient
            Grid
            Mirror
            Palette
            PenTip
            Rectangle
            Segment
            Stencil
            Transparency (or Transparent)
            Tweening

    SCREEN.MODEID=<modeid>
        Display mode id in hexadecimal.  Defaults to HIRESLACE(HAM) or
        LORES(HAM) depending on AGA and available memory.

        Since this item is saved by preferences, you don't really need to
        understand the magic numbers used here.  It's best to leave this
        alone if you don't understand it.

    SCREEN.WIDTH=1..16368
        Screen width in pixels.  Defaults to nominal dimensions for default
        mode.

    SCREEN.HEIGHT=1..16384
        Screen height in pixels.  Defaults to nominal dimensions for
        default mode.

    SCREEN.DEPTH=1..8
        Screen depth in bitplanes.  Defaults to maximum depth for default
        mode.

    SCREEN.OVERSCAN=Text|Graphics|Maximum|Video
        Overscan display clip description.


Program Control Items
---------------------

These item(s) control the operation of Brilliance and are read during
program startup.

    PATCH_TEST=On|Off
        Enables looking for SetPatchMrgCop during startup.  Defaults to On.


Initial Settings
----------------

These items are loaded during program startup, but are not saved with
Preferences.  They influence the initial state of many various program
settings.  You may enter any combination of these into the Brilliance and
TrueBrilliance icons to customize the initial state of the programs to
suit your taste.

    AIRBRUSH.FLOW=0..100
        Initial Airbrush flow setting.  Defaults to 100.

    AIRBRUSH.FOCUS=0..100
        Initial Airbrush focus setting (0 concentrated, 100 evenly
        distributed).  Defaults to 100.

    AIRBRUSH.SIZE=0..16384
        Initial Airbrush size.  Defaults to 30.

    BRUSH.AUTO_BG=On|Off
        Initial state of Brush menu AUTO BG gadget.  Defaults to Off.

    BRUSH.AUTO_REMAP=On|Off
        Initial state of Auto Remap on Text, Load Brush and Load Anim-Brush
        requesters.  Defaults to On.  (Brilliance only)

    BRUSH.HANDLE_CORNER=On|Off
        Initial favorite Brush handle type, On: Use most recently cut
        corner.  Off: Use center.  Defaults to Off.

    BRUSH.TILE_CUT=On|Off
        Initial state of Brush menu TILE CUT gadget.  Defaults to Off.

    ELLIPSE.CENTER_TO_CORNER=On|Off
        Initial state of Ellipse menu CENTER TO CORNER gadget.  Defaults to
        On.

    ELLIPSE.ROTATE=On|Off
        Initial state of Ellipse menu ROTATE gadget.  Defaults to Off.

    FAST_FEEDBACK=On|Off
        Initial state of primary menu FAST FEEDBACK gadget.  Defaults to
        Off if running on a 68020 or better, defaults to On otherwise.

    FILE.DRAWER.PICTURE=<drawer>
        Initial drawer name for Load/Save Picture.

    FILE.DRAWER.BRUSH=<drawer>
        Initial drawer name for Load/Save Brush.

    FILE.DRAWER.ANIM=<drawer>
        Initial drawer name for Load/Save Animation.

    FILE.DRAWER.ANIMBRUSH=<drawer>
        Initial drawer name for Load/Save Anim-Brush.

    FILE.DRAWER.STENCIL=<drawer>
        Initial drawer name for Load/Save Stencil.

    FILE.DRAWER.PALETTE=<drawer>
        Initial drawer name for Load/Save Palette.

    FILE.DRAWER.TWEEN=<drawer>
        Initial drawer name for Load/Save Tween Settings.

    FILE.DEFAULT_PALETTE=<file>
        Default palette file name (can be relative to FILE.DRAWER.PALETTE)
        Defaults to empty string which means to use built-in palette.

    FILE.LOAD_DITHER=On|Off
        Initial setting of Dither True Color gadget in Load Picture, Load
        Animation, Load Brush and Load Anim-Brush requesters.  Defaults to
        On.  (Brilliance only)

    FILE.SAVE_DEFAULT_TOOL=<program>
        Name of default tool to write with project icons.  Defaults to full
        path name for Brilliance or TrueBrilliance.

    FILE.SAVE_IMAGE_TYPE=HAM|TrueColor
        Initial image type for Save Picture and Brush.  HAM selects "HAM-6"
        or "HAM-8".  TrueColor selects "15-bit RGB" or "24-bit RGB".
        Defaults to HAM.  (TrueBrilliance only)

    FILE.SAVE_ANIM_TYPE=OP5|OP8W|OP8L
        Initial animation type for Save Animation.  Defaults to Op-5.

    GRID.X_OFFSET=0..999
        Initial grid menu X Offset.  Defaults to 0.

    GRID.Y_OFFSET=0..999
        Initial grid menu Y Offset.  Defaults to 0.

    GRID.WIDTH=1..999
        Initial grid menu Width setting.  Defaults to 16.

    GRID.HEIGHT=1..999
        Initial grid menu Height setting.  Defaults to 16.

    MAGNIFICATION.DIVIDE_PIXELS=On|Off
        Initial state of magnification "divide pixels" feature.  Defaults
        to On.  (Brilliance only)

    MAGNIFICATION.FACTOR=2..32
        Initial magnification factor.  Defaults to 4.

    PALETTE.BITS_PER_GUN=1..8
        Initial screen requester bits/gun setting.  Defaults to maximum.
        (Brilliance only)

    PALETTE.COLOR_MODEL=RGB|HSV|CMY
        Initial color model for palette menu sliders.  Defaults to RGB.

    RECTANGLE.CENTER_TO_CORNER=On|Off
        Initial state of rectangle menu CENTER TO CORNER gadget.  Defaults
        to Off.

    STENCIL.VARIANCE.H=0..100
    STENCIL.VARIANCE.S=0..100
    STENCIL.VARIANCE.V=0..100
        Initial state of stencil menu variance sliders.  Defaults to 10.
        (TrueBrilliance only)

    TEXT.FONT=<font name>
        Initial font name to use in text requester (e.g. CGTimes).
        Defaults to topaz.

    TEXT.SIZE=2..999
        Initial font size to use in text requester (e.g. 50).
        Defaults to 8.

    TEXT.DEFER_SCAN=On|Off
        When On, puts off scanning the font list until the user explicitly
        asks for it.  When Off, the font list is automatically scanned the
        first time the text requester is entered.  Defaults to Off.

    TEXT.ASPECT_CORRECTION=On|Off
        Initial state of text requester Aspect Correction gadget.  Defaults
        to On if available.

    TRANSPARENCY.MIXING=RGB|HSV
        Initial transparency menu mixing type.  Defaults to RGB.

    TRANSPARENCY.OPACITY=0..100
        Initial transparency menu opacity value.  Defaults to 50.


Sample tool type list for Brilliance:
-------------------------------------

SCREEN.OVERSCAN=Video
SCREEN.WIDTH=640
SCREEN.HEIGHT=400
MENU_KEY.1=Animation Buffer
MENU_KEY.2=AnimBrush Brush Distort
BRUSH.AUTO_BG=Off
BRUSH.HANDLE_CORNER=On
BRUSH.TILE_CUT=On
GRID.WIDTH=100
GRID.HEIGHT=50
PALETTE.COLOR_MODEL=HSV
RECTANGLE.CENTER_TO_CORNER=Off
FILE.DRAWER.PICTURE=work:brilliance/pictures
FILE.DRAWER.BRUSH=work:brilliance/brush
FILE.DRAWER.ANIM=work:brilliance/anim
FILE.DRAWER.ANIMBRUSH=work:artwork/animbrushes
FILE.DRAWER.STENCIL=work:stencils
FILE.DRAWER.PALETTE=work:artwork/palettes
FILE.SAVE_DEFAULT_TOOL=work:tools/brilliance
FILE.SAVE_ANIM_TYPE=OP8L
