[Scummvm-cvs-logs] SF.net SVN: scummvm: [25009] docs/trunk/docbook

fingolfin at users.sourceforge.net fingolfin at users.sourceforge.net
Fri Jan 5 22:56:36 CET 2007


Revision: 25009
          http://scummvm.svn.sourceforge.net/scummvm/?rev=25009&view=rev
Author:   fingolfin
Date:     2007-01-05 13:56:35 -0800 (Fri, 05 Jan 2007)

Log Message:
-----------
Removing generated files from the repository

Modified Paths:
--------------
    docs/trunk/docbook/manual.html

Removed Paths:
-------------
    docs/trunk/docbook/devguide/
    docs/trunk/docbook/devguide.html
    docs/trunk/docbook/devguide.pdf
    docs/trunk/docbook/faq.html
    docs/trunk/docbook/faq.pdf
    docs/trunk/docbook/index.html
    docs/trunk/docbook/manual.pdf

Property Changed:
----------------
    docs/trunk/docbook/
    docs/trunk/docbook/img/


Property changes on: docs/trunk/docbook
___________________________________________________________________
Name: svn:ignore
   - .DS_Store
   + .DS_Store
*.html
*.xhtml
*.pdf
*.txt
*.inc


Deleted: docs/trunk/docbook/devguide.html
===================================================================
--- docs/trunk/docbook/devguide.html	2007-01-05 21:53:53 UTC (rev 25008)
+++ docs/trunk/docbook/devguide.html	2007-01-05 21:56:35 UTC (rev 25009)
@@ -1,382 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-"http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<head>
-<meta name="generator" content=
-"HTML Tidy for Mac OS X (vers 1 September 2005), see www.w3.org">
-<title>Developer's Guide to ScummVM</title>
-<meta name="GENERATOR" content=
-"Modular DocBook HTML Stylesheet Version 1.79">
-</head>
-<body class="book" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
-vlink="#840084" alink="#0000FF">
-<div class="BOOK"><a name="AEN1" id="AEN1"></a>
-<div class="TITLEPAGE">
-<h1 class="title"><a name="AEN2" id="AEN2">Developer's Guide to
-ScummVM</a></h1>
-<h3 class="author"><a name="AEN3" id="AEN3"></a>Foo Bar</h3>
-<hr></div>
-<div class="TOC">
-<dl>
-<dt><b>Table of Contents</b></dt>
-<dt>I. <a href="#AEN7">The Core: A framework for building portable
-adventure engines</a></dt>
-<dd>
-<dl>
-<dt>1. <a href="#AEN11">Portability</a></dt>
-<dt>2. <a href="#AEN14">How to write a new ScummVM backend</a></dt>
-<dt>3. <a href="#AEN17">Data types</a></dt>
-<dt>4. <a href="#AEN20">Backends: OSystem</a></dt>
-<dd>
-<dl>
-<dt>4.1. <a href="#AEN23">Graphics</a></dt>
-<dt>4.2. <a href="#AEN26">Overlays</a></dt>
-<dt>4.3. <a href="#AEN29">Event handling</a></dt>
-</dl>
-</dd>
-<dt>5. <a href="#AEN32">MIDI</a></dt>
-<dt>6. <a href="#AEN35">Sound</a></dt>
-<dt>7. <a href="#AEN38">Timers</a></dt>
-<dt>8. <a href="#AEN41">Files</a></dt>
-<dt>9. <a href="#AEN44">Config Manager</a></dt>
-<dt>10. <a href="#AEN47">Game detector</a></dt>
-<dt>11. <a href="#AEN50">Plugin system</a></dt>
-<dt>12. <a href="#AEN53">GUI</a></dt>
-</dl>
-</dd>
-<dt>II. <a href="#AEN56">The Engines</a></dt>
-<dd>
-<dl>
-<dt>13. <a href="#AEN60">How to write a new ScummVM game
-engine</a></dt>
-<dt>14. <a href="#AEN63">SCUMM</a></dt>
-<dd>
-<dl>
-<dt>14.1. <a href="#AEN65">Supported Games</a></dt>
-<dt>14.2. <a href="#AEN68">History</a></dt>
-<dt>14.3. <a href="#AEN71">Concepts</a></dt>
-<dt>14.4. <a href="#AEN74">Graphics</a></dt>
-<dt>14.5. <a href="#AEN77">Scripting</a></dt>
-<dt>14.6. <a href="#AEN80">Actors and Costumes</a></dt>
-<dt>14.7. <a href="#AEN83">Objects</a></dt>
-<dt>14.8. <a href="#AEN86">Text</a></dt>
-<dt>14.9. <a href="#AEN89">iMuse</a></dt>
-<dt>14.10. <a href="#AEN92">INSANE</a></dt>
-<dt>14.11. <a href="#AEN95">SMUSH</a></dt>
-<dt>14.12. <a href="#AEN98">How it all fits together</a></dt>
-</dl>
-</dd>
-<dt>15. <a href="#AEN101">Simon the Sorcerer</a></dt>
-<dt>16. <a href="#AEN104">Beneath a Steel Sky</a></dt>
-<dt>17. <a href="#AEN107">Broken Sword 1</a></dt>
-<dt>18. <a href="#AEN110">Broken Sword 2</a></dt>
-<dt>19. <a href="#AEN113">Flight of the Amazon Queen</a></dt>
-<dt>20. <a href="#AEN116">Saga</a></dt>
-</dl>
-</dd>
-</dl>
-</div>
-<div class="PART"><a name="AEN7" id="AEN7"></a>
-<div class="TITLEPAGE">
-<h1 class="title">I. The Core: A framework for building portable
-adventure engines</h1>
-<div class="PARTINTRO"><a name="AEN9" id="AEN9"></a>
-<p>Explain all the stuff in ScummVM which is shared by all our
-engines.</p>
-</div>
-<div class="TOC">
-<dl>
-<dt><b>Table of Contents</b></dt>
-<dt>1. <a href="#AEN11">Portability</a></dt>
-<dt>2. <a href="#AEN14">How to write a new ScummVM backend</a></dt>
-<dt>3. <a href="#AEN17">Data types</a></dt>
-<dt>4. <a href="#AEN20">Backends: OSystem</a></dt>
-<dd>
-<dl>
-<dt>4.1. <a href="#AEN23">Graphics</a></dt>
-<dt>4.2. <a href="#AEN26">Overlays</a></dt>
-<dt>4.3. <a href="#AEN29">Event handling</a></dt>
-</dl>
-</dd>
-<dt>5. <a href="#AEN32">MIDI</a></dt>
-<dt>6. <a href="#AEN35">Sound</a></dt>
-<dt>7. <a href="#AEN38">Timers</a></dt>
-<dt>8. <a href="#AEN41">Files</a></dt>
-<dt>9. <a href="#AEN44">Config Manager</a></dt>
-<dt>10. <a href="#AEN47">Game detector</a></dt>
-<dt>11. <a href="#AEN50">Plugin system</a></dt>
-<dt>12. <a href="#AEN53">GUI</a></dt>
-</dl>
-</div>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN11" id="AEN11"></a>Chapter 1. Portability</h1>
-<p>TODO: Explain why portability is important for us, general tips
-on how to achieve it, thinks to watch out for, etc.. Give some
-hints on how to port, and when it might be necessary to provide a
-new backend</p>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN14" id="AEN14"></a>Chapter 2. How to write a new
-ScummVM backend</h1>
-<p>TODO: Explain how one would go about creating a new ScummVM
-backend. Mention that usually it's a good idea for consider whether
-a new backend is really necessary or whether one can just use the
-SDL backend. Mention the possibility (and risks) of subclassing the
-SDL backend.</p>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN17" id="AEN17"></a>Chapter 3. Data types</h1>
-<p>TODO: Data types from scummsys.h (like uint8); high level data
-types like Map/Array/List/String; maybe explain why we don't use
-the Std C++ lib (hey, I still would like to hear a decent
-explanation for this other than "10 years ago it sucked and wasn't
-portable, so we can't use it, even though all we'd use from it is
-well supported on all our target systems ;-).</p>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN20" id="AEN20"></a>Chapter 4. Backends:
-OSystem</h1>
-<p>TODO: Explain the OSystem API; maybe well enough to help people
-start their own one (though maybe we should simply dedicate a full
-"part" for this, with chapters on how to write a new backend, plus
-chapters on all the existing backends... ?)</p>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN23" id="AEN23">4.1.
-Graphics</a></h2>
-<p>TODO</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN26" id="AEN26">4.2.
-Overlays</a></h2>
-<p>TODO</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN29" id="AEN29">4.3. Event
-handling</a></h2>
-<p>TODO</p>
-</div>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN32" id="AEN32"></a>Chapter 5. MIDI</h1>
-<p>TODO: Explain both the backend MIDI code (class MidiDriver) as
-well as the higher level stuff (class MidiParser); MT32 mapping;
-adlib emulation; etc.</p>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN35" id="AEN35"></a>Chapter 6. Sound</h1>
-<p>TODO: The mixer; audio streams; audio CD playback / emulation;
-MP3/OGG/Flac/VOC handling...</p>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN38" id="AEN38"></a>Chapter 7. Timers</h1>
-<p>TODO</p>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN41" id="AEN41"></a>Chapter 8. Files</h1>
-<p>TODO: File class; when to use SaveFile; ...</p>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN44" id="AEN44"></a>Chapter 9. Config Manager</h1>
-<p>TODO</p>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN47" id="AEN47"></a>Chapter 10. Game detector</h1>
-<p>TODO</p>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN50" id="AEN50"></a>Chapter 11. Plugin system</h1>
-<p>TODO</p>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN53" id="AEN53"></a>Chapter 12. GUI</h1>
-<p>TODO: Explain how to use the GUI code; also document the various
-Widget/Dialog classes etc.</p>
-</div>
-</div>
-<div class="PART"><a name="AEN56" id="AEN56"></a>
-<div class="TITLEPAGE">
-<h1 class="title">II. The Engines</h1>
-<div class="PARTINTRO"><a name="AEN58" id="AEN58"></a>
-<p>TODO: Right now, one chapter devoted to each engine; idea is to
-explain both how the resp. games "work" (i.e. explain data formats
-and stuff like that), as well as the engine internally works (how
-are graphics rendered? which methods are involved, etc.).</p>
-</div>
-<div class="TOC">
-<dl>
-<dt><b>Table of Contents</b></dt>
-<dt>13. <a href="#AEN60">How to write a new ScummVM game
-engine</a></dt>
-<dt>14. <a href="#AEN63">SCUMM</a></dt>
-<dd>
-<dl>
-<dt>14.1. <a href="#AEN65">Supported Games</a></dt>
-<dt>14.2. <a href="#AEN68">History</a></dt>
-<dt>14.3. <a href="#AEN71">Concepts</a></dt>
-<dt>14.4. <a href="#AEN74">Graphics</a></dt>
-<dt>14.5. <a href="#AEN77">Scripting</a></dt>
-<dt>14.6. <a href="#AEN80">Actors and Costumes</a></dt>
-<dt>14.7. <a href="#AEN83">Objects</a></dt>
-<dt>14.8. <a href="#AEN86">Text</a></dt>
-<dt>14.9. <a href="#AEN89">iMuse</a></dt>
-<dt>14.10. <a href="#AEN92">INSANE</a></dt>
-<dt>14.11. <a href="#AEN95">SMUSH</a></dt>
-<dt>14.12. <a href="#AEN98">How it all fits together</a></dt>
-</dl>
-</dd>
-<dt>15. <a href="#AEN101">Simon the Sorcerer</a></dt>
-<dt>16. <a href="#AEN104">Beneath a Steel Sky</a></dt>
-<dt>17. <a href="#AEN107">Broken Sword 1</a></dt>
-<dt>18. <a href="#AEN110">Broken Sword 2</a></dt>
-<dt>19. <a href="#AEN113">Flight of the Amazon Queen</a></dt>
-<dt>20. <a href="#AEN116">Saga</a></dt>
-</dl>
-</div>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN60" id="AEN60"></a>Chapter 13. How to write a new
-ScummVM game engine</h1>
-<p>TODO: Explain/document what makes up a game engine in ScummVM;
-this chapter should help people who want to create a new
-engine.</p>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN63" id="AEN63"></a>Chapter 14. SCUMM</h1>
-<div class="section">
-<h2 class="section"><a name="AEN65" id="AEN65">14.1. Supported
-Games</a></h2>
-<p>TODO: List of the games supported by this engine</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN68" id="AEN68">14.2.
-History</a></h2>
-<p>TODO: History of the engine; both of the engine as part of
-ScummVM (reverse engineered; code donated? since when is it in
-there? etc.); but also of the "original" engine (like which company
-developed it, changes made to it over time, etc.)</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN71" id="AEN71">14.3.
-Concepts</a></h2>
-<p>TODO: Give an overview over things like actors, costumes,
-resources, sentences, verbs, ...; not too much detail, but enough
-to give people a first idea</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN74" id="AEN74">14.4.
-Graphics</a></h2>
-<p>TODO: Explain how graphics are rendered in the SCUMM engine;
-start by explaining where they come from (actor/costumes; verbs;
-text; objects; ...); about strips; virtual screens; codecs; how
-scrolling is done; etc.</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN77" id="AEN77">14.5.
-Scripting</a></h2>
-<p>TODO</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN80" id="AEN80">14.6. Actors and
-Costumes</a></h2>
-<p>TODO</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN83" id="AEN83">14.7.
-Objects</a></h2>
-<p>TODO: Object states, classes; inventory; floating objects;
-object rendering; blast objects; etc.</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN86" id="AEN86">14.8. Text</a></h2>
-<p>TODO</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN89" id="AEN89">14.9. iMuse</a></h2>
-<p>TODO</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN92" id="AEN92">14.10.
-INSANE</a></h2>
-<p>TODO</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN95" id="AEN95">14.11.
-SMUSH</a></h2>
-<p>TODO</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN98" id="AEN98">14.12. How it all
-fits together</a></h2>
-<p>TODO: Here we give a run down of all those parts fit together;
-i.e. explain the life cycle of a game play session, from loading
-the game, to how the main loop runs in detail...</p>
-</div>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN101" id="AEN101"></a>Chapter 15. Simon the
-Sorcerer</h1>
-<p>TODO</p>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN104" id="AEN104"></a>Chapter 16. Beneath a Steel
-Sky</h1>
-<p>TODO</p>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN107" id="AEN107"></a>Chapter 17. Broken Sword
-1</h1>
-<p>TODO</p>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN110" id="AEN110"></a>Chapter 18. Broken Sword
-2</h1>
-<p>TODO</p>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN113" id="AEN113"></a>Chapter 19. Flight of the
-Amazon Queen</h1>
-<p>TODO</p>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN116" id="AEN116"></a>Chapter 20. Saga</h1>
-<p>TODO</p>
-</div>
-</div>
-</div>
-</body>
-</html>

Deleted: docs/trunk/docbook/devguide.pdf
===================================================================
(Binary files differ)

Deleted: docs/trunk/docbook/faq.html
===================================================================
--- docs/trunk/docbook/faq.html	2007-01-05 21:53:53 UTC (rev 25008)
+++ docs/trunk/docbook/faq.html	2007-01-05 21:56:35 UTC (rev 25009)
@@ -1,792 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-"http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<head>
-<meta name="generator" content=
-"HTML Tidy for Mac OS X (vers 1 September 2005), see www.w3.org">
-<title>Frequently Asked Questions About ScummVM</title>
-<meta name="GENERATOR" content=
-"Modular DocBook HTML Stylesheet Version 1.79">
-</head>
-<body class="article" bgcolor="#FFFFFF" text="#000000" link=
-"#0000FF" vlink="#840084" alink="#0000FF">
-<div class="ARTICLE">
-<div class="TITLEPAGE">
-<h1 class="title"><a name="AEN2" id="AEN2">Frequently Asked
-Questions About ScummVM</a></h1>
-<hr></div>
-<div class="qandaset">
-<dl>
-<dt>1. <a href="#AEN6">Introduction</a></dt>
-<dd>
-<dl>
-<dt>1.1. <a href="#AEN9">Why is it called ScummVM - what does this
-name mean?</a></dt>
-<dt>1.2. <a href="#AEN19">What is SCUMM?</a></dt>
-<dt>1.3. <a href="#AEN25">Is ScummVM free?</a></dt>
-<dt>1.4. <a href="#AEN31">Where do I find ScummVM?</a></dt>
-<dt>1.5. <a href="#AEN37">How do I compile the source code for my
-OS?</a></dt>
-<dt>1.6. <a href="#AEN43">On what platform does ScummVM
-run?</a></dt>
-<dt>1.7. <a href="#AEN51">Can I use ScummVM to make new
-games?</a></dt>
-</dl>
-</dd>
-<dt>2. <a href="#AEN58">Supported games</a></dt>
-<dd>
-<dl>
-<dt>2.1. <a href="#question.supported-games">What games does
-ScummVM support?</a></dt>
-<dt>2.2. <a href="#AEN67">Does ScummVM run any non-SCUMM
-games?</a></dt>
-<dt>2.3. <a href="#AEN76">Will ScummVM support other
-games?</a></dt>
-<dt>2.4. <a href="#AEN83">When will Maniac Mansion Deluxe be
-supported?</a></dt>
-</dl>
-</dd>
-<dt>3. <a href="#AEN89">Running games</a></dt>
-<dd>
-<dl>
-<dt>3.1. <a href="#AEN92">Do I need original CD or Floppy
-disks?</a></dt>
-<dt>3.2. <a href="#AEN98">Does ScummVM work with all versions of
-games?</a></dt>
-<dt>3.3. <a href="#AEN104">Can I play through xxx (place your
-favorite SCUMM adventure here) ?</a></dt>
-<dt>3.4. <a href="#AEN110">Can I save/restore the game?</a></dt>
-<dt>3.5. <a href="#AEN115">Do savegames from the original games
-work in ScummVM?</a></dt>
-</dl>
-</dd>
-<dt>4. <a href="#AEN119">Graphics and Audio</a></dt>
-<dd>
-<dl>
-<dt>4.1. <a href="#AEN122">Does ScummVM support CD audio?</a></dt>
-<dt>4.2. <a href="#AEN128">Does ScummVM support using MP3/Ogg/FLAC
-files instead of CD audio?</a></dt>
-<dt>4.3. <a href="#AEN134">Does ScummVM support using MP3/Ogg/FLAC
-files instead of the original MIDI music?</a></dt>
-<dt>4.4. <a href="#AEN140">Does ScummVM support filtered graphic
-modes?</a></dt>
-<dt>4.5. <a href="#AEN147">Can I run my game full screen?</a></dt>
-</dl>
-</dd>
-<dt>5. <a href="#AEN151">Troubleshooting</a></dt>
-<dd>
-<dl>
-<dt>5.1. <a href="#AEN154">My game won't run.</a></dt>
-<dt>5.2. <a href="#AEN162">I installed my game but ScummVM can't
-find it.</a></dt>
-<dt>5.3. <a href="#question.no-sound">I don't hear any
-sound.</a></dt>
-<dt>5.4. <a href="#AEN174">I don't hear any music.</a></dt>
-<dt>5.5. <a href="#AEN180">My game crashes at some point.</a></dt>
-<dt>5.6. <a href="#AEN188">ScummVM crashes, but console window
-disappears too quick to see the error message.</a></dt>
-<dt>5.7. <a href="#question.messy-colors">The game colors are
-messed up.</a></dt>
-<dt>5.8. <a href="#AEN198">The subtitles in my non English game are
-messed up.</a></dt>
-<dt>5.9. <a href="#AEN205">How do I make my mac version of a game
-work?</a></dt>
-<dt>5.10. <a href="#question.report-bugs">Reporting Bugs.</a></dt>
-<dt>5.11. <a href="#AEN237">I downloaded the Broken Sword packs
-from your site but the game won't run.</a></dt>
-<dt>5.12. <a href="#AEN242">There are no graphics in the Broken
-Sword I intro.</a></dt>
-<dt>5.13. <a href="#AEN247">I get "WARNING: Unable to open
-configration file C:\windows\scummvm.ini!"</a></dt>
-<dt>5.14. <a href="#AEN252">I get "Failed to save game state to
-file: xxx"</a></dt>
-<dt>5.15. <a href="#AEN257">ScummVM starts, but all I get is a
-transparent window!</a></dt>
-<dt>5.16. <a href="#AEN267">ScummVM runs, but sound is stuttering
-and/or garbled!</a></dt>
-<dt>5.17. <a href="#AEN273">How do I set an environment
-variable?</a></dt>
-<dt>5.18. <a href="#AEN284">ScummVM starts somewhere in the middle
-of my two Xinerama monitors in fullscreen mode. Help!</a></dt>
-</dl>
-</dd>
-<dt>6. <a href="#AEN289">Features</a></dt>
-<dd>
-<dl>
-<dt>6.1. <a href="#AEN292">Will you add support for zip
-archives?</a></dt>
-</dl>
-</dd>
-</dl>
-<div class="qandadiv">
-<h3><a name="AEN6" id="AEN6"></a>1. Introduction</h3>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN9" id="AEN9"></a><b>1.1.</b> Why is it called
-ScummVM - what does this name mean?</p>
-</div>
-<div class="answer">
-<p><span class="QUOTE">"Scumm"</span> comes from the fact that it
-was originally designed to run SCUMM games, like Monkey Island.
-<span class="QUOTE">"VM"</span> stands for Virtual Machine.</p>
-<p>Every now and then somebody will raise the subject of finding a
-<span class="QUOTE">"better"</span> name for ScummVM, one that fits
-better with it's modern scope (which extends well beyond SCUMM
-games). So <a href="http://wiki.scummvm.org/index.php/ScummVM_Name"
-target="_top">at this page</a> we present you with some nice
-alternatives. Choose whichever suits you best -- but we will stay
-ScummVM.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN19" id="AEN19"></a><b>1.2.</b> What is SCUMM?</p>
-</div>
-<div class="answer">
-<p>SCUMM stands for "Script Creation Utility for Maniac Mansion".
-It is a utility used to create the famous LucasArts adventure
-games.</p>
-<p>It was initially created in 1987 by Aric Wilmunder and Ron
-Gilbert for the game "Maniac Mansion" and was used later, with some
-modifications, for Zak McKracken and the Alien Mindbenders.
-Development on the SCUMM system continued for some time, and was
-used in Loom, Indiana Jones and the Last Crusade, Indiana Jones and
-the Fate of Atlantis, Monkey Island 1,2,3, Sam & Max Hit the
-Road, Day of the Tentacle, The Dig and Full Throttle.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN25" id="AEN25"></a><b>1.3.</b> Is ScummVM free?</p>
-</div>
-<div class="answer">
-<p>ScummVM is released under the <a href=
-"http://www.gnu.org/copyleft/gpl.html" target="_top">GPL (General
-Public License)</a>, so it's more than free. ScummVM source code is
-freely available and you can do whatever you want with it. If you
-make modifications to it and redistribute your work you MUST make
-the source available. However, the ScummVM team would be pleased if
-you choose to send them your modifications, so they can be merged
-into the main tree.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN31" id="AEN31"></a><b>1.4.</b> Where do I find
-ScummVM?</p>
-</div>
-<div class="answer">
-<p>You can find it on the download section on our <a href=
-"http://www.scummvm.org" target="_top">web site</a>. You can
-download the latest version, which could be a little old. For the
-most recent cutting-edge in-development version, you have to
-compile it yourself from Subversion or use the precompiled 'daily
-builds' linked from our download page.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN37" id="AEN37"></a><b>1.5.</b> How do I compile the
-source code for my OS?</p>
-</div>
-<div class="answer">
-<p>The source code package contains a file called <a href=
-"http://svn.sourceforge.net/viewvc/*checkout*/scummvm/scummvm/trunk/README"
-target="_top">README</a> that should explain everything.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN43" id="AEN43"></a><b>1.6.</b> On what platform does
-ScummVM run?</p>
-</div>
-<div class="answer">
-<p>ScummVM should be able to be compiled on any SDL platform, with
-just small modifications.</p>
-<p>Currently tested platforms include Win32 (Windows
-95/98/ME/NT/2000/XP), Linux i386 and PPC, BeOS, Solaris, Mac OS X,
-Dreamcast, MorphOS, IRIX, PalmOS, WinCE, GP32, Sony PSP and PS2. It
-is also part of the Free/Net/Open BSD ports collections and
-included in Debian testing and unstable.</p>
-<p>See also the <a href=
-"http://wiki.scummvm.org/index.php/Platforms" target=
-"_top">platforms list</a> in our Wiki.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN51" id="AEN51"></a><b>1.7.</b> Can I use ScummVM to
-make new games?</p>
-</div>
-<div class="answer">
-<p>While it is theoretically possible to write a new game that uses
-ScummVM it is not advisable. ScummVM has many hacks to support
-older games and no tools geared towards creating content usable by
-ScummVM. Potential game authors are encouraged to look at open
-source technologies such as <a href="http://www.libsdl.org" target=
-"_top">SDL</a> for a cross platform DirectX like library, and the
-<a href="http://www.lua.org" target="_top">Lua</a> and <a href=
-"http://www.python.org" target="_top">Python</a> scripting
-languages for game logic.</p>
-</div>
-</div>
-</div>
-<div class="qandadiv">
-<h3><a name="AEN58" id="AEN58"></a>2. Supported games</h3>
-<div class="qandaentry">
-<div class="question">
-<p><a name="question.supported-games" id=
-"question.supported-games"></a><b>2.1.</b> What games does ScummVM
-support?</p>
-</div>
-<div class="answer">
-<p>We have a <a href="http://www.scummvm.org/compatibility.php"
-target="_top">compatibility list</a> on our website that contains
-an up to date list of what games work, and how well they work. As
-well as SCUMM games, we also include virtual machines for the first
-two Simon the Sorcerer games (by Adventure Soft), Broken Sword 1/2
-and Beneath a Steel Sky (by Revolution), Flight of the Amazon
-Queen, Gobliiins 1 (by Coktel Vision) as well as Inherit the Earth
-(by The Dreamers' Guild). Other games may be added, but this is not
-a common occurrence - see below.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN67" id="AEN67"></a><b>2.2.</b> Does ScummVM run any
-non-SCUMM games?</p>
-</div>
-<div class="answer">
-<p>Yes. As well as SCUMM titles, ScummVM supports Simon the
-Sorcerer (1 and 2), Flight of the Amazon Queen, and the Revolution
-Games: Broken Sword 1, Broken Sword 2, and Beneath a Steel Sky, as
-well as Gobliiins 1 and Inherit the Earth.</p>
-<p>Simon support was initially written by the original founder of
-ScummVM as a separate program, and later included in the main
-binary. Revolution Software Ltd. are very nice people and kindly
-provided us with the source code to BASS and Broken Sword 1/2, from
-which we based our interpreters. John Passfield and Steven
-Stamatiadis kindly provided the original source code to Flight of
-the Amazon Queen. The Wyrmkeep Entertainment Co. kindly provided
-the sourcecode to Inherit the Earth. Gobliiins 1 was widely
-researched by Ivan Dubrov.</p>
-<p>We do not have any plans to support any other non-SCUMM games at
-this time. If we do, it will be added to the <a href=
-"compatibility.php" target="_top">Compatibility List</a>.</p>
-<p>Unless you work for a company interested providing us with
-source code for one of your classic titles, please do not ask us to
-support a game.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN76" id="AEN76"></a><b>2.3.</b> Will ScummVM support
-other games?</p>
-</div>
-<div class="answer">
-<p>The ScummVM team is currently focusing on bugfixes for our next
-release.</p>
-<p>We do <span class="emphasis"><i class="emphasis">NOT</i></span>
-generally add support for non-SCUMM games! Reverse engineering a
-completely new game without source is a long process, and our
-developers are all very busy as it is... so unless you work for a
-company interested in providing us with source code for one of your
-classic titles, please do not ask.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN83" id="AEN83"></a><b>2.4.</b> When will Maniac
-Mansion Deluxe be supported?</p>
-</div>
-<div class="answer">
-<p>The short answer: never. The long answer: This game is a
-fan-made replica of the original Maniac Mansion. It is not the same
-game as Maniac Mansion Enhanced, which we do support. It features
-improved music, sound, 256-colors graphics and reworked game
-interface. It was made using the <a href=
-"http://www.adventuregamestudio.co.uk/" target="_top">Adventure
-Game Studio</a> which is a free, albeit closed-source graphics
-adventures engine. There are Windows, Linux and FreeBSD versions of
-the engine. Its author keeps his source code closed due to reasons
-explained in the project <a href=
-"http://www.bigbluecup.com/acfaq.htm" target="_top">FAQ</a> (see
-last two questions). That means that you need to download that
-program to play the game.</p>
-</div>
-</div>
-</div>
-<div class="qandadiv">
-<h3><a name="AEN89" id="AEN89"></a>3. Running games</h3>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN92" id="AEN92"></a><b>3.1.</b> Do I need original CD
-or Floppy disks?</p>
-</div>
-<div class="answer">
-<p>Most definitely. ScummVM won't work without them. If you would
-like to buy these games, we suggest you browse <a href=
-"http://www.ebay.com" target="_top">Ebay</a>. Do not ask the
-ScummVM team where you can download the full versions of LucasArts
-games. These requests will be ignored.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN98" id="AEN98"></a><b>3.2.</b> Does ScummVM work
-with all versions of games?</p>
-</div>
-<div class="answer">
-<p>See "<a href="#question.supported-games"><i>What games does
-ScummVM support?</i></a>".</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN104" id="AEN104"></a><b>3.3.</b> Can I play through
-xxx (place your favorite SCUMM adventure here) ?</p>
-</div>
-<div class="answer">
-<p>See "<a href="#question.supported-games"><i>What games does
-ScummVM support?</i></a>".</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN110" id="AEN110"></a><b>3.4.</b> Can I save/restore
-the game?</p>
-</div>
-<div class="answer">
-<p>Yes. Saving and restoring is already supported (ALT-1/9 to save,
-CTRL - 1/9 to restore, or F5 to access the save/load menu).</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN115" id="AEN115"></a><b>3.5.</b> Do savegames from
-the original games work in ScummVM?</p>
-</div>
-<div class="answer">
-<p>In general, no. We do not have any plans to load old savegames
-(with the exception of the Simon the Sorcerer series of games).
-Newer versions of ScummVM have also sometimes broken compatibility
-with older ScummVM savegames. Since ScummVM is under heavy
-development, this may occur again in the future.</p>
-</div>
-</div>
-</div>
-<div class="qandadiv">
-<h3><a name="AEN119" id="AEN119"></a>4. Graphics and Audio</h3>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN122" id="AEN122"></a><b>4.1.</b> Does ScummVM
-support CD audio?</p>
-</div>
-<div class="answer">
-<p>Yes, ScummVM fully supports CD audio in Gobliins (CD), Indiana
-Jones and the Last Crusade (FM-TOWNS), Loom (CD & FM-TOWNS),
-Monkey Island 1 (CD, FM-TOWNS & SegaCD) and Zak McKracken
-(FM-TOWNS). Just keep your game CD inserted into your CD drive when
-you start ScummVM. If you have more than one CD drive in your
-system, you can specify your CD drive using the -c command line
-parameter. See the <a href=
-"http://svn.sourceforge.net/viewvc/*checkout*/scummvm/scummvm/trunk/README"
-target="_top">README</a> for more info.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN128" id="AEN128"></a><b>4.2.</b> Does ScummVM
-support using MP3/Ogg/FLAC files instead of CD audio?</p>
-</div>
-<div class="answer">
-<p>Yes. You can use LAME or some other CD audio conversion utility
-to convert your CD audio to MP3. Since version 0.3.0 we also
-support Ogg Vorbis files, and FLAC is supported since version
-0.7.0. See the <a href=
-"http://svn.sourceforge.net/viewvc/*checkout*/scummvm/scummvm/trunk/README"
-target="_top">README</a> for more info.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN134" id="AEN134"></a><b>4.3.</b> Does ScummVM
-support using MP3/Ogg/FLAC files instead of the original MIDI
-music?</p>
-</div>
-<div class="answer">
-<p>No. If all the game does is to play or loop a tune it would be
-possible, but many of the games do fancy stuff like smooth
-transitions from one tune to another, or turn individual
-instruments on and off, etc. There's simply no way ScummVM could
-take a piece of digital music and emulate that kind of
-behaviour.</p>
-<p>This question usually comes up in connection with Sam & Max
-Hit the Road (which has a few unusued bonus audio tracks on the CD)
-and Monkey Island 2 (which is sometimes distributed on the same CD
-as the version of Monkey Island 1 that uses CD audio). Both of
-these games do far too much fancy stuff to even consider an idea
-like this.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN140" id="AEN140"></a><b>4.4.</b> Does ScummVM
-support filtered graphic modes?</p>
-</div>
-<div class="answer">
-<p>Yes, ScummVM supports several filtered graphic modes such as
-<a href="http://elektron.its.tudelft.nl/~dalikifa/" target=
-"_top">Super2xSAI</a>. See the <a href=
-"http://svn.sourceforge.net/viewvc/*checkout*/scummvm/scummvm/trunk/README"
-target="_top">README</a> for more info.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN147" id="AEN147"></a><b>4.5.</b> Can I run my game
-full screen?</p>
-</div>
-<div class="answer">
-<p>Yes. You can either start your game using the -f command line
-parameter, setting the game to Full Screen in the ScummVM Options
-dialog, or by using the Alt+Enter key combination in-game to switch
-between full screen and windowed modes.</p>
-</div>
-</div>
-</div>
-<div class="qandadiv">
-<h3><a name="AEN151" id="AEN151"></a>5. Troubleshooting</h3>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN154" id="AEN154"></a><b>5.1.</b> My game won't
-run.</p>
-</div>
-<div class="answer">
-<p>First make sure your game is supported. See "<a href=
-"#question.supported-games"><i>What games does ScummVM
-support?</i></a>". If it is a supported game and you have followed
-the instructions in <a href=
-"http://svn.sourceforge.net/viewvc/*checkout*/scummvm/scummvm/trunk/README"
-target="_top">README</a> to the letter, then see "<a href=
-"#question.report-bugs"><i>Reporting Bugs.</i></a>" to report this
-as a bug.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN162" id="AEN162"></a><b>5.2.</b> I installed my game
-but ScummVM can't find it.</p>
-</div>
-<div class="answer">
-<p>First don't use the install.exe or setup.exe shipped with the
-game. They usually will not do what you need to run the game with
-ScummVM -- rather they just copy the game .exe and install some
-shortcuts. ScummVM requires all game data to run, so you will need
-to copy those manually. Look at the <a href=
-"http://www.scummvm.org/documentation.php?view=datafiles" target=
-"_top">Game Data Files</a> page for further details.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="question.no-sound" id=
-"question.no-sound"></a><b>5.3.</b> I don't hear any sound.</p>
-</div>
-<div class="answer">
-<p>Check the <a href="http://www.scummvm.org/compatibility.php"
-target="_top">compatibility list</a> to see if your game has sound
-support currently. You can also try the -s command line parameter
-to set the in game SFX volume.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN174" id="AEN174"></a><b>5.4.</b> I don't hear any
-music.</p>
-</div>
-<div class="answer">
-<p>See "<a href="#question.no-sound"><i>I don't hear any
-sound.</i></a>".</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN180" id="AEN180"></a><b>5.5.</b> My game crashes at
-some point.</p>
-</div>
-<div class="answer">
-<p>Check the <a href="http://www.scummvm.org/compatibility.php"
-target="_top">Compatibility List</a> to see if your game has any
-known issues. If you can reproduce this crash more than once,
-please report it to our Bug Tracker. See "<a href=
-"#question.report-bugs"><i>Reporting Bugs.</i></a>".</p>
-<p>If you are experiencing random crashes, and your game plays
-music from CD, you most certainly have encountered a Windows bug.
-Try copying the data files from CD to your hard disk, and running
-them from there.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN188" id="AEN188"></a><b>5.6.</b> ScummVM crashes,
-but console window disappears too quick to see the error
-message.</p>
-</div>
-<div class="answer">
-<p>To make it visible, you should run ScummVM from command line. To
-open a command prompt, open the Start Menu and select the 'Run'
-option. Under Windows NT/2000/XP, type 'cmd.exe' (no quotes) in the
-dialog box that shows up; under Windows 95/98/Me, type
-'command.com' instead. If necessary, change to the proper drive
-first by typing 'D:' (where 'D' is the drive ScummVM is located).
-Change to ScummVM's directory by typing 'cd \your\path\to\scummvm'
-(substituting the appropriate path) and then type 'scummvm'.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="question.messy-colors" id=
-"question.messy-colors"></a><b>5.7.</b> The game colors are messed
-up.</p>
-</div>
-<div class="answer">
-<p>This is a known issue with using Amiga version datafiles. Select
-Amiga as a platform in the ScummVM Game Options dialog, or use the
---platform=amiga command line parameter to enable Amiga-specific
-code.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN198" id="AEN198"></a><b>5.8.</b> The subtitles in my
-non English game are messed up.</p>
-</div>
-<div class="answer">
-<p>You are most likely using a game such as Maniac Mansion or Zak
-McKracken if you have this problem. You need to specify a language
-in the ScummVM Game Options dialog, with the -q parameter or by
-using the 'language' config file option.</p>
-<p>Consult the <a href=
-"http://svn.sourceforge.net/viewvc/*checkout*/scummvm/scummvm/trunk/README"
-target="_top">README</a> or command line help for further
-information.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN205" id="AEN205"></a><b>5.9.</b> How do I make my
-mac version of a game work?</p>
-</div>
-<div class="answer">
-<p>First, if you use a ScummVM version prior to 0.7.0 we strongly
-recommend you to upgrade to the latest version, as we improved
-support for mac games considerably starting with 0.7.0.</p>
-<p>For newer games ScummVM needs the main data file, usually called
-"<Game Title> Data" (where <Game Title>
-is name of your game, such as "The Dig" or
-"Sam & Max"). Some CDs may appear to only contain an
-application (watch out, it has almost the same name as the data
-file, except that it lacks the " Data" at the end). In that case
-there is still a separate data file but it is invisible.</p>
-<p>There also exists a seperate <a href=
-"http://wiki.scummvm.org/index.php/HOWTO-Mac_Games" target=
-"_top">tutorial</a> for setting up Mac versions</p>
-<p>The older games which have LFL files should only need the
-platform set to 'macintosh' to run. See "<a href=
-"#question.messy-colors"><i>The game colors are messed up.</i></a>"
-for information on specifying the game platform.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="question.report-bugs" id=
-"question.report-bugs"></a><b>5.10.</b> Reporting Bugs.</p>
-</div>
-<div class="answer">
-<p>To report a bug, please create a SourceForge account and follow
-the <a href=
-"http://sourceforge.net/tracker/?atid=418820&group_id=37116&func=browse"
-target="_top">bugs</a> link from our homepage. Please make sure the
-bug is reproducible, and still exists in the latest daily
-build/current Subversion version. Also check the <a href=
-"http://www.scummvm.org/compatibility.php" target=
-"_top">compatibility listing</a> for that game to ensure the issue
-is not already known. In your bugreport please provide the
-following information:</p>
-<ul>
-<li>
-<p>ScummVM version (PLEASE test the latest Subversion/Daily
-build)</p>
-</li>
-<li>
-<p>Bug details, including instructions on reproducing it</p>
-</li>
-<li>
-<p>Language of game (English, German, ...)</p>
-</li>
-<li>
-<p>Version of game (talkie, floppy, ...)</p>
-</li>
-<li>
-<p>Platform and Compiler (Win32, Linux, MacOS, ...)</p>
-</li>
-<li>
-<p>Attach a save game if possible</p>
-</li>
-<li>
-<p>If this bug only occurred recently, please note the last version
-without the bug, and the first version including the bug. That way
-we can fix it quicker by looking at the changes made.</p>
-</li>
-</ul>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN237" id="AEN237"></a><b>5.11.</b> I downloaded the
-Broken Sword packs from your site but the game won't run.</p>
-</div>
-<div class="answer">
-<p>These are not full games but reencoded cutscene (video) packs.
-To run the games you still need the original disks. Originally
-cutscenes were encoded in proprietary format and Revolution
-Software kindly permitted us to reencode them into MPEG and
-distribute them freely on our site.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN242" id="AEN242"></a><b>5.12.</b> There are no
-graphics in the Broken Sword I intro.</p>
-</div>
-<div class="answer">
-<p>Be patient. There are about 12 seconds of speech only and
-eventually the Revolution logo will appear.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN247" id="AEN247"></a><b>5.13.</b> I get "WARNING:
-Unable to open configration file C:\windows\scummvm.ini!"</p>
-</div>
-<div class="answer">
-<p>Make sure you have enough permissions to write in c:\windows
-directory. Also note that this warning the first time you run
-ScummVM, since the file does not exist yet then.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN252" id="AEN252"></a><b>5.14.</b> I get "Failed to
-save game state to file: xxx"</p>
-</div>
-<div class="answer">
-<p>Check savepath in Options->Paths->Save Path. That should
-point to writeable directory.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN257" id="AEN257"></a><b>5.15.</b> ScummVM starts,
-but all I get is a transparent window!</p>
-</div>
-<div class="answer">
-<p>This problem has been reported to happen under Windows in some
-cases. Check that you have the latest drivers for your graphics
-card. If that does not help, try setting the <code class=
-"envar">SDL_VIDEODRIVER</code> environment variable to "windib" and
-try again.</p>
-<p>Apparently other applications have had the same problem, because
-the release notes for SDL 1.2.10 (May 17, 2006) contained the
-following note:</p>
-<a name="AEN263" id="AEN263"></a>
-<blockquote class="BLOCKQUOTE">
-<p>The "windib" video driver is the default now, to prevent
-problems with certain laptops, 64-bit Windows, and Windows Vista.
-The DirectX driver is still available, and can be selected by
-setting the environment variable <code class=
-"envar">SDL_VIDEODRIVER</code> to "directx".</p>
-</blockquote>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN267" id="AEN267"></a><b>5.16.</b> ScummVM runs, but
-sound is stuttering and/or garbled!</p>
-</div>
-<div class="answer">
-<p>This problem has been reported to happen under Windows in some
-cases. Check that you have the latest drivers for your sound card.
-If that does not help, try setting the <code class=
-"envar">SDL_AUDIODRIVER</code> environment variable to "waveout"
-and try again.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN273" id="AEN273"></a><b>5.17.</b> How do I set an
-environment variable?</p>
-</div>
-<div class="answer">
-<p>That depends on what operating system and/or command shell you
-are using. Under Windows, you could try creating a file called
-<b class="command">scummvm.bat</b> in the same folder as <b class=
-"command">scummvm.exe</b>. Open this file in your favorite text
-editor and put something like this in it:</p>
-<a name="AEN279" id="AEN279"></a>
-<blockquote class="BLOCKQUOTE">
-<pre class="programlisting">
- at echo off
-set SDL_VIDEODRIVER=windib
-set SDL_AUDIODRIVER=waveout
-scummvm.exe %1 %2 %3 %4 %5 %6 %7 %8 %9
-</pre></blockquote>
-<p>You should now be able to run ScummVM by double-clicking on this
-batch file, instead of the ScummVM executable.</p>
-<p>On more recent versions of Windows, you can also set an
-environment variable permanently, and for all applications, through
-the control panel.</p>
-</div>
-</div>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN284" id="AEN284"></a><b>5.18.</b> ScummVM starts
-somewhere in the middle of my two Xinerama monitors in fullscreen
-mode. Help!</p>
-</div>
-<div class="answer">
-<p>In fact, this is SDL problem. SDL does by default has xinerama
-support enabled. Set the <code class=
-"envar">SDL_VIDEO_FULLSCREEN_HEAD</code> environment variable to
-"1" to start ScummVM (and other SDL applications) in fullscreen on
-only one monitor. If this does not work make sure your SDL library
-does have Xinerama support compiled in.</p>
-</div>
-</div>
-</div>
-<div class="qandadiv">
-<h3><a name="AEN289" id="AEN289"></a>6. Features</h3>
-<div class="qandaentry">
-<div class="question">
-<p><a name="AEN292" id="AEN292"></a><b>6.1.</b> Will you add
-support for zip archives?</p>
-</div>
-<div class="answer">
-<p>We will not do it. There are two main reasons for that. First,
-we believe that it would ease illegal distribution of games.
-Second, we already support compression of sound & speech in
-most larger titles, and use specially designed algorithms like MP3,
-Ogg and FLAC, so you can already reduce the size of the data
-files.</p>
-<p>We as a team already discussed that question. We can't
-absolutely exclude the possibility of changing our mind one day in
-the future, but for now, we have no intentions to do so, hence
-please don't ask us about it!</p>
-</div>
-</div>
-</div>
-</div>
-</div>
-</body>
-</html>

Deleted: docs/trunk/docbook/faq.pdf
===================================================================
(Binary files differ)


Property changes on: docs/trunk/docbook/img
___________________________________________________________________
Name: svn:ignore
   - .DS_Store
   + .DS_Store
*.pdf


Deleted: docs/trunk/docbook/index.html
===================================================================
--- docs/trunk/docbook/index.html	2007-01-05 21:53:53 UTC (rev 25008)
+++ docs/trunk/docbook/index.html	2007-01-05 21:56:35 UTC (rev 25009)
@@ -1,49 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-        "http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<head>
-	<title>ScummVM Manual stuff</title>
-</head>
-<body>
-<h1>ScummVM Manual stuff</h1>
-
-<p>The content of this page is work-in-progress. It's very incomplete, may contain
-arbitrary errors, and in general is used only on your own risk. The main reason
-it is here is to help showcase the new doc stuff to interested people.
-</p>
-
-<p>If you are interested in helping out the documentation effort, please
-feel free to contact us (how you can do that is explained on our
-<a href="http://www.scummvm.org">web site</a>).
-</p>
-
-<h2>Developer's Guide</h2>
-<a href="devguide.xml">DocBook XML source</a><br>
-<a href="devguide.pdf">PDF</a><br>
-<a href="devguide.html">HTML (single page)</a><br>
-<a href="devguide/index.html">HTML (multiple pages)</a><br>
-<a href="devguide.txt">Plain text</a><br>
-
-<h2>User Manual</h2>
-<a href="manual.xml">DocBook XML source</a><br>
-<a href="manual.pdf">PDF</a><br>
-<a href="manual.html">HTML (single page)</a><br>
-<a href="manual/index.html">HTML (multiple pages)</a><br>
-<a href="manual.txt">Plain text</a><br>
-
-<h2>FAQ</h2>
-<a href="faq.xml">DocBook XML source</a><br>
-<a href="faq.pdf">PDF</a><br>
-<a href="faq.html">HTML</a><br>
-<a href="faq.txt">Plain text</a><br>
-
-<h2>Misc stuff</h2>
-<a href="Makefile">Makefile</a><br>
-
-<hr>
-
-<small><em>© 2004 The ScummVM team<br>
-Last changed: 2004-12-21</em></small>
-
-</body>
-</html>

Modified: docs/trunk/docbook/manual.html
===================================================================
--- docs/trunk/docbook/manual.html	2007-01-05 21:53:53 UTC (rev 25008)
+++ docs/trunk/docbook/manual.html	2007-01-05 21:56:35 UTC (rev 25009)
@@ -1,1163 +1,296 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
-"http://www.w3.org/TR/html4/loose.dtd">
-<html>
-<head>
-<meta name="generator" content=
-"HTML Tidy for Mac OS X (vers 1 September 2005), see www.w3.org">
-<title>ScummVM User Manual</title>
-<meta name="GENERATOR" content=
-"Modular DocBook HTML Stylesheet Version 1.79">
-</head>
-<body class="book" bgcolor="#FFFFFF" text="#000000" link="#0000FF"
-vlink="#840084" alink="#0000FF">
-<div class="BOOK"><a name="AEN1" id="AEN1"></a>
-<div class="TITLEPAGE">
-<h1 class="title"><a name="AEN2" id="AEN2">ScummVM User
-Manual</a></h1>
-<h3 class="corpauthor">The ScummVM Team</h3>
-<hr></div>
-<div class="TOC">
-<dl>
-<dt><b>Table of Contents</b></dt>
-<dt>1. <a href="#AEN5">Introduction</a></dt>
-<dd>
-<dl>
-<dt>1.1. <a href="#AEN7">What is ScummVM</a></dt>
-<dt>1.2. <a href="#AEN14">Reporting bugs</a></dt>
-<dt>1.3. <a href="#AEN40">Contacting the developers</a></dt>
-</dl>
-</dd>
-<dt>2. <a href="#AEN46">Getting started</a></dt>
-<dd>
-<dl>
-<dt>2.1. <a href="#AEN48">Requirements</a></dt>
-<dt>2.2. <a href="#AEN83">How to get ScummVM</a></dt>
-<dd>
-<dl>
-<dt>2.2.1. <a href="#AEN86">Binaries</a></dt>
-<dt>2.2.2. <a href="#sec.compiling">Compiling from source</a></dt>
-</dl>
-</dd>
-<dt>2.3. <a href="#AEN121">Installation</a></dt>
-<dd>
-<dl>
-<dt>2.3.1. <a href="#AEN124">Debian</a></dt>
-<dt>2.3.2. <a href="#AEN127">Fedora Core / Redhat</a></dt>
-<dt>2.3.3. <a href="#AEN130">Slackware</a></dt>
-<dt>2.3.4. <a href="#AEN133">Mandrake</a></dt>
-<dt>2.3.5. <a href="#AEN136">Windows</a></dt>
-<dt>2.3.6. <a href="#AEN139">Mac OS X</a></dt>
-<dt>2.3.7. <a href="#AEN142">Windows Mobile (WinCE / PocketPC /
-Smartphone)</a></dt>
-<dt>2.3.8. <a href="#AEN145">PalmOS</a></dt>
-<dt>2.3.9. <a href="#AEN148">Dreamcast</a></dt>
-</dl>
-</dd>
-<dt>2.4. <a href="#AEN151">First steps</a></dt>
-<dd>
-<dl>
-<dt>2.4.1. <a href="#AEN162">Unix-like, Windows, Mac OS X</a></dt>
-<dt>2.4.2. <a href="#AEN165">WinCE / PocketPC</a></dt>
-<dt>2.4.3. <a href="#AEN168">Dreamcast</a></dt>
-</dl>
-</dd>
-</dl>
-</dd>
-<dt>3. <a href="#AEN171">Running and using ScummVM</a></dt>
-<dd>
-<dl>
-<dt>3.1. <a href="#AEN173">The launcher</a></dt>
-<dd>
-<dl>
-<dt>3.1.1. <a href="#AEN176">Adding/removing a game</a></dt>
-<dt>3.1.2. <a href="#AEN213">Configuring a game</a></dt>
-<dt>3.1.3. <a href="#AEN216">The (global) options dialog</a></dt>
-</dl>
-</dd>
-<dt>3.2. <a href="#AEN243">Command line options</a></dt>
-<dt>3.3. <a href="#AEN434">Hot Keys</a></dt>
-<dt>3.4. <a href="#AEN437">Saving and loading</a></dt>
-<dt>3.5. <a href="#AEN440">Using Macintosh games</a></dt>
-<dt>3.6. <a href="#AEN443">Multi-CD Games</a></dt>
-<dd>
-<dl>
-<dt>3.6.1. <a href="#AEN449">The Curse of Monkey Island</a></dt>
-<dt>3.6.2. <a href="#AEN453">Broken Sword 1</a></dt>
-<dt>3.6.3. <a href="#AEN458">Broken Sword 2</a></dt>
-</dl>
-</dd>
-</dl>
-</dd>
-<dt>4. <a href="#AEN463">Configuration</a></dt>
-<dd>
-<dl>
-<dt>4.1. <a href="#AEN465">Using the launcher</a></dt>
-<dt>4.2. <a href="#AEN468">All config file switches in
-detail</a></dt>
-<dt>4.3. <a href="#AEN471">Graphics Filters</a></dt>
-<dt>4.4. <a href="#AEN529">Music and Sound</a></dt>
-<dd>
-<dl>
-<dt>4.4.1. <a href="#AEN532">Music drivers</a></dt>
-<dt>4.4.2. <a href="#AEN535">Using compressed audiofiles</a></dt>
-<dt>4.4.3. <a href="#AEN538">Volume settings</a></dt>
-<dt>4.4.4. <a href="#AEN541">Output sample rate</a></dt>
-</dl>
-</dd>
-</dl>
-</dd>
-<dt>A. <a href="#sec.supported-games">Supported Games</a></dt>
-<dd>
-<dl>
-<dt>A.1. <a href="#AEN551">LucasArts Games</a></dt>
-<dt>A.2. <a href="#AEN611">Humongous Games</a></dt>
-<dt>A.3. <a href="#AEN614">Adventure Soft Games</a></dt>
-<dt>A.4. <a href="#AEN617">Revolution Games</a></dt>
-<dt>A.5. <a href="#AEN620">Interactive Binary Illusions
-Games</a></dt>
-<dt>A.6. <a href="#AEN623">Other Games</a></dt>
-</dl>
-</dd>
-<dt>B. <a href="#AEN626">Tools</a></dt>
-<dd>
-<dl>
-<dt>B.1. <a href="#AEN629">compress_san</a></dt>
-<dt>B.2. <a href="#AEN645">compress_scumm_sou</a></dt>
-<dt>B.3. <a href="#AEN650">queenrebuild</a></dt>
-<dt>B.4. <a href="#AEN655">compress_simon</a></dt>
-<dt>B.5. <a href="#AEN660">compress_sword1</a></dt>
-<dt>B.6. <a href="#AEN665">compress_sword2</a></dt>
-</dl>
-</dd>
-<dt>C. <a href="#AEN671">Credits</a></dt>
-<dt><a href="#AEN1361">Glossary</a></dt>
-</dl>
-</div>
-<div class="LOT">
-<dl class="LOT">
-<dt><b>List of Examples</b></dt>
-<dt>3-1. <a href="#AEN422">Running Monkey Island, fullscreen, from
-a hard disk (Win32)</a></dt>
-<dt>3-2. <a href="#AEN425">Running Full Throttle from CD,
-fullscreen and with subtitles enabled (Win32)</a></dt>
-<dt>3-3. <a href="#AEN428">Running Monkey Island, fullscreen, from
-a hard disk (Unix)</a></dt>
-<dt>3-4. <a href="#AEN431">Running Full Throttle from CD,
-fullscreen and with subtitles enabled (Unix)</a></dt>
-<dt>B-1. <a href="#AEN641">Using compress_san</a></dt>
-</dl>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN5" id="AEN5"></a>Chapter 1. Introduction</h1>
-<div class="section">
-<h2 class="section"><a name="AEN7" id="AEN7">1.1. What is
-ScummVM</a></h2>
-<p>ScummVM is a collection of interpreters, capable of emulating
-several adventure game engines. ScummVM mainly supports games
-created using SCUMM (Script Creation Utility for Maniac Mansion),
-used in various LucasArts games such as Monkey Island, Day of the
-Tentacle, and others.</p>
-<p>ScummVM also contains interpreters for several non-SCUMM games.
-Currently these are Beneath a Steel Sky, Broken Sword 1 & 2,
-Flight of the Amazon Queen and Simon the Sorcerer 1 & 2.</p>
-<p>At this time ScummVM should be considered beta software, and is
-still under heavy development. Be aware that whilst we attempt to
-make sure that many games can be completed with few major bugs,
-crashes can happen.</p>
-<p>If you enjoy ScummVM feel free to donate using the PayPal button
-on the <a href="http://www.scummvm.org" target="_top">ScummVM
-homepage</a>. This will help us buy utilities needed to develop
-ScummVM easier and quicker. If you cannot donate, help and
-contribute a patch!</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN14" id="AEN14">1.2. Reporting
-bugs</a></h2>
-<p>To report a bug, please create a <a href=
-"http://sourceforge.net" target="_top">SourceForge account</a> and
-follow the bugs link from our homepage. Please make sure the bug is
-reproducible, and still occurs in the latest daily build/current
-CVS version. Also check the known bugs list (below) and
-compatibility listing for that game, to ensure the issue is not
-already known.</p>
-<p>Also, please do not report bugs on games that are not listed as
-being completable in <a href="#sec.supported-games">Appendix A</a>
-(<a href="#sec.supported-games"><i>Supported Games</i></a>), or in
-the online <a href="http://www.scummvm.org/compatibility.php"
-target="_top">compatibility list</a>. We already <span class=
-"emphasis"><i class="emphasis">know</i></span> those games have
-bugs.</p>
-<p>Please include the following information:</p>
-<ul>
-<li>
-<p>ScummVM version (PLEASE test the latest CVS/Daily build)</p>
-</li>
-<li>
-<p>Bug details, including instructions on reproducing</p>
-</li>
-<li>
-<p>Language of game (English, German, ...)</p>
-</li>
-<li>
-<p>Version of game (talkie, floppy, ...)</p>
-</li>
-<li>
-<p>Platform and Compiler (Win32, Linux, FreeBSD, ...)</p>
-</li>
-<li>
-<p>Attach a save game if possible</p>
-</li>
-<li>
-<p>If this bug only occurred recently, please note the last version
-without the bug, and the first version including the bug. That way
-we can fix it quicker by looking at the changes made.</p>
-</li>
-</ul>
-<p>This should only take you a little time but will make it much
-easier for us to process your bug report in a way that satisfies
-both you and us.</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN40" id="AEN40">1.3. Contacting the
-developers</a></h2>
-<p>The easiest way to contact the ScummVM team is by submitting bug
-reports or commenting in our forums. You can also join and e-mail
-the scummvm-devel mailing list (see <a href=
-"http://lists.sourceforge.net/lists/listinfo/scummvm-devel" target=
-"_top">http://lists.sourceforge.net/lists/listinfo/scummvm-devel</a>).
-Or chat with us on IRC: channel #scummvm on irc.freenode.net.</p>
-<p>Please do not ask us to support an unsupported game. We do
-<span class="emphasis"><i class="emphasis">not</i></span> generally
-add support for non-SCUMM games! Reverse engineering a completely
-new game without source is a long process, and our developers are
-all very busy as it is... so unless you work for a company
-interested in providing us with source code for one of your classic
-titles, please do not ask.</p>
-</div>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN46" id="AEN46"></a>Chapter 2. Getting started</h1>
-<div class="section">
-<h2 class="section"><a name="AEN48" id="AEN48">2.1.
-Requirements</a></h2>
-<p>TODO: List Requirements (in terms of required/optional
-libraries, CPU power, memory, ... In particular it would be nice if
-we could e.g. say what PalmOS devices support ScummVM; not
-necessarily a list of all supported Palm models, but more a list of
-what OS you need how much memory, colors, etc.)</p>
-<p>ScummVM is known to run on the following systems:</p>
-<ul>
-<li>
-<p>Unix-like (Linux, *BSD, Solaris, etc.)</p>
-</li>
-<li>
-<p>Windows</p>
-</li>
-<li>
-<p>Mac OS X</p>
-</li>
-<li>
-<p>Windows Mobile (WinCE / PocketPC / Smartphone)</p>
-</li>
-<li>
-<p>PalmOS</p>
-</li>
-<li>
-<p>Dreamcast</p>
-</li>
-</ul>
-<p>Besides these, there have been many more inofficial ports in the
-past. Since they were not done by us, we can not say anything about
-their reliability, legality, or availability, nor can we provide
-support for them. Use them at your own risk!</p>
-<p>Among those officially unsupported systems are:</p>
-<ul>
-<li>
-<p>MorphOS</p>
-</li>
-<li>
-<p>GP32</p>
-</li>
-<li>
-<p>Symbian based smartphones</p>
-</li>
-<li>
-<p>XBox</p>
-</li>
-<li>
-<p>PlayStation 2</p>
-</li>
-<li>
-<p>RISC OS</p>
-</li>
-</ul>
-<p>If you plan to compile ScummVM yourself, you will need certain
-additional libraries. More on that in the section <a href=
-"#sec.compiling">Section 2.2.2</a> (<a href=
-"#sec.compiling"><i>Compiling from source</i></a>).</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN83" id="AEN83">2.2. How to get
-ScummVM</a></h2>
-<p>Basically you have two choices on how to get ScummVM: either you
-download one of the binaries we built for you (probably the most
-convenient way); or you can compiler it yourself from source. We
-strongly recommend to beginners to use our prebuilt binaries.</p>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN86" id="AEN86">2.2.1.
-Binaries</a></h3>
-<p>You can download ScummVM from our downloads page: <a href=
-"http://www.scummvm.org/downloads.php" target=
-"_top">http://www.scummvm.org/downloads.php</a>. Go there with your
-favorite web browser and download the binary for your platform. If
-none is available, you may have to build ScummVM yourself, refer to
-the next section for instructions on how to do that.</p>
-<p>We always ship prebuilt binaries of ScummVM for the following
-platforms (note that it can sometimes take a few days after a
-release for all binaries to be available):</p>
-<ul>
-<li>
-<p>Linux (Fedora Core)</p>
-</li>
-<li>
-<p>Linux (Debian)</p>
-</li>
-<li>
-<p>Windows</p>
-</li>
-<li>
-<p>Mac OS X</p>
-</li>
-<li>
-<p>Windows Mobile (WinCE / PocketPC / Smartphone)</p>
-</li>
-<li>
-<p>PalmOS</p>
-</li>
-<li>
-<p>Dreamcast</p>
-</li>
-</ul>
-<p>In addition to these, we try to provide more binaries, but which
-depends mostly on how many volunteers we can find to help us out.
-In the past we have shipped binaries for these systems:</p>
-<ul>
-<li>
-<p>Linux (Mandrake)</p>
-</li>
-<li>
-<p>Linux (Slackware)</p>
-</li>
-<li>
-<p>Solaris</p>
-</li>
-<li>
-<p>BeOS</p>
-</li>
-<li>
-<p>MorphOS</p>
-</li>
-</ul>
-</div>
-<div class="section">
-<hr>
-<h3 class="section"><a name="sec.compiling" id=
-"sec.compiling">2.2.2. Compiling from source</a></h3>
-<p>TODO: (with more detail than now); pointer to the to-be-written
-"Developer's Guide to ScummVM" * List all required libs; where to
-get them; how to install them * List all optional libs etc. * We
-could separate this by OS, or by compiler/dev system. I think the
-current split in the README (section 9.0) isn't too bad.</p>
-</div>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN121" id="AEN121">2.3.
-Installation</a></h2>
-<p>After you have obtained ScummVM as described in the previous
-section, you probably will want to install it on your system. The
-steps required for that differ between the various operating
-systems. In the following we try to cover all the systems we
-officially support.</p>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN124" id="AEN124">2.3.1.
-Debian</a></h3>
-<p>TODO: Describe how to install via apt-get etc.</p>
-</div>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN127" id="AEN127">2.3.2. Fedora Core
-/ Redhat</a></h3>
-<p>TODO: Describe how to install the RPM</p>
-</div>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN130" id="AEN130">2.3.3.
-Slackware</a></h3>
-<p>TODO: Describe how to install the slackware package</p>
-</div>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN133" id="AEN133">2.3.4.
-Mandrake</a></h3>
-<p>TODO</p>
-</div>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN136" id="AEN136">2.3.5.
-Windows</a></h3>
-<p>TODO: Describe which file to download, how to install it
-etc.</p>
-</div>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN139" id="AEN139">2.3.6. Mac OS
-X</a></h3>
-<p>TODO: Describe downloading the .dmg, opening it, copying ScummVM
-to appropriate place.</p>
-</div>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN142" id="AEN142">2.3.7. Windows
-Mobile (WinCE / PocketPC / Smartphone)</a></h3>
-<p>TODO: Describe installation, possibly based on the PocketSCUMM
-FAQ</p>
-</div>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN145" id="AEN145">2.3.8.
-PalmOS</a></h3>
-<p>TODO</p>
-</div>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN148" id="AEN148">2.3.9.
-Dreamcast</a></h3>
-<p>TODO: Might need to explain CD burning techniques here...</p>
-</div>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN151" id="AEN151">2.4. First
-steps</a></h2>
-<p>TODO: (basic setup; how to add a game using the launcher and the
-play it, getting a first game to run).</p>
-<p>Note: We use the default launcher GUI on many systems, but some
-have their own custom launcher, so we'll want to have a separate
-section with different screen shots for those.</p>
-<div class="mediaobject">
-<p><img src="img/launcher-empty.png" align="center"></p>
-</div>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN162" id="AEN162">2.4.1. Unix-like,
-Windows, Mac OS X</a></h3>
-<p>TODO</p>
-</div>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN165" id="AEN165">2.4.2. WinCE /
-PocketPC</a></h3>
-<p>TODO</p>
-</div>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN168" id="AEN168">2.4.3.
-Dreamcast</a></h3>
-<p>TODO</p>
-</div>
-</div>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN171" id="AEN171"></a>Chapter 3. Running and using
-ScummVM</h1>
-<div class="section">
-<h2 class="section"><a name="AEN173" id="AEN173">3.1. The
-launcher</a></h2>
-<p>TODO: Explain the launcher and how to use it (even though I hope
-that it's pretty much straightforward); including screenshots?
-Also, handle that the launcher is not the same on all ports (e.g.
-it is different on Dreamcast).</p>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN176" id="AEN176">3.1.1.
-Adding/removing a game</a></h3>
-<p>Adding a new game via the ScummVM launcher should hopefully be
-quite straight forward.</p>
-<ol type="1">
-<li>
-<p>In the launcher, press the "Add..." button at the bottom of the
-screen.</p>
-</li>
-<li>
-<p>In response, ScummVM will present you with a file (or rather,
-"directory") browser dialog. Use it to navigate to the directory
-where the data files of your game are contained in. Once you are
-there, "Choose" the directory using the like named button.</p>
-<div class="mediaobject">
-<p><img src="img/launcher-browser.png" align="center"></p>
-<div class="caption">
-<p>The file browser (while adding a game to the launcher).</p>
-</div>
-</div>
-</li>
-<li>
-<p>After choosing a directory in the above step which contains a
-game supported and recognized by ScummVM, you will be presented
-with a dialog in which you can, amongst other things, choose a
-'target name' to be used for the game, and enter a plain text
-description for it.</p>
-<p>Don't worry if you are not sure what to enter here: in most
-cases you can just press OK, as ScummVM tries to set reasonable
-default values here. You can always come back later and change
-everything as you please.</p>
-<div class="mediaobject">
-<p><img src="img/launcher-edit-game.png" align="center"></p>
-<div class="caption">
-<p>The dialog which allows you to edit the settings of a game
-target.</p>
-</div>
-</div>
-</li>
-<li>
-<p>If all went well, you should now find yourself back in the
-launcher, only that now the list of games should now contains the
-new entry you added.</p>
-<div class="mediaobject">
-<p><img src="img/launcher-after-add.png" align="center"></p>
-<div class="caption">
-<p>The launcher, after adding a game.</p>
-</div>
-</div>
-</li>
-</ol>
-</div>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN213" id="AEN213">3.1.2. Configuring
-a game</a></h3>
-<p>TODO: Explain how to edit the settings for a game in the
-launcher; explain what those setting means, with refs to the
-corresponding sections in this doc.</p>
-</div>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN216" id="AEN216">3.1.3. The
-(global) options dialog</a></h3>
-<p>TODO: Explain the various settings in this dialog, with
-screenshots.</p>
-<div class="mediaobject">
-<p><img src="img/launcher-options-graphics.png" align="center"></p>
-<div class="caption">
-<p>The global graphics settings.</p>
-</div>
-</div>
-<div class="mediaobject">
-<p><img src="img/launcher-options-audio.png" align="center"></p>
-<div class="caption">
-<p>The global audio settings.</p>
-</div>
-</div>
-<div class="mediaobject">
-<p><img src="img/launcher-options-misc.png" align="center"></p>
-<div class="caption">
-<p>More global settings.</p>
-</div>
-</div>
-</div>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN243" id="AEN243">3.2. Command line
-options</a></h2>
-<p><b class="command">scummvm</b> [<tt class=
-"replaceable"><i>OPTIONS</i></tt>...] <tt class=
-"replaceable"><i>GAME</i></tt></p>
-<div class="variablelist">
-<dl>
-<dt>-v, --version</dt>
-<dd>
-<p>Display ScummVM version information and exit.</p>
-</dd>
-<dt>-h, --help</dt>
-<dd>
-<p>Display a brief help text and exit.</p>
-</dd>
-<dt>-z, --list-games</dt>
-<dd>
-<p>Display list of supported games and exit</p>
-</dd>
-<dt>-t, --list-targets</dt>
-<dd>
-<p>Display list of configured targets and exit</p>
-</dd>
-<dt>-c, --config=<tt class="replaceable"><i>CONFIG</i></tt></dt>
-<dd>
-<p>Use alternate configuration file</p>
-</dd>
-<dt>-p, --path=<tt class="replaceable"><i>PATH</i></tt></dt>
-<dd>
-<p>Path to where the game is installed</p>
-</dd>
-<dt>-x, --save-slot[<span class="optional">=<tt class=
-"replaceable"><i>NUM</i></tt></span>]</dt>
-<dd>
-<p>Save game slot to load (default: autosave)</p>
-</dd>
-<dt>-f, --fullscreen</dt>
-<dd>
-<p>Force full-screen mode</p>
-</dd>
-<dt>-F, --no-fullscreen</dt>
-<dd>
-<p>Force windowed mode</p>
-</dd>
-<dt>-g, --gfx-mode=<tt class="replaceable"><i>MODE</i></tt></dt>
-<dd>
-<p>Select graphics scaler (see also section 5.3)</p>
-</dd>
-<dt>-e, --music-driver=<tt class=
-"replaceable"><i>MODE</i></tt></dt>
-<dd>
-<p>Select music driver (see also section 7.0)</p>
-</dd>
-<dt>-q, --language=<tt class="replaceable"><i>LANG</i></tt></dt>
-<dd>
-<p>Select language (see also section 5.2)</p>
-</dd>
-<dt>-m, --music-volume=<tt class="replaceable"><i>NUM</i></tt></dt>
-<dd>
-<p>Set the music volume, 0-255 (default: 192)</p>
-</dd>
-<dt>-s, --sfx-volume=<tt class="replaceable"><i>NUM</i></tt></dt>
-<dd>
-<p>Set the sfx volume, 0-255 (default: 192)</p>
-</dd>
-<dt>-r, --speech-volume=<tt class=
-"replaceable"><i>NUM</i></tt></dt>
-<dd>
-<p>Set the voice volume, 0-255 (default: 192)</p>
-</dd>
-<dt>-n, --subtitles</dt>
-<dd>
-<p>Enable subtitles (use with games that have voice)</p>
-</dd>
-<dt>-b, --boot-param=<tt class="replaceable"><i>NUM</i></tt></dt>
-<dd>
-<p>Pass number to the boot script (boot param)</p>
-</dd>
-<dt>-d, --debuglevel=<tt class="replaceable"><i>NUM</i></tt></dt>
-<dd>
-<p>Set debug verbosity level</p>
-</dd>
-<dt>-u, --dump-scripts</dt>
-<dd>
-<p>Enable script dumping if a directory called 'dumps' exists in
-the current directory</p>
-</dd>
-<dt>--cdrom=<tt class="replaceable"><i>NUM</i></tt></dt>
-<dd>
-<p>CD drive to play CD audio from (default: 0 = first drive)</p>
-</dd>
-<dt>--joystick[<span class="optional">=<tt class=
-"replaceable"><i>NUM</i></tt></span>]</dt>
-<dd>
-<p>Enable input with joystick (default: 0 = first joystick)</p>
-</dd>
-<dt>--platform=<tt class="replaceable"><i>WORD</i></tt></dt>
-<dd>
-<p>Specify version of game (allowed values: amiga, atari, fmtowns,
-mac, pc, windows)</p>
-</dd>
-<dt>--savepath=<tt class="replaceable"><i>PATH</i></tt></dt>
-<dd>
-<p>Path to where savegames are stored</p>
-</dd>
-<dt>--multi-midi</dt>
-<dd>
-<p>Enable combination of Adlib and native MIDI</p>
-</dd>
-<dt>--native-mt32</dt>
-<dd>
-<p>True Roland MT-32 (disable GM emulation)</p>
-</dd>
-<dt>--output-rate=<tt class="replaceable"><i>RATE</i></tt></dt>
-<dd>
-<p>Select output sample rate in Hz (e.g. 22050)</p>
-</dd>
-<dt>--aspect-ratio</dt>
-<dd>
-<p>Enable aspect ratio correction</p>
-</dd>
-<dt>--alt-intro</dt>
-<dd>
-<p>Use alternative intro for CD versions of Beneath a Steel Sky and
-Flight of the Amazon Queen</p>
-</dd>
-<dt>--copy-protection</dt>
-<dd>
-<p>Enable copy protection in SCUMM games, when ScummVM disables it
-by default.</p>
-</dd>
-<dt>--demo-mode</dt>
-<dd>
-<p>Start demo mode of Maniac Mansion (Classic version)</p>
-</dd>
-<dt>--tempo=<tt class="replaceable"><i>NUM</i></tt></dt>
-<dd>
-<p>Set music tempo (in percent, 50-200) for SCUMM games (default:
-100)</p>
-</dd>
-<dt>--talkspeed=<tt class="replaceable"><i>NUM</i></tt></dt>
-<dd>
-<p>Set talk speed for SCUMM games</p>
-</dd>
-</dl>
-</div>
-<p>The meaning of most long options (that is, those starting with a
-double-dash) can be inverted by prefixing them with "no-". For
-example, --no-aspect-ratio will turn aspectio ratio correction
-off.</p>
-<p>The short game name ('game target') you see at the end of the
-command line is very important. A short list is contained at the
-top of this file. You can also get the current list of games and
-game names at <a href="http://www.scummvm.org/compatibility.php"
-target="_top">http://www.scummvm.org/compatibility.php</a></p>
-<div class="example"><a name="AEN422" id="AEN422"></a>
-<p><b>Example 3-1. Running Monkey Island, fullscreen, from a hard
-disk (Win32)</b></p>
-<pre class="screen">
-C:\Games\LucasArts\scummvm.exe -f -pC:\Games\LucasArts\monkey\ monkey
-</pre></div>
-<div class="example"><a name="AEN425" id="AEN425"></a>
-<p><b>Example 3-2. Running Full Throttle from CD, fullscreen and
-with subtitles enabled (Win32)</b></p>
-<pre class="screen">
-C:\Games\LucasArts\scummvm.exe -f -n -pD:\resource\ ft
-</pre></div>
-<div class="example"><a name="AEN428" id="AEN428"></a>
-<p><b>Example 3-3. Running Monkey Island, fullscreen, from a hard
-disk (Unix)</b></p>
-<pre class="screen">
-/path/to/scummvm -f -p/games/LucasArts/monkey/ monkey
-</pre></div>
-<div class="example"><a name="AEN431" id="AEN431"></a>
-<p><b>Example 3-4. Running Full Throttle from CD, fullscreen and
-with subtitles enabled (Unix)</b></p>
-<pre class="screen">
-/path/to/scummvm -f -n -p/cdrom/resource/ ft
-</pre></div>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN434" id="AEN434">3.3. Hot
-Keys</a></h2>
-<p>TODO: This also has to cover platform specific details...</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN437" id="AEN437">3.4. Saving and
-loading</a></h2>
-<p>TODO: Where savegames are stored; autosaves; how to save/load in
-the various games (i.e. F5 in SCUMM games); including screenshots,
-maybe?</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN440" id="AEN440">3.5. Using
-Macintosh games</a></h2>
-<p>TODO: How to access the HFS disks from a non-mac; maybe point to
-rescumm, although this shouldn't be necessary anymore now.</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN443" id="AEN443">3.6. Multi-CD
-Games</a></h2>
-<p>In general, ScummVM does not deal very well with multi-CD games.
-This is because ScummVM assumes everything about a game can be
-found in one directory. Even if ScummVM does make some provisions
-for asking the user to change CD, the original games usually
-install a small number of files to hard disk. Unless these files
-can be found on all the CDs, ScummVM will be in trouble.</p>
-<p>Fortunately, ScummVM has no problems running the games entirely
-from hard disk, if you create a directory with the correct
-combination of files. Usually, when a file appears on more than one
-CD you can pick either of them.</p>
-<p>These instructions are written for the PC versions (which in
-some case is the only version) of the games. Windows and DOS use
-case-insensitive file systems, so if one CD has a file called
-MONKEY.DAT and another has a file called monkey.dat, they are the
-same files. These instructions give file names in all lower-case
-names, even if that's not always how they appear on the CDs. In
-fact, on case-sensitive file systems you will have to make sure
-that all filenames use either all upper- or all lower-case letters
-for ScummVM to be able to find the files.</p>
-<p>The instructions for the Broken Sword games are for the Sold-Out
-Software versions, which are the ones you are probably most likely
-to find in stores now.</p>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN449" id="AEN449">3.6.1. The Curse
-of Monkey Island</a></h3>
-<p>For this game, you'll need the comi.la0, comi.la1 and comi.la2
-files. The comi.la0 file can be found on either CD, but since they
-are identical it doesn't matter which one of them you use.</p>
-<p>In addition, you'll need a resource subdirectory with all of the
-files from the resource subdirectories on both CDs. Some of the
-files appear on both CDs, but again they're identical.</p>
-</div>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN453" id="AEN453">3.6.2. Broken
-Sword 1</a></h3>
-<p>For this game, you'll need all of the files from the clusters
-directories on both CDs. You will also need the speech.clu files
-from the speech directories, but since they are not identical
-you'll need to rename them speech1.clu and speech2.clu for CD 1 and
-2 respectively.</p>
-<p>In addition, you will need a music subdirectory with all of the
-files from the music subdirectories on both CDs. Some of these
-files appear on both CDs, but in these cases they are either
-identical or, in one case, so nearly identical that it makes little
-difference.</p>
-<p>ScummVM does not support the original cutscene files (with file
-extension .smk) for legal reasons, so there is no need to copy
-them.</p>
-</div>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN458" id="AEN458">3.6.3. Broken
-Sword 2</a></h3>
-<p>For this game, you'll need all of the files from the clusters
-directories on both CDs. (Actually, a few of them may not be
-strictly necessary, but the ones that I'm uncertain about are all
-fairly small.) You will need to rename the speech.clu and music.clu
-files speech1.clu, speech2.clu, music1.clu and music2.clu so that
-ScummVM can tell which ones are from CD 1 and which ones are from
-CD 2. Any other files that appear in both cluster directories are
-identical. Use whichever you like.</p>
-<p>In addition, you will need the cd.bin, cd.inf and startup.inf
-files from the sword2 directory on CD 1.</p>
-<p>ScummVM does not support the original cutscene files (with file
-extension .smk) for legal reasons, so there is no need to copy
-them.</p>
-</div>
-</div>
-</div>
-<div class="chapter">
-<hr>
-<h1><a name="AEN463" id="AEN463"></a>Chapter 4. Configuration</h1>
-<div class="section">
-<h2 class="section"><a name="AEN465" id="AEN465">4.1. Using the
-launcher</a></h2>
-<p>TODO</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN468" id="AEN468">4.2. All config
-file switches in detail</a></h2>
-<p>TODO</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN471" id="AEN471">4.3. Graphics
-Filters</a></h2>
-<p>ScummVM offers several anti-aliasing filters to attempt to
-improve visual quality. These are the same filters used in many
-other emulators, such as MAME. These filters take the original game
-graphics, and scale it by a certain fixed factor (usually 2x or 3x)
-before displaying them to you. So for example, if the game
-originally run at a resolution of 320x200 (typical for most of the
-SCUMM games), then using a filter with scale factor 2x will
-effectively yield 640x400 graphics. Likewise with a 3x filter
-you'll get 960x600.</p>
-<p>They are:</p>
-<div class="variablelist">
-<dl>
-<dt>normal</dt>
-<dd>
-<p>No filtering, no scaling. Fastest.</p>
-</dd>
-<dt>2x</dt>
-<dd>
-<p>No filtering, factor 2x (default for non 640x480 games).</p>
-</dd>
-<dt>3x</dt>
-<dd>
-<p>No filtering, factor 3x.</p>
-</dd>
-<dt>2xsai</dt>
-<dd>
-<p>2xsai filter, factor 2x.</p>
-</dd>
-<dt>super2xsai</dt>
-<dd>
-<p>Enhanced 2xsai filtering, factor 2x.</p>
-</dd>
-<dt>supereagle</dt>
-<dd>
-<p>Less blurry than 2xsai, but slower. Factor 2x.</p>
-</dd>
-<dt>advmame2x</dt>
-<dd>
-<p>Doesn't rely on blurring like 2xSAI, fast. Factor 2x.</p>
-</dd>
-<dt>advmame3x</dt>
-<dd>
-<p>Doesn't rely on blurring like 2xSAI, fast. Factor 3x.</p>
-</dd>
-<dt>hq2x</dt>
-<dd>
-<p>Very nice high quality filter but slow. Factor 2x.</p>
-</dd>
-<dt>hq3x</dt>
-<dd>
-<p>Very nice high quality filter but slow. Factor 3x.</p>
-</dd>
-<dt>tv2x</dt>
-<dd>
-<p>Interlace filter, tries to emulate a TV. Factor 2x.</p>
-</dd>
-<dt>dotmatrix</dt>
-<dd>
-<p>Dot matrix effect. Factor 2x.</p>
-</dd>
-</dl>
-</div>
-<p>To select a graphics filter, pass its name via the '-g' option
-to scummvm, for example:</p>
-<pre class="screen">
-  scummvm -g advmame2x monkey2
-</pre>
-<p>Note #1: Not all backends support all or any filters. The ones
-listed above are for the default SDL backend.</p>
-<p>Note #2: Filters can be very slow when ScummVM is compiled in a
-debug configuration without optimizations. And there is always a
-speed impact when using any form of anti-aliasing/linear
-filtering.</p>
-<p>Note #3: The FM-TOWNS version of Zak (zaktowns target) uses an
-original resolution of 320x240 - hence for this game scalers will
-scale to 640x480 or 960x720.</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN529" id="AEN529">4.4. Music and
-Sound</a></h2>
-<p>TODO</p>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN532" id="AEN532">4.4.1. Music
-drivers</a></h3>
-<p>TODO: Music/midi drivers: list them all, with desc, and
-explanations (current sections 7.0-7.5). Try to help the user in
-choosing the "best" driver.</p>
-</div>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN535" id="AEN535">4.4.2. Using
-compressed audiofiles</a></h3>
-<p>TODO: Corresponds to current section 7.6. --> Intro-section
-which briefly mentions pros/cons of compressing your audio data;
-and compares the different encoding schemes. It would also caution
-the user to check that their ScummVM build actually supports that
-particular encoding --> sections for: CD tracks; SCUMM; Simon;
-BS1; BS2 right now we have multiple near-identical sections for CD
-MP3; CD Ogg; CD Flac; MONSTER.SOU MP3; ... etc. you get the idea.
-I'd prefer if we joined these, to reduce duplications...</p>
-</div>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN538" id="AEN538">4.4.3. Volume
-settings</a></h3>
-<p>TODO: Explain about the volume settings, what the values mean,
-etc. The launcher, command line, config file sections all would
-refer to here.</p>
-</div>
-<div class="section">
-<hr>
-<h3 class="section"><a name="AEN541" id="AEN541">4.4.4. Output
-sample rate</a></h3>
-<p>The output sample rate tells ScummVM how many sound samples to
-play per channel per second. There is much that could be said on
-this subject, but most of it would be irrelevant here. The short
-version is that for most games 22050 Hz is fine, but in some cases
-44100 Hz is preferable. On extremely low-end systems you may want
-to use 11025 Hz, but it's unlikely that you have to worry about
-that.</p>
-<p>To elaborate, most of the sounds ScummVM has to play were
-sampled at either 22050 Hz or 11025 Hz. Using a higher sample rate
-will not magically improve the quality of these sounds. Hence,
-22050 Hz is fine.</p>
-<p>Some games use CD audio. If you use compressed files for this,
-they are probably sampled at 44100 Hz, so for these games that may
-be a better choice of sample rate.</p>
-<p>When using the Adlib, FM Towns, PC Speaker or IBM PCjr music
-drivers, ScummVM is responsible for generating the samples. Usually
-22050 Hz will be plenty for these, but there is at least one piece
-of Adlib music in Beneath a Steeel Sky that will sound a lot better
-at 44100 Hz.</p>
-<p>Using frequencies in between is not recommended. For one thing,
-your sound card may not support it. In theory, ScummVM should fall
-back on a sensible frequency in that case, but don't count on it.
-More importantly, ScummVM has to resample all sounds to its output
-frequency. This is much easier to do well if the output frequency
-is a multiple of the original frequency.</p>
-</div>
-</div>
-</div>
-<div class="appendix">
-<hr>
-<h1><a name="sec.supported-games" id=
-"sec.supported-games"></a>Appendix A. Supported Games</h1>
-<p>TODO: Here we list *all* supported games, with some information
-on each like known problems, which versions are supported
-precisely, where to get cutscene packs etc.</p>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN551" id="AEN551">A.1. LucasArts
-Games</a></h2>
-<p>TODO: Add a list of all LEC SCUMM games here, with note
-regarding which variants we (don't) support, pointers to special
-problems (how to deal with the mac versions if you are on a PC, for
-example), etc.</p>
-<div class="informaltable"><a name="AEN554" id="AEN554"></a>
-<table border="1" frame="border" rules="all" class="CALSTABLE">
-<col width="1*" title="c1">
-<col width="1*" title="c2">
-<thead>
-<tr valign="top">
-<th colspan="2" align="center">Monkey Island 2: LeChuck's
-revenge</th>
-</tr>
-</thead>
-<tbody>
-<tr valign="top">
-<td>Target(s):</td>
-<td>monkey2</td>
-</tr>
-<tr valign="top">
-<td>Supported variants:</td>
-<td>Amiga, FM-TOWNS, Mac and PC versions supported</td>
-</tr>
-<tr valign="top">
-<td>Known issues:</td>
-<td>No known issues, game is completable</td>
-</tr>
-<tr valign="top">
-<td>Note:</td>
-<td>Kanji version requires the FM-TOWNS Font ROM</td>
-</tr>
-<tr valign="top">
-<td>Required files:</td>
-<td>
-<p>FM-TOWNS, Mac and PC:</p>
-<ul compact="compact">
-<li><span>MONKEY2.000</span></li>
-<li><span>MONKEY2.001</span></li>
-</ul>
-<p>Amiga:</p>
-<ul compact="compact">
-<li><span>amiga*.ims</span></li>
-<li><span>monkey2.000</span></li>
-<li><span>monkey2.001</span></li>
-<li><span>monkey2.002</span></li>
-<li><span>monkey2.003</span></li>
-<li><span>monkey2.004</span></li>
-<li><span>monkey2.005</span></li>
-<li><span>monkey2.006</span></li>
-<li><span>monkey2.007</span></li>
-<li><span>monkey2.008</span></li>
-<li><span>monkey2.009</span></li>
-<li><span>monkey2.010</span></li>
-<li><span>monkey2.011</span></li>
-</ul>
-</td>
-</tr>
-</tbody>
-</table>
-</div>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN611" id="AEN611">A.2. Humongous
-Games</a></h2>
-<p>TODO</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN614" id="AEN614">A.3. Adventure
-Soft Games</a></h2>
-<p>TODO: Simon 1, Simon 2 (and their many variants)</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN617" id="AEN617">A.4. Revolution
-Games</a></h2>
-<p>TODO: BASS, BS1, BS2</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN620" id="AEN620">A.5. Interactive
-Binary Illusions Games</a></h2>
-<p>TODO: FOTAQ</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN623" id="AEN623">A.6. Other
-Games</a></h2>
-<p>TODO: Tell people here regarding support for additional games
-(FAQ); maybe point at FreeSCI, Dosbox, others</p>
-</div>
-</div>
-<div class="appendix">
-<hr>
-<h1><a name="AEN626" id="AEN626"></a>Appendix B. Tools</h1>
-<p>TODO: Explain compress_sword2, compress_simon,
-compress_scumm_sou, compress_san, etc. ; rescumm shouldn't have to
-be explained anymore; not sure if descumm should be explained here,
-it seems more fit for the dev guide, but that's probably
-debatable...</p>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN629" id="AEN629">B.1.
-compress_san</a></h2>
-<p>TODO</p>
-<p><b class="command">compress_san</b> <tt class=
-"replaceable"><i>inputfile</i></tt> <tt class=
-"replaceable"><i>inputdir</i></tt> <tt class=
-"replaceable"><i>outputdir</i></tt></p>
-<p>Compresses '.san' smush animation files. It uses lossless zlib
-for compressing FOBJ gfx chunks inside a san file. It also can
-create ogg separate file with smush audio track (only COMI
-currently supported).</p>
-<div class="example"><a name="AEN641" id="AEN641"></a>
-<p><b>Example B-1. Using compress_san</b></p>
-<pre class="screen">
-compress_san opening.san uncomp comp
-</pre></div>
-<p>In order to use such compressed files, your ScummVM binary must
-have been built with zlib support enabled (you can find out whether
-that's the case by looking at the About dialog). For the Ogg
-compression feature, your ScummVM binary naturally must have been
-built with Ogg support enabled.</p>
-</div>
-<div class="section">
-<hr>
-<h2 class="section"><a name="AEN645" id="AEN645">B.2.
-compress_scumm_sou</a></h2>
-<p>TODO</p>
-<p>Used to compress .sou files to .so3 (MP3), .sog (Vorbis), or
-.sof (FLAC).</p>
-<pre class="screen">
-
Usage: ./compress_scumm_sou [params] monster.sou
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ScummVM User Manual</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="id822346"></a>ScummVM User Manual</h1></div><div><h3 class="corpauthor">
+      The ScummVM Team
+    </h3></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#id898804">1. Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="#id898814">What is ScummVM</a></span></dt><dt><span class="section"><a href="#id898868">Reporting bugs</a></span></dt><dt><span class="section"><a href="#id898980">Contacting the developers</a></span></dt></dl></dd><dt><span class="chapter"><a href="#id899013">2. Getting started</a></span></dt><dd><dl><dt><span class="section"><a href="#id899019">Requirements</a></span></dt><dt><span class="section"><a href="#id899135">How to get ScummVM</a></span></dt><dd><dl><dt><span class="section"><a href="#id899149">Binaries</a></span></dt><dt><span class="section"><a href="#sec.compiling">Compiling from source</a></span></dt></dl></dd><dt><span class="section"><a href="#id899269">Installation</a></span></dt><dd><dl><dt><span class="section"><a href="#id899283">Debian</a></span></dt><dt><span class="section"><a href="#id899294">Fedora Core / Redhat</a></span></dt><dt><span class="section"><a href="#id899305">Slackware</a></span></dt><dt><span class="section"><a href="#id899316">Mandrake</a></span></dt><dt><span class="section"><a href="#id899326">Windows</a></span></dt><dt><span class="section"><a href="#id899337">Mac OS X</a></span></dt><dt><span class="section"><a href="#id899348">Windows Mobile (WinCE / PocketPC / Smartphone)</a></span></dt><dt><span class="section"><a href="#id899360">PalmOS</a></span></dt><dt><span class="section"><a href="#id899370">Dreamcast</a></span></dt></dl></dd><dt><span class="section"><a href="#id899382">First steps</a></span></dt><dd><dl><dt><span class="section"><a href="#id899467">Unix-like, Windows, Mac OS X</a></span></dt><dt><span class="section"><a href="#id899477">WinCE / PocketPC</a></span></dt><dt><span class="section"><a href="#id899488">Dreamcast</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id899500">3. Running and using ScummVM</a></span></dt><dd><dl><dt><span class="section"><a href="#id899506">The launcher</a></span></dt><dd><dl><dt><span class="section"><a href="#id899519">Adding/removing a game</a></span></dt><dt><span class="section"><a href="#id899703">Configuring a game</a></span></dt><dt><span class="section"><a href="#id899716">The (global) options dialog</a></span></dt></dl></dd><dt><span class="section"><a href="#id899845">Command line options</a></span></dt><dt><span class="section"><a href="#id900489">Hot Keys</a></span></dt><dt><span class="section"><a href="#id900500">Saving and loading</a></span></dt><dt><span class="section"><a href="#id900513">Using Macintosh games</a></span></dt><dt><span class="section"><a href="#id900525">Multi-CD Games</a></span></dt><dd><dl><dt><span class="section"><a href="#id900558">The Curse of Monkey Island</a></span></dt><dt><span class="section"><a href="#id900579">Broken Sword 1</a></span></dt><dt><span class="section"><a href="#id900609">Broken Sword 2</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#id900632">4. Configuration</a></span></dt><dd><dl><dt><span class="section"><a href="#id900638">Using the launcher</a></span></dt><dt><span class="section"><a href="#id900648">All config file switches in detail</a></span></dt><dt><span class="section"><a href="#id900659">Graphics Filters</a></span></dt><dt><span class="section"><a href="#id900847">Music and Sound</a></span></dt><dd><dl><dt><span class="section"><a href="#id900856">Music drivers</a></span></dt><dt><span class="section"><a href="#id900869">Using compressed audiofiles</a></span></dt><dt><span class="section"><a href="#id900879">Volume settings</a></span></dt><dt><span class="section"><a href="#id900892">Output sample rate</a></span></dt></dl></dd></dl></dd><dt><span class="appendix"><a href="#sec.supported-games">A. Supported Games</a></span></dt><dd><dl><dt><span class="section"><a href="#id900964">LucasArts Games</a></span></dt><dt><span class="section"><a href="#id901174">Humongous Games</a></span></dt><dt><span class="section"><a href="#id901184">Adventure Soft Games</a></span></dt><dt><span class="section"><a href="#id901195">Revolution Games</a></span></dt><dt><span class="section"><a href="#id901206">Interactive Binary Illusions Games</a></span></dt><dt><span class="section"><a href="#id901216">Other Games</a></span></dt></dl></dd><dt><span class="appendix"><a href="#id901229">B. Tools</a></span></dt><dd><dl><dt><span class="section"><a href="#id901243">compress_san</a></span></dt><dt><span class="section"><a href="#id901313">compress_scumm_sou</a></span></dt><dt><span class="section"><a href="#id901333">queenrebuild</a></span></dt><dt><span class="section"><a href="#id901360">compress_simon</a></span></dt><dt><span class="section"><a href="#id901379">compress_sword1</a></span></dt><dt><span class="section"><a href="#id901399">compress_sword2</a></span></dt></dl></dd><dt><span class="appendix"><a href="#id901458">C. Credits</a></span></dt><dt><span class="glossary"><a href="#id906306">Glossary</a></span></dt></dl></div><div class="list-of-examples"><p><b>List of Examples</b></p><dl><dt>3.1. <a href="#id900436">Running Monkey Island, fullscreen, from a hard disk (Win32)</a></dt><dt>3.2. <a href="#id900449">Running Full Throttle from CD, fullscreen and with subtitles enabled (Win32)</a></dt><dt>3.3. <a href="#id900462">Running Monkey Island, fullscreen, from a hard disk (Unix)</a></dt><dt>3.4. <a href="#id900475">Running Full Throttle from CD, fullscreen and with subtitles enabled (Unix)</a></dt><dt>B.1. <a href="#id901297">Using compress_san</a></dt></dl></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id898804"></a>Chapter\xA01.\xA0Introduction</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id898814">What is ScummVM</a></span></dt><dt><span class="section"><a href="#id898868">Reporting bugs</a></span></dt><dt><span class="section"><a href="#id898980">Contacting the developers</a></span></dt></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id898814"></a>What is ScummVM</h2></div></div></div><p>
+ScummVM is a collection of interpreters, capable of emulating several
+adventure game engines. ScummVM mainly supports games created using 
+SCUMM (Script Creation Utility for Maniac Mansion), used in various
+LucasArts games such as Monkey Island, Day of the Tentacle, and others.
+      </p><p>
+ScummVM also contains interpreters for several non-SCUMM games. Currently
+these are Beneath a Steel Sky, Broken Sword 1 & 2, Flight of the Amazon Queen
+and Simon the Sorcerer 1 & 2.
+      </p><p>
+At this time ScummVM should be considered beta software, and is still
+under heavy development. Be aware that whilst we attempt to make sure
+that many games can be completed with few major bugs, crashes can happen. 
+      </p><p>
+If you enjoy ScummVM feel free to donate using the PayPal button on the
+<a href="http://www.scummvm.org" target="_top">ScummVM homepage</a>. This will
+help us buy utilities needed to develop ScummVM easier and quicker. If
+you cannot donate, help and contribute a patch!
+      </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id898868"></a>Reporting bugs</h2></div></div></div><p>
+To report a bug, please create a <a href="http://sourceforge.net" target="_top">SourceForge account</a>
+and follow the bugs link from our homepage. Please make sure the bug is reproducible, and
+still occurs in the latest daily build/current CVS version. Also check
+the known bugs list (below) and compatibility listing for that game, to
+ensure the issue is not already known.
+      </p><p>
+Also, please do not report bugs on games that are not listed as being completable in
+<a href="#sec.supported-games" title="Appendix\xA0A.\xA0Supported Games">Appendix\xA0A, <i>Supported Games</i></a> (<a href="#sec.supported-games">Supported Games</a>),
+or in the online <a href="http://www.scummvm.org/compatibility.php" target="_top">compatibility list</a>.
+We already <span class="emphasis"><em>know</em></span> those games have bugs.
+      </p><p>
+Please include the following information:
+      </p><div class="itemizedlist"><ul type="disc"><li>ScummVM version (PLEASE test the latest CVS/Daily build)</li><li>Bug details, including instructions on reproducing</li><li>Language of game (English, German, ...)</li><li>Version of game (talkie, floppy, ...)</li><li>Platform and Compiler (Win32, Linux, FreeBSD, ...)</li><li>Attach a save game if possible</li><li>If this bug only occurred recently, please note the last
+          version without the bug, and the first version including
+          the bug. That way we can fix it quicker by looking at the
+          changes made.</li></ul></div><p>
+This should only take you a little time but will make it much easier for 
+us to process your bug report in a way that satisfies both you and us. 
+      </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id898980"></a>Contacting the developers</h2></div></div></div><p>
+The easiest way to contact the ScummVM team is by submitting bug reports or
+commenting in our forums. You can also join and e-mail the scummvm-devel
+mailing list (see <a href="http://lists.sourceforge.net/lists/listinfo/scummvm-devel" target="_top">http://lists.sourceforge.net/lists/listinfo/scummvm-devel</a>).
+Or chat with us on IRC: channel #scummvm on irc.freenode.net.
+      </p><p>
+Please do not ask us to support an unsupported game.
+We do <span class="emphasis"><em>not</em></span> generally add support for non-SCUMM games! 
+Reverse engineering a completely new game without source is a long process, and our
+developers are all very busy as it is... so unless you work for a company interested
+in providing us with source code for one of your classic titles, please do not ask.
+      </p></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id899013"></a>Chapter\xA02.\xA0Getting started</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="#id899019">Requirements</a></span></dt><dt><span class="section"><a href="#id899135">How to get ScummVM</a></span></dt><dd><dl><dt><span class="section"><a href="#id899149">Binaries</a></span></dt><dt><span class="section"><a href="#sec.compiling">Compiling from source</a></span></dt></dl></dd><dt><span class="section"><a href="#id899269">Installation</a></span></dt><dd><dl><dt><span class="section"><a href="#id899283">Debian</a></span></dt><dt><span class="section"><a href="#id899294">Fedora Core / Redhat</a></span></dt><dt><span class="section"><a href="#id899305">Slackware</a></span></dt><dt><span class="section"><a href="#id899316">Mandrake</a></span></dt><dt><span class="section"><a href="#id899326">Windows</a></span></dt><dt><span class="section"><a href="#id899337">Mac OS X</a></span></dt><dt><span class="section"><a href="#id899348">Windows Mobile (WinCE / PocketPC / Smartphone)</a></span></dt><dt><span class="section"><a href="#id899360">PalmOS</a></span></dt><dt><span class="section"><a href="#id899370">Dreamcast</a></span></dt></dl></dd><dt><span class="section"><a href="#id899382">First steps</a></span></dt><dd><dl><dt><span class="section"><a href="#id899467">Unix-like, Windows, Mac OS X</a></span></dt><dt><span class="section"><a href="#id899477">WinCE / PocketPC</a></span></dt><dt><span class="section"><a href="#id899488">Dreamcast</a></span></dt></dl></dd></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id899019"></a>Requirements</h2></div></div></div><p>
+      TODO: List Requirements
+      (in terms of required/optional libraries, CPU power, memory, ...
+      In particular it would be nice if we could e.g. say what PalmOS devices support ScummVM;
+      not necessarily a list of all supported Palm models, but more a list of what OS you need
+      how much memory, colors, etc.)</p><p>ScummVM is known to run on the following systems:
+      </p><div class="itemizedlist"><ul type="disc"><li>Unix-like (Linux, *BSD, Solaris, etc.)</li><li>Windows</li><li>Mac OS X</li><li>Windows Mobile (WinCE / PocketPC / Smartphone)</li><li>PalmOS</li><li>Dreamcast</li></ul></div><p>
+      Besides these, there have been many more inofficial ports in the past.
+      Since they were not done by us, we can not say anything about their reliability,
+      legality, or availability, nor can we provide support for them. Use them at your own risk!
+      </p><p>
+      Among those officially unsupported systems are:
+      </p><div class="itemizedlist"><ul type="disc"><li>MorphOS</li><li>GP32</li><li>Symbian based smartphones</li><li>XBox</li><li>PlayStation 2</li><li>RISC OS</li></ul></div><p>
+      If you plan to compile ScummVM yourself, you will need certain additional libraries.
+      More on that in the section <a href="#sec.compiling" title="Compiling from source">the section called “Compiling from source”</a> (<a href="#sec.compiling">Compiling from source</a>).
+      </p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id899135"></a>How to get ScummVM</h2></div></div></div><p>
+      Basically you have two choices on how to get ScummVM: either you download
+      one of the binaries we built for you (probably the most convenient way);
+      or you can compiler it yourself from source. We strongly recommend to
+      beginners to use our prebuilt binaries.
+      </p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id899149"></a>Binaries</h3></div></div></div><p>
+        You can download ScummVM from our downloads page: <a href="http://www.scummvm.org/downloads.php" target="_top">http://www.scummvm.org/downloads.php</a>.
+        Go there with your favorite web browser and download the binary for your platform. If none
+        is available, you may have to build ScummVM yourself, refer to the next section for
+        instructions on how to do that.
+        </p><p>
+        We always ship prebuilt binaries of ScummVM for the following platforms (note that
+        it can sometimes take a few days after a release for all binaries to be available):
+        </p><div class="itemizedlist"><ul type="disc"><li>Linux (Fedora Core)</li><li>Linux (Debian)</li><li>Windows</li><li>Mac OS X</li><li>Windows Mobile (WinCE / PocketPC / Smartphone)</li><li>PalmOS</li><li>Dreamcast</li></ul></div><p>
+        In addition to these, we try to provide more binaries, but which depends mostly on
+        how many volunteers we can find to help us out. In the past we have shipped binaries
+        for these systems:
+        </p><div class="itemizedlist"><ul type="disc"><li>Linux (Mandrake)</li><li>Linux (Slackware)</li><li>Solaris</li><li>BeOS</li><li>MorphOS</li></ul></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="sec.compiling"></a>Compiling from source</h3></div></div></div><p>TODO: 
+          (with more detail than now); pointer to
+          the to-be-written "Developer's Guide to ScummVM"
+          * List all required libs; where to get them; how to install them
+          * List all optional libs etc.
+          * We could separate this by OS, or by compiler/dev system.
+            I think the current split in the README (section 9.0) isn't
+            too bad.
+        </p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id899269"></a>Installation</h2></div></div></div><p>After you have obtained ScummVM as described in the previous
+      section, you probably will want to install it on your system. The steps
+      required for that differ between the various operating systems. In the
+      following we try to cover all the systems we officially support.

@@ Diff output truncated at 100000 characters. @@

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.




More information about the Scummvm-git-logs mailing list