$Id: README.agi,v 1.5 2001/09/02 02:37:58 almightyjustin Exp $




                   Sarien Sierra Adventure Game Interpreter
                                 Version 0.7





What Is Sarien?
===============
Sarien is a Sierra AGI resource interpreter engine that enables you to
play early Sierra On-Line(tm) AGI version 2 and version 3 games, as well
as AGI games written by other people.

It is being written to be very portable. It currently runs in MS-DOS,
several UNIX flavours (including Linux SDL, X11 and SVGAlib, BSD, IRIX,
Solaris and AIX), Win32 with native and SDL support and OS/2 XFree86.
Please contact the authors if you want to port it to a new platform.

Sarien is covered by the Free Software Foundation's GNU Public License
and is an open source development. Up to date information and anonymous
CVS is available at http://sarien.sourceforge.net/.


Command Line Switches
=====================
  -a --agds          Enables sarien to play AGDS created games.
  -A --amiga         Forces the game to be seen as an Amiga word padded game.
* -d --list-dictionary
                     List dictionary words.
  -E --emulate-sound {type}
                     Emulate the sound of Sierra AGI running in different
                     computers. Valid emulations are: pc, tandy and mac
  -F --full-screen   Run in full-screen mode if allowed by the graphics device
  -g --dga           Use XFree86 DGA extension (if available).
  -h --help          Display this help screen.
  -L --list-games    Display a list of all know AGI games.
  -n --no-sound      Disable sound output.
* -o --list-objects  List objects.
  -p --picture-viewer
                     Interactive picture viewer.
  -r --fix-aspect-ratio
                     Emulate IBM PC EGA 320x200 4:3 aspect ratio. Not
                     supported in all drivers.
  -S --scale {num}   Window size scale (only for windowed graphics).
  -v --emulate-version {version}
                     Force version to emulate. Valid v2 game versions are:
                     2.089, 2.272, 2.440, 2.917, 2.936. Valid v3 games are:
                     3.002.086, 3.002.149.
  -V --version       Display version information.
  -x --no-x-shm      Disable X shared memory extension (if available).


* These options are disabled in release 0.6.0 and will be back
  in future versions of sarien


Playing Games
=============
In order to play games, you will need,

	1) A Game or Demo
	2) A binary of Sarien.

For a AGI V2 games you only need the following files

	logdir
	object
	picdir
	snddir
	viewdir
	vol.*
	words.tok

For an AGI V3 game you need;

	*dir	(eg: bcdir, dmdir, grdir, kq4dir, mhdir)
	*vol.*	(eg: bcvol.*, dmvol.*, etc)
	object
	words.tok


Version Emulation
=================
Sierra Games currently ID'd:

    IBM-PC versions
	Black Cauldron (2.00)		2.439		 6/14/87
	Kings Quest 1 (2.0F)		2.917
	Kings Quest 2           	2.411
	Kings Quest 2 (2.2)    		2.917
	Kings Quest 3 (1.01)    	2.272		11/08/86
	Kings Quest 3 (2.00)    	2.435		 5/25/87
	Kings Quest 3 (2.14)    	2.936		 3/15/88
	Kings Quest 3 (2.14)    	2.936		 3/15/88
	Larry 1 (1.00)          	2.440		 6/1/87
	Mixed Up Mother Goose   	2.915
	Police Quest 1 (2.0A)   	2.911		10/23/87
	Police Quest 1 (2.0G)   	2.917		12/03/87
	Police Quest 1 (2.0G)   	2.917		12/03/87
	Space Quest 1 (1.0X)    	2.089
	Space Quest 1 (1.1A)    	2.272
	Space Quest 1 (2.2)     	2.426
	Space Quest 2           	2.912
	Space Quest 2 (2.0A)    	2.912
	Space Quest 2 (2.0C)    	2.915
	Space Quest 2 (2.0F)    	2.936
	XMAS Card 1986          	2.272
	Demo 1                  	2.915
	Demo 2                  	2.915
	Demo 3                  	2.917
	Demo 5                  	2.425
	Kings Quest 4 (v2.0)		3.002.086	 7/27/88
	Kings Quest 4 (v2.2)		3.002.086	 9/27/88
	Black Cauldron			3.002.098
	Demo 4				3.002.102
	Kings Quest 4 demo		3.002.102
	Manhunter 1 (1.22)		3.002.107	 8/31/88
	Manhunter 2 (3.02)		3.002.149	 7/26/89
	Gold Rush (5.25)		3.002.149
	Gold Rush (3.5)			3.002.149
	GR (Cracked) (3.5)		3.002.149
	GR (Cracked) (5.25)		3.002.149


    Apple IIgs versions
	Kings Quest 1 (1.0S-88223)	2.272
	Mixed Up Mother Goose		2.917
	Police Quest 1 (2.0A)		2.917
	Demo Disk 1.0C (Censored)	2.917 (guessed)
	Black Cauldron 1.0O		3.002.149	 2/24/89
	Manhunter New York 2.0E		3.002.149	10/05/88


    Apple Macintosh versions
	Kings Quest 1 (2.0C)		2.440
	Kings Quest 2 (2.0R)		2.440
	Larry 1 (1.05)                  2.440		 6/26/87
	Space Quest 2 (2.0D)		2.936


    Atari ST versions
	Donald Duck's Playground 1.0C	2.272		 8/08/86


    Amiga versions
	Kings Quest 2 (2.0J)		2.440
	Space Quest 2 (2.0F)		2.936
	Leisure Suit Larry 1 (1.05)	2.440		 6/26/87


    AGDS games
	Groza, AGDS sample game		2.440


    Notes
    	Space Quest 1 v2.426 and v2.917 are 100% identical with the
        exception of the version of the interpreter used to play them.
        Since 2.917 is the same as 2.426, I use 2.426 as the
        emulation.

	Leisure Suit Larry 1 v2.440 and v2.917 have 100% identicle
        files, just 'agi' is different. Since they are the same, I
        choose to emulate v2.440, even for the 2.917 version of the
        game.  Since they are the same it should work ok.



Copy protection
===============
Original Sierra adventure games employed copy protection in various
different schemes on several architectures.

* Key Disk
The most common for of copyproection most Sierra gamers will be familiar
with, is the key disk copyprotection of 99% of the early AGI games.

Since this copyprotection was part of the Sierra interpreter and not a
part of the actual game data files (defeating it required creating a
hacked version of sierra.com/sierra.exe), when these games are played
by Sarien, there is in effect, no copyprotection at all.

* Manual Protection
Some later games required information that was part of the
documentation that came with the games, which included games such as
Police Quest 1, Gold Rush, Kings Quest 4, Manhunter and Space Quest.

Games such as Police Quest 1 and Space Quest made the copyprotection
part of the game itself and can't be bypassed (ie: Drink Driving
procedures in Police Quest 1).

You will still need the manuals/documentation to complete these games.

For other games mentioned such as Kings Quest 4 AGI, Gold Rush etc,
Sarien can activly detect and bypass this protection.

NOTE: Sarien must be compiled with this option set in order for it to
work.

This can be tested by running sarien with the '-V' option.

And yes, it works on the Leisure Suit Larry questionaire ^_^


Unidentified Games
==================
Unidentified games are emulated with the 'standard' system for that
AGI version.

    	For V2 AGI games its v2.917
    	For V3 AGI games its 3.002.149

These are the most 'common' versions around for v2 and v3 games.


Differences between Sarien and Sierra AGI
=========================================
- "Fastest" speed is not available. Reasons: the effect is quite silly
  and potentially dangerous -- in modern computers it makes ego run
  at light speed and makes the game unplayable anyway. In
  multitasking systems "fastest" throws the system load at 100%. As a
  side effect, the "SIERRA" word in the Sierra demopack intros will
  pulse in a gentle, pleasant rhythm instead of the epilepsy-inducing
  stroboscopic effect of the "fastest" mode.

- System console. A transparent "Quake console" is available pressing
  the ` key. SHIFT-` toggles game input when the console is active.
  AGI commands can be issued directly in the console, use "help" for
  a list of available commands.

- (more to come)


Credits
=======
Sarien is being written by a loony bunch of people working in their
spare time to squash bugs and add new features. See the AUTHORS file
for the credits list.

$Id: README.djgpp,v 1.1 2001/07/01 04:40:44 cmatsuoka Exp $

To build sarien using DJGPP, run make -f Makefile.dj from the toplevel
source directory.

$Id: README.macos,v 1.3 2001/07/20 00:52:30 cmatsuoka Exp $

Notes on building Sarien using MPW
==================================

The supplied Sarien.make makefile uses SC and ILink to build a m68k binary.
To build Sarien with MPW, set the current directory to the top of the sarien
tree and run 'make -f Sarien.make' in the MPW Shell. Sarien.make must have
type 'TEXT' and creator ID 'MPS ' (you can use an utility such as FileTyper
to change the type and creator ID).


Acknowledgments
===============

The MacOS port of Sarien uses portions of ImageMagick.

ImageMagick is Copyright (C) 2001 ImageMagick Studio, a non-profit
organization dedicated to making software imaging solutions freely
available.

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files ("ImageMagick"),
to deal in ImageMagick without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of ImageMagick, and to permit persons to whom the
ImageMagick is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of ImageMagick.

The software is provided "as is", without warranty of any kind, express or
implied, including but not limited to the warranties of merchantability,
fitness for a particular purpose and noninfringement.  In no event shall
ImageMagick Studio be liable for any claim, damages or other liability,
whether in an action of contract, tort or otherwise, arising from, out of
or in connection with ImageMagick or the use or other dealings in
ImageMagick.

Except as contained in this notice, the name of the ImageMagick Studio
shall not be used in advertising or otherwise to promote the sale, use or
other dealings in ImageMagick without prior written authorization from the
ImageMagick Studio.

Date: Sun, 02 Sep 2001 21:31:14 -0700
From: Vasyl Tsvirkunov <vasyl@pacbell.net>
Subject: Re: Sarien Pocket PC port

All files reside in folder eVC3 which should be placed at the top of
the Sarien directory tree, like VC++6.0. The only C++ compiler for
PocketPC is eMbedded Visual C 3.0, hence the name of that folder.

This is kind of "first public" version of the port. Source has quite
some rough edges. Two files are C++ not C because of somebody's stupid
decision to compile the only avalaible version of fast graphics
extensions for PocketPC (GAPI) as DLL with C++ name mangling. De-mangling
it from C code is extremely tedious and unreliable.

Winmain.cpp is a somewhat hacked version of Win32 port file. Wince.cpp
is heavily modified but still recognizeable win32.cpp from the Win32 port.
Sound_wince.c is only slightly modified Win32 sound code (I will have to
communicate with that port author -- usually it is possible to get the
same code perfectly working on both platforms). Unix implementation is
used for file operations. A few other files are filling some gaps in
PocketPC C library -- it is not ANSI-compliant. Some files are actually
from my other project Pocket Atari (Atari800 port to PocketPC), one of
the reasons why this port took only a few hours.

There is one thing that I cannot include with this source update.
eVC3/gapi directory is reserved for GAPI SDK. It is freely downloadable
from MS site and every PocketPC developer knows about it but I could
not figure exact redistribution policy on that.

$Id: README.ports,v 1.19 2001/09/17 02:26:42 cmatsuoka Exp $

Tested ports:

                  Graphics   Sound    Windowed  Fullscreen
         Compiler  Driver    Driver   Graphics  Graphics  Aut/Maint.
---------+-------+---------+---------+---------+---------+---------+
 MS-DOS  |Watcom | Raw VGA |  dummy  |    no   |   yes   | Stuart  |
 MS-DOS  |Turbo C| Raw VGA |  dummy  |    no   |   yes   | claudio |
---------+-------+---------+---------+---------+---------+---------+
 Linux   |  gcc  |   X11   |OSS,ALSA |   yes   |    no   | claudio |
 Linux   |  gcc  | SVGAlib |OSS,ALSA |    no   |   yes   |  XoXus  |
 Linux   |  gcc  |   SDL   |   SDL   |   yes   |   yes   |  Ryan   |
 FreeBSD |  gcc  |   X11   | freebsd |   yes   |    no   |  Joep   |
 NetBSD  |  gcc  |   X11   |   BSD   |   yes   |    no   |         |
 Solaris |  gcc  |   X11   | solaris |   yes   |    no   |         |
 AIX 4   |  gcc  |   X11   |  dummy  |   yes   |    no   |         |
 IRIX    |MIPSpro|   X11   |   sgi   |   yes   |    no   | aheikin |
---------+-------+---------+---------+---------+---------+---------+
 BeOS 5  |  gcc  |   SDL   |   SDL   |   yes   |   yes   | claudio |
---------+-------+---------+---------+---------+---------+---------+
 MacOS X |   ?   |  Cocoa  |  dummy  |   yes   |    ?    |drzoltan |
---------+-------+---------+---------+---------+---------+---------+
 QNX	 |   ?   |  Photon |    ?    |    ?    |    ?    | jpenner |
---------+-------+---------+---------+---------+---------+---------+
 Windows |Mingw32|   DIB   |  dummy  |   yes   |    no   |rosinha, |
 Windows*|Mingw32|   SDL   |   SDL   |   yes   |   yes   |igor,matt|
 Windows |  VC++ |   DIB   |  WinMM  |   yes   |    no   |justin,  |
 Windows |Cygwin |   DIB   |  WinMM  |   yes   |    no   |ryan&more|
---------+-------+---------+---------+---------+---------+---------+
 WinCE   | eVC3  |  WinCE  |  WinCE  |    no   |   yes   |  Vasyl  |
---------+-------+---------+---------+---------+---------+---------+
 OS/2    |  gcc  |   X11   |  dummy  |   yes   |    no   | Martin  |
---------+-------+---------+---------+---------+---------+---------+
 Amiga   |  gcc  |  amiga  |   AHI   |   yes   |   yes   |Paul Hill|
 Amiga   | DICE  |  amiga  |  dummy  |   yes   |   yes   | claudio |
---------+-------+---------+---------+---------+---------+---------+

The Linux/X11 driver is known to work in the following architectures:
IA32 (i386), PowerPC, IA64, S/390 and Alpha. The NetBSD, FreeBSD and
BeOS ports have been tested on IA32. The Solaris port has been tested
on Sparc.


Not integrated to the main tree:

                  Graphics   Sound    Windowed  Fullscreen
         Compiler  Driver    Driver   Graphics  Graphics    Sound
---------+-------+---------+---------+---------+---------+---------+
 Acorn   |   ?   |    ?    |    ?    |    ?    |    ?    |    ?    |
---------+-------+---------+---------+---------+---------+---------+
 Atari   |   ?   |    ?    |    ?    |    ?    |    ?    |    ?    |
---------+-------+---------+---------+---------+---------+---------+


Untested, expected to work:

                  Graphics   Sound    Windowed  Fullscreen
         Compiler  Driver    Driver   Graphics  Graphics    Sound
---------+-------+---------+---------+---------+---------+---------+
 OpenBSD |  gcc  |   X11   |   BSD   |   yes   |    no   |    no   |
 HP-UX   |  gcc  |   X11   |  dummy  |   yes   |    no   |    no   |
 IRIX    |  gcc  |   X11   |   sgi   |   yes   |    no   |   yes   |
---------+-------+---------+---------+---------+---------+---------+


In progress:

                  Graphics   Sound    Windowed  Fullscreen
         Compiler  Driver    Driver   Graphics  Graphics    Sound
---------+-------+---------+---------+---------+---------+---------+
 MS-DOS  | DJGPP | allegro | allegro |    no   |   yes   |   yes   |
---------+-------+---------+---------+---------+---------+---------+
 Linux   |  gcc  |XF86 DGA |OSS,ALSA |    no   |   yes   |   yes   |
---------+-------+---------+---------+---------+---------+---------+
 MacOS   |  MPW  |  macos  |  macos  |   yes   |    no   |   yes   |
---------+-------+---------+---------+---------+---------+---------+


Incomplete, assistance required:

                  Graphics   Sound    Windowed  Fullscreen
         Compiler  Driver    Driver   Graphics  Graphics    Sound
---------+-------+---------+---------+---------+---------+---------+
 OS/2    |   ?   |  DIVE   |  DART   |   yes   |    no   |   yes   |
---------+-------+---------+---------+---------+---------+---------+


Planned:
                  Graphics   Sound    Windowed  Fullscreen
         Compiler  Driver    Driver   Graphics  Graphics    Sound
---------+-------+---------+---------+---------+---------+---------+
 PalmOS  |  gcc  |  palm   |  palm   |    no   |   yes   |   yes   |
---------+-------+---------+---------+---------+---------+---------+

$Id: README.sdl,v 1.2 2001/06/24 19:16:19 cmatsuoka Exp $

Sarien now has an experimental support for SDL. To enable it configure
using './configure --with-sdl'.

SDL is available at http://www.libsdl.org/.

The current version of SDL supports Win32 WinDIB/DirectX, BeOS BWindow, and
Linux X11/DGA. If you have a newer PC, SDL may be able to take advantage
acceleration using assembly routines from the Hermes blit library.

You can cross-compile sarien from Linux to Win32 using SDL and Xmingw32,
available in the SDL site. See README.win32 for more details.

$Id: README.svgalib,v 1.3 2001/06/30 16:21:14 cmatsuoka Exp $

The SVGALib port is pretty simple (except for some keyboard stuff). Any
problems are more likely to be interpreter problems than SVGALib problems.
Send any problems with the interpreter to Dark Fiber, but if you are sure
it's SVGALib related, you can send it to me (XoXus).


System requirements
===================

GNU make, gcc, svgalib package, AGI game files.

The video mode used is 320x200 at 256 colors, which should run on any
machine at all.

A reasonably recent SVGAlib package is recommended if sound support is
enabled.


Building
========

Step 1
------
Run "./configure --with-svgalib" [without the quotes]

Step 2
------
Run "make"

Step 3
------
Run "chown root bin/sarien"

Step 4
------
As root, run "chmod u+s bin/sarien". This is needed for SVGALib to change
video modes.

$Id: README.turboc,v 1.2 2001/07/02 18:25:55 cmatsuoka Exp $

To build sarien using Turbo C 3.0, run make -f Makefile.tc from the
toplevel source directory. Older versions of Turbo C may work with
Makefile.tc1.

$Id: README.unix,v 1.4 2001/09/07 05:45:29 cmatsuoka Exp $

System requirements
===================

GNU make, gcc, X Window System, Open Sound System or ALSA and supported
sound card, AGI game files. POSIX threads (and a thread-safe X server)
are needed for sound support.

A Linux SVGAlib driver written by XoXus is now available, see README.svgalib
for more information.

This initial port is being tested on an i386 Debian GNU/Linux box with
glibc running kernel 2.4.5 on a 333 MHz K6 machine. It should work with
24/16/15 bpp true color and 8 bpp pseudo color servers.


Building
========

Run "./configure", then "make". Should any problems happen, have a look
at the generated Rules file and drop me a note so I could fix it in
future versions.


Problems
========

If sarien ends and prints no message about detaching an X shared memory
segment, remove the segment manually using ipcs(1) and ipcrm(1).


Sound
=====

Sarien has three-channel digital sound support for Linux using OSS or
ALSA, Solaris and IRIX. It works only with 22 kHz, 16 bit mono sound
(it should be flexible but I'm too lazy to do it now).

IIgs PCM sound is now supported thanks to Ian Schmidt <irsman@iag.net> and
Paul Lunga <paul123@freenet.tlh.fl.us>. MIDI is not supported yet.


Known bugs
==========

Lots. See the Bugs file for the list of outstanding features.

$Id: README.win32,v 1.4 2001/09/08 04:25:12 almightyjustin Exp $

A Win32 version of Sarien can be built using SDL or the native Win32
port written by Felipe Rosinha <rosinha@dexter.damec.cefetpr.br>.

To run Sarien from the Windows Explorer, drag and drop the AGI
game folder onto the Sarien executable.

To compile the SDL version, check README.sdl for more information.

To build the native Win32 version using Mingw32, copy Rules.mingw32
from rulesets\ to the toplevel folder, rename it "Rules" and run
"make".

To build using Cygwin, run "autoconf", "./configure", then "make".

To build using Visual C++ 6.0, use the project files in the VC++6.0
directory.

Mingw32 and related GNU utilities are available at
http://agnes.dida.physik.uni-essen.de/~janjaap/mingw32/download.html

Cygwin and related GNU utilities are available at
http://www.cygwin.com/