@database "Solitarexx v1.1"
@width 80
@$VER: Soltarexx.guide 1.0 (18.07.97)

@node MAIN "Solitarexx 1.1 Documentation"

      Your guide to
@{b}
   #####   #####  ##     ## ######  #####  ######  ###### ##   ## ##   ##
  ##   ## ##   ## ##     ##   ##   ##   ## ##   ## ##     ##   ## ##   ##
  ##      ##   ## ##     ##   ##   ##   ## ##   ## ##      ## ##   ## ##
   #####  ##   ## ##     ##   ##   ####### ######  ####     ###     ###
       ## ##   ## ##     ##   ##   ##   ## ##  ##  ##      ## ##   ## ##
  ##   ## ##   ## ##     ##   ##   ##   ## ##   ## ##     ##   ## ##   ##
   #####   #####  ###### ##   ##   ##   ## ##   ## ###### ##   ## ##   ##
                                                                      v1.1
@{ub}
                      (c) 1996, 1997 Michal Szafranski

What's this?
 @{" Introduction               " link INTRODUCTION}
 @{" Features                   " link FEATURES}
 @{" Requirements               " link REQUIREMENTS}
 @{" Archive contents           " link ARCCONTENTS}
 @{" Installation               " link INSTALLATION}

I've installed it.
 @{" Starting and Usage         " link STARTING}
 @{" Availiable solitaires      " link SOLITAIRES}
 
I wanna more.
 @{" Creating cardsets          " link MAKECARDSET}
 @{" Creating new games         " link AREXX }
 @{" Avaliable arexx commnads   " link COMMANDS }
 @{" Programming tutorial       " link TUTORIAL }

Author's corner:
 @{" History                    " link HISTORY}
 @{" Future                     " link FUTURE}
 @{" Distribution               " link DISTRIBUTION}
 @{" Author                     " link ADDRESS}
 @{" SXCS Format                " link SXCS }

@endnode

@node DISTRIBUTION "Distribution"

 This software is subject to the "Standard Amiga FD-Software Copyright Note".
 It is CARDWARE as defined in paragraph 4c.
 For more information please read @{"AFD-COPYRIGHT" link AFD-COPYRIGHT/main} (Version 1 or higher).
 
 Click if you want to contact the author. @{" Sure I want " link ADDRESS}
@endnode
@node ARCCONTENTS "Archive contents"

 Solitarexx 1.1 archive contents:
	Docs.info
	Scripts.info
	Solitarexx
	Solitarexx.info
	sx.prefs
	Utils.info
	<dir> Cardsets
		def.08.cs
		def.10.cs
		def.16.cs
		def.h08.cs
		def.h10.cs
		def.h16.cs
	<dir> Docs
		AFD-COPYRIGHT
		AFD-COPYRIGHT.pl
		English.guide
		English.guide.info
		Polish.guide
		Polish.guide.info
	<dir> Scripts
		Basement.srx
		Basement.srx.info
		Demon.srx
		Demon.srx.info
		FrenchScarf.srx
		FrenchScarf.srx.info
		Golf.srx
		Golf.srx.info
		KingAlbert.srx
		KingAlbert.srx.info
		Klondike.srx
		Klondike.srx.info
		Klondike2D.srx
		Klondike2D.srx.info
		Maze.srx
		Maze.srx.info
		Metternich.srx
		Metternich.srx.info
		MonteCarlo.srx
		MonteCarlo.srx.info
		MonteCarlo2D.srx
		MonteCarlo2D.srx.info
		NinetyOne.srx
		NinetyOne.srx.info
		Parade.srx
		Parade.srx.info
		Quadrille.srx
		Quadrille.srx.info
		SirTommy.srx
		SirTommy.srx.info
		Spaces.srx
		Spaces.srx.info
		Spaces2D.srx
		Spaces2D.srx.info
		Spider.srx
		Spider.srx.info
		Tress.srx
		Tress.srx.info
		Triples.srx
		Triples.srx.info
		Tutorial.srx
	<dir> Utils
		MakeCardset
		SetCardsetMode
		SetCardsetMode.info

@endnode
@node INTRODUCTION "Introduction"

  Solitarexx is another soliaire program. Now you can play your favourite
 solitaries using one program.
  The executable only handles cards and gui displaying on the screen. All
 the game stuff is controlled by scripts written in arexx.
  Solitarexx have its own cardsets graphic format (@{"SXCS" link SXCS}) which
 can be created using MakeCardset. Cards in this format can have different
 sizes so Solitarexx can be used with non-proportional screen resolutions
 like Hires.
  You can also use your favourite REKO Klondkie cardset. In this case you
 must choose a resolution with 1:1 pixel aspect.

@endnode

@node FEATURES "Features"

 - low system requirements (except OS - 3.0 or later),
 - small program size <20K,
 - many games in one,
 - screen resolution selectable with ASL requester,
 - font sesitive and screen size sesitive gui,
 - using card graphics from REKO Klondike II and III or in SXCS multi
   size format,
 - with some arexx programming knowlage you can create your own
   solitare or any other card game.

@endnode
@node REQUIREMENTS "Requirements"

    - any Amiga with OS 3.0 or higher,
    - RexxMast running in system,
    - from 0.5 to 1.5 MB of free memory (according to used cardset file)
    - a hard drive (not necessary but if you want install this on a floppy
      you must do it by hand)

@endnode
@node SXCS "SXCS Format Specification"

  If you want to make your own SXCS creator, viewer or datatype here
 comes full specification.

 Every SXCS file consists of three parts:
 1.Header, 38 bytes  (fields listed as a C stucture)
    struct SXCS_Head {
        ULONG id;           - always 'SXCS'
        ULONG datasize;     - data size in bytes (2+3)
        ULONG cardsize;     - single card graphics size
        WORD height, width; - height and width of a card
        ULONG viewmode;     - screen mode prefered for this cardset
        UBYTE depth;        - number of bitplanes
        UBYTE maxcard;      - number of cards in set (datasize/cardsize)
        WORD spcx, spcy;    - spaces between colums and rows in pixels
        WORD maxx, maxy;    - maximum visible part of card in rows and
                              column (must be lower than half of card
                              height/width)
        ULONG reserved1;    - always 0
        ULONG cardsptr;     - palette size in bytes (2)
    };
 2.Color palette - 8 bits per gun, copy of CMAP hunk.
 3.Cards graphics in raw format used by intuition DrawImage (data WORD
   aligned). Images order is same as MakeCardset file order.

@endnode
@node INSTALLATION "Installation"

  In order to install Solitarexx on your hard drive copy all archive
 contents to desired directory.
  Notice that becouse of arexx interface you @{u}must@{uu} have RexxMast
 running in your system before starting Solitarexx. You can start RexxMast
 either by double-clicking on its icon (should be in 'System' drawer of
 your booting partition) every time you want to play Solitarexx or (prefered)
 by adding following line to your UserStrtup file.
   SYS:System/RexxMast >NIL:
@endnode
@node STARTING "Starting and usage"
  Becouse Solitarexx is useless without arexx scripts you mast have
 one before starting (some are included in 'Scripts' directory).
  There are sevaral ways of starting a script:
 1. Double click on Solitarexx icon. In this way Solitarexx will start
    the script from preferences 'Startup' field.
 2. Double click on the choosen script icon (it works only if Solitarexx
    executable file name with full path is present in scripts icon Default
    Tool field).
 3. Click on Solitarexx icon then holding 'shift' key double clik on
    the script icon.
 4. Starting from CLI or Shell give script name with path as a parameter.

  There are only 3 permanent gadgets on Solitarexx screen:
 @{b}Load Game@{ub}  - at any time you can select other game script using
   ASL requester

 @{b}Quit@{ub} - leaves the program.

 @{b}Prefs@{ub} - enters the setup window where you can change:
    * Cardset - used cardset file,
    * Startup - arexx script loaded at stratup,
    * Screen Mode:
       - Cardset - screen mode will be taken from cardset file (can be
         changed with SetCardsetMode program),
       - Custom - screen mode can be set using asl requester
    * Screen Font.
 While play you can hide and show gadget window using right mouse button.

@endnode
@node ADDRESS "Where's the author?"

 e-mail:
    ms174761@students.mimuw.edu.pl

 snail:
    Michal Szafranski
    ul. Korczaka 21/15
    08-400 Garwolin
    POLAND

@endnode

@node HISTORY "History"

Soritarexx History

 v1.1
    - WHICHCARD, ERRBEEP, REDRAW changed,
    - screen mode also affects main screen,
    - screen font selection,
    - GUI is now screen size and font sensitive,
    - more CYCLE features,
    - added some error handling,
    - scripts as CLI or Workbench parameters,
 v1.00 14.07.97
    - CLEANUP, GETGADGET, CARDREVERSE - new rexx commands
    - CARDSELECT code rewritten + features added
    - SELECTGUI - bitmask as param instead of first line and length
    - full working versions of Klondike and Demon scripts
 v0.50 08.07.97
    Phew, most of features are working. Arexx includes 14 basic
    commands. Support for 3 gadget types (button, text and cycle).
 v0.00 - v0.10  07.96
 v0.11 - v0.16  05.97 - 06.97

@endnode

@node FUTURE "What in future versions?"

 - sound effects as 8SVX files,
 - more gadget support (STRING, INTEGER, CHECKBOX),
 - script preferences saved with program preferences (highscores,
   gadget states, game position saving),
 - object oriented cardstocks positioning (like gadgets in MUI).

 If you are interested in future versions of this program contact
 the author.
@endnode