View source for Sarien

<div align="center"><span style="font-size: 22pt">Sarien</span><br />''Version 0.8.0''<br />''Authors: [[Sarien Team]]''<br />''2004-07-21''</div></div>

{{FanAGISoftwareInfobox
| Software = Sarien
| Image = [[Image:SarienSS.png|190px]]<br />
''Sarien Loading Screen''
| Version = 0.8.0
| ReleaseDate = {{2014S}}-01-02<ref>[https://github.com/cmatsuoka/sarien/commit/aaef5e667757385b5b3650cc1f7365908720f7e6 sarien.sourceforge.net/ (web archive)]</ref>
| Company = {{NAToolCo}}
| DevStatus = {{MergedDev}}
| Published = {{Published}}
| Developers = {{SarienTeamToolDev}}<!--{{StuartGeorgeToolDev}}, {{LanceEwingToolDev}}, {{ClaudioMatsuokaToolDev}}, {{FelipeRosinhaToolDev}}, {{XoXusToolDev}}, {{IgorNesterovToolDev}}, {{AriHeikkinenToolDev}}, {{JoshuaNealToolDev}}, {{SadRejebToolDev}}, {{RobertBihlmeyerToolDev}}, {{RyanGordonToolDev}}, {{MagnusKristiansenToolDev}}, {{JeremyPennerToolDev}}, {{PeterHawkinsToolDev}}, {{JustinKerkToolDev}}, {{MattHargettToolDev}}, {{IanHanschenToolDev}}, {{ZivBarberToolDev}}, {{RichardHouleToolDev}}, {{PaulHillToolDev}}, {{VasylTsvirkunovToolDev}}, {{ThomasAkessonToolDev}}-->
| Interface = {{GUI}}
| ProgLanguage = {{C++}}
| OpenSource = {{OpenSRC}}
| Source = {{SourceSW}}
| License = {{GPL2}}
| Type = {{FanThirdPartyAGIInterp}}
| Engine = {{AGITool}}
| Platform = {{WinTool}}, {{DOSTool}}, {{MacTool}}, {{LinuxTool}}, {{BeOSTool}}, {{AmigaTool}}, {{IRIXTool}}
| Localization = {{EnglishTool}}
| Website = [[wayback:20060411094142/http://sarien.sourceforge.net/|sarien.sourceforge.net/]] (web archive)
}}
<!-- Devs: -->
{{StuartGeorgeToolDevH}}{{LanceEwingToolDevH}}{{ClaudioMatsuokaToolDevH}}{{FelipeRosinhaToolDevH}}{{XoXusToolDevH}}{{IgorNesterovToolDevH}}{{AriHeikkinenToolDevH}}{{JoshuaNealToolDevH}}{{SadRejebToolDevH}}{{RobertBihlmeyerToolDevH}}{{RyanGordonToolDevH}}{{MagnusKristiansenToolDevH}}{{JeremyPennerToolDevH}}{{PeterHawkinsToolDevH}}{{JustinKerkToolDevH}}{{MattHargettToolDevH}}{{IanHanschenToolDevH}}{{ZivBarberToolDevH}}{{RichardHouleToolDevH}}{{PaulHillToolDevH}}{{VasylTsvirkunovToolDevH}}{{ThomasAkessonToolDevH}}{{EugeneSandulenkoToolDevH}}
<!-- Thanks: -->
<!--{{IIgs/Mac/Tandy sound samples & AGI resources: -->{{PaulLungaC}}
<!--{{IIgs sound documentation: -->{{IanSchmidtC}}
<!--{{Object repositioning information: -->{{NatBudinC}}
<!--{{AGI internals consultant: -->{{NickSonneveldC}}
<!--{{Debian package maintainer: -->{{PeterMakholmC}}
<!--{{Author of the Linux AGI Studio: -->{{HelenZommerC}}
<br />
==<br /> Description ==

<blockquote>
Sarien was a portable reimplementation of the [[Sierra|Sierra On-Line]] Adventure Game Interpreter ([[AGI]]), and is able to run games such as [[Leisure Suit Larry in the Land of the Lounge Lizards]] and [[Space Quest: Chapter I - The Sarien Encounter|Space Quest I]] and [[Space Quest II: Vohaul's Revenge|II]], [[King's Quest: Quest for the Crown| King's Quest I]] to [[King's Quest IV: The Perils of Rosella AGI|IV (AGI)]] and [[The Black Cauldron]]. It was designed to be cross-platform to allow it to used on more modern OSs, such as Windows, MacOSX and Linux. 
</blockquote>
<!--
===<br /> Screenshots ===

{| align="center" width="80%"
| align="center"|[[Image:SarienSS1.png|320px]]
| align="center"|[[Image:SarienSS2.png|320px]]
|}
-->

==<br /> Features ==

<blockquote>
<!-- Add feature list here -->
</blockquote>

==<br /> Requirements ==

<blockquote>
<!-- Add requirements here -->
</blockquote>

==<br /> Version History ==

<blockquote>
&nbsp;<!-- Place version history here -->
</blockquote>

==<br /> Development Status ==

<blockquote>
Sarien has been merged with [[ScummVM]] and all development since as been within the ScummVM project.
</blockquote>

==<br /> Usage ==

<blockquote>
'''-A, --amiga'''<br />
Tell the interpreter to read Amiga word-aligned resource files. <br />
&nbsp;'''-a, --agds'''<br />
Tell the interpreter to read AGDS games. <br />
&nbsp;'''-C, --crc'''<br />
Compute the CRC of the game resources and exit. <br />
&nbsp;'''-d, --list-dictionary'''<br />
List dictionary words and exit. <br />
&nbsp;'''-E, --emulate-sound''' ''type''<br />
Set the sound generator to emulate the output of Sierra's AGI in different platforms. The available types are: '''pc''', '''mac''' and '''amiga'''. <br />
&nbsp;'''-F, --full-screen'''<br />
Run the interpreter in full-screen mode, if supported by the graphics driver. This mode is currently supported only by the SDL driver. <br />
&nbsp;'''-g, --no-gfx-optimizations'''<br />
Disable any graphics driver optimizations in use by the graphics driver. This option should be used with the X11 driver if the display is being exported to a server with different endianness. <br />
&nbsp;'''-H, --hires''' '''0|1'''<br />
Enable or disable double horizontal resolution for picture drawing. When it's enabled pictures look better, but some artifacting may appear. Hi-res mode can be also enabled or disabled from the interpreter 
console at runtime. <br />
&nbsp;'''-h, --help'''<br />
Display a summary of available command-line parameters. <br />
&nbsp;'''-L, --list-games'''<br />
List recognized games and versions. <br />
&nbsp;'''-m, --agimouse'''<br />
Enable AGI Mouse 1.0 protocol emulation. Use this option only with AGI Mouse games, since it interferes with normal AGI commands and regular mouse operation. <br />
&nbsp;'''-n, --no-sound'''<br />
Disable sound output. <br />
&nbsp;'''-p, --picture-viewer'''<br />
Run the interpreter in picture viewer mode. See the PICTURE VIEWER section below for further information on this mode. <br />
&nbsp;'''-o, --list-objects'''<br />
List game objects and exit. <br />
&nbsp;'''-S, --scale''' ''num''<br />
Set window scaling to ''num''. This option is available in windowed graphics environments only. (Default scale is 2.) <br />
&nbsp;'''-r, --aspect-ratio''' '''0|1'''<br />
Enable or disable aspect ratio correction for square-pixel graphics modes to match the PC EGA 320x200 display. Aspect ratio correction is enabled by default in the drivers that support this feature. 
<br />
&nbsp;'''-v, --emulate-version''' ''version''<br />
Emulate the specified AGI version, overriding any autodetected defaults. Valid version numbers are: 2.089, 2.272, 2.440, 2.917, 2.936, 3.002.086, 3.002.149. <br />
&nbsp;'''-V, --version'''<br />
Show version number and exit. <br />
&nbsp;'''-x, --no-x-shm'''<br />
Disable X11 shared memory extension. This option should be used if you're exporting the display to a remote X server. 
</blockquote>

===<br /> USER INPUT ===

The interpreter accepts user input using the keyboard or the mouse. The mouse can be used to set ego destination, dismiss message boxes and select menu options (left button) or enable and disable the 
interpreter console (right button). User commands (such as '''EXAMINE ROOM''' or '''RESTORE GAME''' can be typed in the user input area.

The following special keys are recognized during gameplay: 
<blockquote>
'''Arrow keys, numeric keypad'''<br />
Control direction of ego walk. The destination point can be also set left-clicking on the desired location. Selecting the same direction twice or pressing '''&lt;5&gt;''' on the numeric 
keypad causes ego to stop. <br />
&nbsp;'''&lt;&nbsp;&gt;'''<br />
Switch the interpter console on and off. <br />
&nbsp;'''&lt;F11&gt;'''<br />
Toggle debug information on the status line. If enabled, the current room number, previous room number, current ego coordinates and last clicked coordinates are shown on the status line. <br />
&nbsp;'''&lt;F12&gt;'''<br />
Show or hide the priority screen. 
</blockquote>

Other keys are set by the game being executed. Traditionally '''&lt;F3&gt;''' is used to echo the last command line, and '''&lt;TAB&gt;''' is used to show the inventory items. 
Please refer to the game documentation or on-line help for a list of the supported keystrokes.
&nbsp;

===<br /> CONSOLE COMMANDS ===

The interpreter console (activated by the '''&lt;`&gt;''' key or the right mouse button) can be used to inspect and modify AGI game data at runtime, disassemble AGI bytecode and single-step 
through logic scripts and instructions.
 
<blockquote>
'''agiver'''<br />
Show the AGI version we're emulating. AGI versions are listed in '''/etc/sarien.conf''' or set using the '''-v''' command line argument <br />
&nbsp;'''cont'''<br />
Resume interpreter execution after a debugging session. <br />
&nbsp;'''crc'''<br />
Show the CRC of the currently loaded AGI game. CRCs are used in '''/etc/sarien.conf''' to identify games and set the correct AGI version. <br />
&nbsp;'''debug'''<br />
Enter debug mode. AGI script execution will stop, and scripts can be single-stepped using the '''step''' command. <br />
&nbsp;'''flags'''<br />
Show the value of all AGI flags. <br />
&nbsp;'''f'''''n''<br />
Show the value of the AGI flag ''n''. <br />
&nbsp;'''f'''''n'' = 0|1<br />
Set or reset the AGI flag ''n''. <br />
&nbsp;'''help'''<br />
Show a summary of the available console commands. <br />
&nbsp;'''hires on|off'''<br />
Switch hi-res mode on/off. Pictures usually look better in hi-res mode, but some undesired artifacting may appear. Use this command to disable hi-res mode if you notice too much artifacting, or if 
you want traditional Sierra AGI resolution. Hi-res mode affects picture resources only. <br />
&nbsp;'''logic0 on|off'''<br />
In debug mode, enable or disable single stepping on logic script 0. <br />
&nbsp;'''load''' ''gamedir'' Load and execute the AGI game specified by ''gamedir''. <br />
&quot; 10 <br />
&nbsp;'''objs'''<br />
List all available objects and their locations. <br />
&nbsp;'''opcode on|off'''<br />
In debug mode, show or hide opcodes of the piece of code being executed. <br />
&nbsp;'''step''' ''n''<br />
In debug mode, single-step through ''n'' AGI instructions. <br />
&nbsp;'''vars'''<br />
List all AGI variables and their values. <br />
&nbsp;'''v'''''n''<br />
Show the value of the AGI variable ''n''. <br />
&nbsp;'''v'''''n'' = ''m''<br />
Set the value of the AGI flag ''n'' to ''m''. <br />
&nbsp;'''ver'''<br />
Show the Sarien interpreter version. 
</blockquote>

===<br /> PICTURE VIEWER ===

&nbsp;

===<br /> EXAMPLES ===

&nbsp;

==<br /> Download ==

<blockquote>
Download from here:
* [[Image:ZIP.png|ZIP File]] [[File:sarien-windows0.8.zip|sarien-windows0.8.zip]] <span class="DLInfo"> (ZIP file) [411 KB]</span><br />'''Source:'''
** [[File:ZIP.png|ZIP File]] [[File:sarien-master0.8SRC.zip|sarien-master0.8.zip]]<span class="DLInfo"> (ZIP file) [461 KB]</span>
</blockquote>

==<br /> Known issues ==

* None known

== <br />Credits ==

* [[Stuart George]] (Darkfiber)
* [[Lance Ewing]]
* [[Claudio Matsuoka]] (cmatsuoka)
* [[Felipe Rosinha]]
* [[XoXus]]
* [[Igor Nesterov]]
* [[Ari Heikkinen]]
* [[Joshua Neal]]
* [[Sad Rejeb]]
* [[Robert Bihlmeyer]]
* [[Ryan Gordon]]
* [[Magnus Kristiansen]]
* [[Jeremy Penner]]
* [[Peter Hawkins]]
* [[Justin Kerk]]
* [[Matt Hargett]]
* [[Ian Hanschen]]
* [[Ziv Barber]]
* [[Richard Houle]]
* [[Paul Hill]]
* [[Vasyl Tsvirkunov]]
* [[Thomas Akesson]]
* [[Eugene Sandulenko]] (sev)

<blockquote>
===<br /> Acknowledgements ===

* [[Paul Lunga]], Thanks
* [[Ian Schmidt]], Thanks
* [[Nat Budin]], Thanks
* [[Nick Sonneveld]], Thanks
* [[Peter Makholm]], Thanks
* [[Helen Zommer]], Thanks
</blockquote>

==<br /> Legal ==

<blockquote>
Sarien was distributed with the {{GPL2}}
</blockquote>

==<br /> References ==

<references /><!-- Do not edit this section. It is autopopulated by <ref></ref> tags -->

==<br /> Also See ==

* [[AGI|AGI]]
* [[The AGI Interpreter|Interpreter]]
* [[:Category:AGI Interpreters|AGI Interpreters]]
* [[:Category:Third Party AGI Interpreters|Third Party AGI Interpreters]]
* [[wayback:20060411094142/http://sarien.sourceforge.net/|sarien.sourceforge.net/]] (web archive)
* [[github:cmatsuoka/sarien|github.com/cmatsuoka/sarien]]

&nbsp;

[[Category:Technical Info]]
[[Category:AGI Technical Info]]
[[Category:Interpreters]]
[[Category:AGI Interpreters]]
[[Category:Third Party Interpreters]]
[[Category:Third Party AGI Interpreters]]