@database AmiSGE.guide
@$VER: AmiSGE v1.00 documentation (c) 1999 John Girvin/Halibut Software 
@rem -----------------------------------------------------
@node main "AmiSGE - main index"
@{b}
 AmiSGE v1.00
 Amiga Frontier:Elite II Saved Game Decoder/Encoder

 (c) 1999 John Girvin/Halibut Software
@{ub}

    @{" Description                  " link description}
    @{" Licence and Distributability " link legalguff} @{b}IMPORTANT!@{ub}

    @{" Requirements                 " link requirements}

    @{" Installation                 " link installation}
    @{" Usage                        " link usage}

    @{" Saved Game File Format       " link format}

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

@endnode

@rem -----------------------------------------------------
@node description "AmiSGE - product description"
@toc main

@{b}@{u}AMISGE DESCRIPTION@{uu}@{ub}

  This is version 1.00 of a program to decode the saved games produced
  by the Amiga version of "Frontier:Elite II" to raw binary files and also
  encode raw files back into a form that will be recognised by the game.

  In this way saved games may be decoded, edited with a binary file editor
  (not supplied!) and then encoded again ready for use in the game.

  Saved games from all versions of Amiga Frontier are supported. Savegames
  from the PC version of Frontier are not supported.

@endnode

@rem -----------------------------------------------------
@node legalguff "AmiSGE - licence and distributability"
@toc main

@{b}@{u}AMISGE LEGAL INFORMATION@{uu}@{ub}

  These are the licence and distribution conditions for AmiSGE.

  Using the package implies that you agree with and submit to these
  conditions. If you do not agree with the conditions laid out below
  you are not permitted to use AmiSGE and must delete any
  and all files in your possession related to it @{u}NOW!@{uu}


@{b}@{u}AMISGE LICENCE CONDITIONS@{uu}@{ub}

  AMISGE IS PROVIDED "AS IS" AND IS USED AT YOUR OWN RISK

  NO GUARANTEES ARE GIVEN, NOR SHOULD ANY BE INFERRED

  The author cannot be held liable for any loss or damage caused by the use
  or misuse of this package


@{b}@{u}AMISGE DISTRIBUTION CONDITIONS@{uu}@{ub}

  AmiSGE is (c) 1999 John Girvin/Halibut Software

  This package is freely distributable, provided that all files that are part
  of the package are included unchanged in any distribution and no more than
  minimal handling and/or media costs are charged.

@{b}
  AmiSGE is released as "DONATIONWARE": no payment to the author is
  required to use this product, but donations are always welcomed!
@{ub}
@endnode


@rem -----------------------------------------------------
@node requirements "AmiSGE - product requirements"
@toc main

@{b}@{u}AMISGE REQUIREMENTS@{uu}@{ub}

  * An Amiga capable of running the Frontier: Elite II game

  * Some Frontier: Elite II saved games (Commanders) to process

  * A binary file editor to modify the decoded saved games.
    "AZap" from Aminet is highly recommened, but any binary file
    editing utility may be used.

@endnode


@rem -----------------------------------------------------
@node installation "AmiSGE - product installation"
@toc main

@{b}@{u}INSTALLING AMISGE@{uu}@{ub}

  1. Copy the "AmiSGE" program to your system. That is all!

@endnode


@rem -----------------------------------------------------
@node usage "AmiSGE - product usage"
@toc main

@{b}@{u}AMISGE USAGE@{uu}@{ub}

  Usage is from command line only.
  All parameters are case-insensitive and mandatory.

  AmiSGE DECODE|ENCODE FROM=<source file> TO=<destination file>

  @{b}DECODE@{ub}
    Decode a Frontier Commander file to raw binary form.
    Mutually exclusive with ENCODE.

  @{b}ENCODE@{ub}
    Encode a raw binary file to a valid Frontier Commander file.
    Mutually exclusive with DECODE.

  @{b}FROM@{ub}
    Specifies the file to use as a data source for the specified
    DECODE or ENCODE operation. If DECODE is specified, this file must
    be a valid Frontier Commander file; if ENCODE is specified this
    file must be a file originally produced by the DECODE operation
    of AmiSGE, possibly with changes made by the user.

  @{b}TO@{ub}
    Specifies the file to use as the destination for the output of
    the specified DECODE or ENCODE operation. If DECODE is specified,
    this file will receive the decoded, raw binary form of the input
    savegame; if ENCODE is specified this file will receive the valid
    Frontier Commander data.


@{b}@{u}USAGE EXAMPLE@{uu}@{ub}

  @{b}AmiSGE DECODE FROM=GAMES:Frontier/saves/Jameson TO=RAM:Jameson.raw@{ub}

  Decode the Commander file GAMES:Frontier/saves/Jameson and write the
  raw binary version to RAM:Jameson.raw


  <at this point you make your changes to the data in RAM:Jameson.raw>


  @{b}AmiSGE ENCODE FROM=RAM:Jameson.raw TO=GAMES:Frontier/saves/NewJameson@{ub}

  Encode the raw binary file RAM:Jameson.raw to a valid Frontier Commander
  and save it as GAMES:Frontier/saves/NewJameson. This file may now be
  loaded into Frontier with the "Load Commander File" option.

@endnode


@rem -----------------------------------------------------
@node format "AmiSGE - saved game file format"
@toc main

@{b}@{u}FRONTIER SAVED GAME FILE FORMAT@{uu}@{ub}

  The DECODE operation of AmiSGE produces a file that is 64K in length
  containing the decoded Commander data.

  Frontier refuses to run on my system any more so I am unable to tell
  you anything about how this data is organised - you will have to
  experiment to find out for yourself! The text file included from the
  PC "SGE" program may be of some assistance, but the Amiga saved game
  format is not guaranteed to be the same as the PC.

  Always keep a backup of the original Commander file, just in case.

  Please @{"contact me" link author} with any information you uncover regarding
  the format of the decoded Amiga saved game files! Your help is appreciated.

@endnode


@rem -----------------------------------------------------
@node history "AmiSGE - project history"
@toc main

@{b}@{u}AMISGE PROJECT HISTORY@{uu}@{ub}

    1.00  12/99
          - first version, released to Aminet

@endnode


@rem -----------------------------------------------------
@node future "AmiSGE - future developments"
@toc main

@{b}@{u}FUTURE DEVELOPMENTS@{uu}@{ub}

  * get Frontier working on my system so I can experiment with saved
    games to determine how they are organised!

  * add a second decoding mode that interprets the decoded data and
    reorganises it so that it is easier to edit with a hex editor

  * build a GUI around AmiSGE that allows users to edit Commander
    data more easily. Anyone want to volunteer?


  Please @{"contact the author" link author} with any ideas you would
  like to see added to AmiSGE.

@endnode


@rem -----------------------------------------------------
@node author "AmiSGE - author and contact information"
@toc main

@{b}@{u}AMISGE AUTHOR INFORMATION@{uu}@{ub}

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

  @{b}E-Mail:@{ub}    girv@girvnet.freeserve.co.uk
             PGP5.0 public key available

  @{b}WWW:@{ub}       http://www.girvnet.freeserve.co.uk
             Latest version always available from here!

@{b}
  You are more than welcome to donate some spare pennies
  to this project!
@{ub}
          
@endnode


@rem -----------------------------------------------------
@node acknowledge "AmiSGE - acknowledgements"
@toc main

@{b}@{u}AMISGE ACKNOWLEDGEMENTS@{uu}@{ub}

  * "Frontier: Elite II" is (c) 1993 GameTek / David Braben

  * AmiSGE is developed using SAS/C 6.59

  * Although AmiSGE was written from scratch, the source code
    to the PC "SGE" program proved useful during development.
    Big thanks to Steve Critchlow, author of the PC version
    for sending me the code!

  * Musical support provided by DJ Adz
    http://www.adznet.freeserve.co.uk/

@endnode