[Scummvm-cvs-logs] SF.net SVN: scummvm: [25014] docs/trunk/docbook
fingolfin at users.sourceforge.net
fingolfin at users.sourceforge.net
Sat Jan 6 00:09:19 CET 2007
Revision: 25014
http://scummvm.svn.sourceforge.net/scummvm/?rev=25014&view=rev
Author: fingolfin
Date: 2007-01-05 15:09:18 -0800 (Fri, 05 Jan 2007)
Log Message:
-----------
Removing more generated files from the repository
Removed Paths:
-------------
docs/trunk/docbook/devguide.txt
docs/trunk/docbook/faq.txt
docs/trunk/docbook/manual.html
docs/trunk/docbook/manual.txt
Deleted: docs/trunk/docbook/devguide.txt
===================================================================
--- docs/trunk/docbook/devguide.txt 2007-01-05 23:08:01 UTC (rev 25013)
+++ docs/trunk/docbook/devguide.txt 2007-01-05 23:09:18 UTC (rev 25014)
@@ -1,884 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<HTML
-><HEAD
-><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"
-></A
-><DIV
-CLASS="TITLEPAGE"
-><H1
-CLASS="title"
-><A
-NAME="AEN2"
->Developer's Guide to ScummVM</A
-></H1
-><H3
-CLASS="author"
-><A
-NAME="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"
-></A
-><DIV
-CLASS="TITLEPAGE"
-><H1
-CLASS="title"
->I. The Core: A framework for building portable adventure engines</H1
-><DIV
-CLASS="PARTINTRO"
-><A
-NAME="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"
-></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"
-></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"
-></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"
-></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"
->4.1. Graphics</A
-></H2
-><P
->
TODO
- </P
-></DIV
-><DIV
-CLASS="section"
-><HR><H2
-CLASS="section"
-><A
-NAME="AEN26"
->4.2. Overlays</A
-></H2
-><P
->
TODO
- </P
-></DIV
-><DIV
-CLASS="section"
-><HR><H2
-CLASS="section"
-><A
-NAME="AEN29"
->4.3. Event handling</A
-></H2
-><P
->
TODO
- </P
-></DIV
-></DIV
-><DIV
-CLASS="chapter"
-><HR><H1
-><A
-NAME="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"
-></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"
-></A
->Chapter 7. Timers</H1
-><P
->
TODO
- </P
-></DIV
-><DIV
-CLASS="chapter"
-><HR><H1
-><A
-NAME="AEN41"
-></A
->Chapter 8. Files</H1
-><P
->
TODO: File class; when to use SaveFile; ...
- </P
-></DIV
-><DIV
-CLASS="chapter"
-><HR><H1
-><A
-NAME="AEN44"
-></A
->Chapter 9. Config Manager</H1
-><P
->
TODO
- </P
-></DIV
-><DIV
-CLASS="chapter"
-><HR><H1
-><A
-NAME="AEN47"
-></A
->Chapter 10. Game detector</H1
-><P
->
TODO
- </P
-></DIV
-><DIV
-CLASS="chapter"
-><HR><H1
-><A
-NAME="AEN50"
-></A
->Chapter 11. Plugin system</H1
-><P
->
TODO
- </P
-></DIV
-><DIV
-CLASS="chapter"
-><HR><H1
-><A
-NAME="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"
-></A
-><DIV
-CLASS="TITLEPAGE"
-><H1
-CLASS="title"
->II. The Engines</H1
-><DIV
-CLASS="PARTINTRO"
-><A
-NAME="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"
-></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"
-></A
->Chapter 14. SCUMM</H1
-><DIV
-CLASS="section"
-><H2
-CLASS="section"
-><A
-NAME="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"
->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"
->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"
->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"
->14.5. Scripting</A
-></H2
-><P
->
TODO
- </P
-></DIV
-><DIV
-CLASS="section"
-><HR><H2
-CLASS="section"
-><A
-NAME="AEN80"
->14.6. Actors and Costumes</A
-></H2
-><P
->
TODO
- </P
-></DIV
-><DIV
-CLASS="section"
-><HR><H2
-CLASS="section"
-><A
-NAME="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"
->14.8. Text</A
-></H2
-><P
->
TODO
- </P
-></DIV
-><DIV
-CLASS="section"
-><HR><H2
-CLASS="section"
-><A
-NAME="AEN89"
->14.9. iMuse</A
-></H2
-><P
->
TODO
- </P
-></DIV
-><DIV
-CLASS="section"
-><HR><H2
-CLASS="section"
-><A
-NAME="AEN92"
->14.10. INSANE</A
-></H2
-><P
->
TODO
- </P
-></DIV
-><DIV
-CLASS="section"
-><HR><H2
-CLASS="section"
-><A
-NAME="AEN95"
->14.11. SMUSH</A
-></H2
-><P
->
TODO
- </P
-></DIV
-><DIV
-CLASS="section"
-><HR><H2
-CLASS="section"
-><A
-NAME="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"
-></A
->Chapter 15. Simon the Sorcerer</H1
-><P
->TODO</P
-></DIV
-><DIV
-CLASS="chapter"
-><HR><H1
-><A
-NAME="AEN104"
-></A
->Chapter 16. Beneath a Steel Sky</H1
-><P
->TODO</P
-></DIV
-><DIV
-CLASS="chapter"
-><HR><H1
-><A
-NAME="AEN107"
-></A
->Chapter 17. Broken Sword 1</H1
-><P
->TODO</P
-></DIV
-><DIV
-CLASS="chapter"
-><HR><H1
-><A
-NAME="AEN110"
-></A
->Chapter 18. Broken Sword 2</H1
-><P
->TODO</P
-></DIV
-><DIV
-CLASS="chapter"
-><HR><H1
-><A
-NAME="AEN113"
-></A
->Chapter 19. Flight of the Amazon Queen</H1
-><P
->TODO</P
-></DIV
-><DIV
-CLASS="chapter"
-><HR><H1
-><A
-NAME="AEN116"
-></A
->Chapter 20. Saga</H1
-><P
->TODO
- </P
-></DIV
-></DIV
-></DIV
-></BODY
-></HTML
->
Deleted: docs/trunk/docbook/faq.txt
===================================================================
--- docs/trunk/docbook/faq.txt 2007-01-05 23:08:01 UTC (rev 25013)
+++ docs/trunk/docbook/faq.txt 2007-01-05 23:09:18 UTC (rev 25014)
@@ -1,1674 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<HTML
-><HEAD
-><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"
->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"
-></A
->1. Introduction</H3
-><DIV
-CLASS="qandaentry"
-><DIV
-CLASS="question"
-><P
-><A
-NAME="AEN9"
-></A
-><B
->1.1. </B
->Why is it called ScummVM - what does this name mean?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- <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"
-></A
-><B
->1.2. </B
->What is SCUMM?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><B
->1.3. </B
->Is ScummVM free?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><B
->1.4. </B
->Where do I find ScummVM?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><B
->1.5. </B
->How do I compile the source code for my OS?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><B
->1.6. </B
->On what platform does ScummVM run?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><B
->1.7. </B
->Can I use ScummVM to make new games?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
->2. Supported games</H3
-><DIV
-CLASS="qandaentry"
-><DIV
-CLASS="question"
-><P
-><A
-NAME="question.supported-games"
-></A
-><B
->2.1. </B
->What games does ScummVM support?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><B
->2.2. </B
->Does ScummVM run any non-SCUMM games?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><B
->2.3. </B
->Will ScummVM support other games?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><B
->2.4. </B
->When will Maniac Mansion Deluxe be supported?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
->3. Running games</H3
-><DIV
-CLASS="qandaentry"
-><DIV
-CLASS="question"
-><P
-><A
-NAME="AEN92"
-></A
-><B
->3.1. </B
->Do I need original CD or Floppy disks?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><B
->3.2. </B
->Does ScummVM work with all versions of games?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- See "<A
-HREF="#question.supported-games"
-><I
-><I
->What games does ScummVM support?</I
-></I
-></A
->".
- </P
-></DIV
-></DIV
-><DIV
-CLASS="qandaentry"
-><DIV
-CLASS="question"
-><P
-><A
-NAME="AEN104"
-></A
-><B
->3.3. </B
->Can I play through xxx (place your favorite SCUMM adventure here) ?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- See "<A
-HREF="#question.supported-games"
-><I
-><I
->What games does ScummVM support?</I
-></I
-></A
->".
- </P
-></DIV
-></DIV
-><DIV
-CLASS="qandaentry"
-><DIV
-CLASS="question"
-><P
-><A
-NAME="AEN110"
-></A
-><B
->3.4. </B
->Can I save/restore the game?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><B
->3.5. </B
->Do savegames from the original games work in ScummVM?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
->4. Graphics and Audio</H3
-><DIV
-CLASS="qandaentry"
-><DIV
-CLASS="question"
-><P
-><A
-NAME="AEN122"
-></A
-><B
->4.1. </B
->Does ScummVM support CD audio?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><B
->4.2. </B
->Does ScummVM support using MP3/Ogg/FLAC files instead of CD audio?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></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
-><B
-> </B
->
- 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"
-></A
-><B
->4.4. </B
->Does ScummVM support filtered graphic modes?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><B
->4.5. </B
->Can I run my game full screen?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
->5. Troubleshooting</H3
-><DIV
-CLASS="qandaentry"
-><DIV
-CLASS="question"
-><P
-><A
-NAME="AEN154"
-></A
-><B
->5.1. </B
->My game won't run.</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- First make sure your game is supported.
- See "<A
-HREF="#question.supported-games"
-><I
-><I
->What games does ScummVM support?</I
-></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
-><I
->Reporting Bugs.</I
-></I
-></A
->"
- to report this as a bug.
- </P
-></DIV
-></DIV
-><DIV
-CLASS="qandaentry"
-><DIV
-CLASS="question"
-><P
-><A
-NAME="AEN162"
-></A
-><B
->5.2. </B
->I installed my game but ScummVM can't find it.</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><B
->5.3. </B
->I don't hear any sound.</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><B
->5.4. </B
->I don't hear any music.</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- See "<A
-HREF="#question.no-sound"
-><I
-><I
->I don't hear any sound.</I
-></I
-></A
->".
- </P
-></DIV
-></DIV
-><DIV
-CLASS="qandaentry"
-><DIV
-CLASS="question"
-><P
-><A
-NAME="AEN180"
-></A
-><B
->5.5. </B
->My game crashes at some point.</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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
-><I
->Reporting Bugs.</I
-></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"
-></A
-><B
->5.6. </B
->ScummVM crashes, but console window disappears too quick to see the error message.</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><B
->5.7. </B
->The game colors are messed up.</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><B
->5.8. </B
->The subtitles in my non English game are messed up.</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><B
->5.9. </B
->How do I make my mac version of a game work?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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
-><I
->The game colors are messed up.</I
-></I
-></A
->" for information on specifying the
- game platform.
- </P
-></DIV
-></DIV
-><DIV
-CLASS="qandaentry"
-><DIV
-CLASS="question"
-><P
-><A
-NAME="question.report-bugs"
-></A
-><B
->5.10. </B
->Reporting Bugs.</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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
-><P
-></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"
-></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
-><B
-> </B
->
- 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"
-></A
-><B
->5.12. </B
->There are no graphics in the Broken Sword I intro.</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><B
->5.13. </B
->I get "WARNING: Unable to open configration file C:\windows\scummvm.ini!"</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><B
->5.14. </B
->I get "Failed to save game state to file: xxx"</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><B
->5.15. </B
->ScummVM starts, but all I get is a transparent window!</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></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"
-></A
-><B
->5.16. </B
->ScummVM runs, but sound is stuttering and/or garbled!</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><B
->5.17. </B
->How do I set an environment variable?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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"
-></A
-><BLOCKQUOTE
-CLASS="BLOCKQUOTE"
-><PRE
-CLASS="programlisting"
->@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"
-></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
-><B
-> </B
->
- 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"
-></A
->6. Features</H3
-><DIV
-CLASS="qandaentry"
-><DIV
-CLASS="question"
-><P
-><A
-NAME="AEN292"
-></A
-><B
->6.1. </B
->Will you add support for zip archives?</P
-></DIV
-><DIV
-CLASS="answer"
-><P
-><B
-> </B
->
- 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/manual.html
===================================================================
--- docs/trunk/docbook/manual.html 2007-01-05 23:08:01 UTC (rev 25013)
+++ docs/trunk/docbook/manual.html 2007-01-05 23:09:18 UTC (rev 25014)
@@ -1,434 +0,0 @@
-<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.
- </p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id899283"></a>Debian</h3></div></div></div><p>TODO: Describe how to install via apt-get etc.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id899294"></a>Fedora Core / Redhat</h3></div></div></div><p>TODO: Describe how to install the RPM</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id899305"></a>Slackware</h3></div></div></div><p>TODO: Describe how to install the slackware package</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id899316"></a>Mandrake</h3></div></div></div><p>TODO</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id899326"></a>Windows</h3></div></div></div><p>TODO: Describe which file to download, how to install it etc.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id899337"></a>Mac OS X</h3></div></div></div><p>TODO: Describe downloading the .dmg, opening it, copying ScummVM to appropriate place.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id899348"></a>Windows Mobile (WinCE / PocketPC / Smartphone)</h3></div></div></div><p>TODO: Describe installation, possibly based on the PocketSCUMM FAQ</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id899360"></a>PalmOS</h3></div></div></div><p>TODO</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id899370"></a>Dreamcast</h3></div></div></div><p>TODO: Might need to explain CD burning techniques here...</p></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id899382"></a>First steps</h2></div></div></div><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="screenshot"><div class="mediaobject" align="center"><img src="img/launcher-empty.png" align="middle"></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id899467"></a>Unix-like, Windows, Mac OS X</h3></div></div></div><p>TODO</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id899477"></a>WinCE / PocketPC</h3></div></div></div><p>TODO</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id899488"></a>Dreamcast</h3></div></div></div><p>TODO</p></div></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id899500"></a>Chapter\xA03.\xA0Running and using ScummVM</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><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></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id899506"></a>The launcher</h2></div></div></div><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" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id899519"></a>Adding/removing a game</h3></div></div></div><p>Adding a new game via the ScummVM launcher should hopefully be quite
- straight forward.</p><div class="orderedlist"><ol type="1"><li>In the launcher, press the "Add..." button at the bottom of the screen.</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="screenshot"><div class="mediaobject" align="center"><img src="img/launcher-browser.png" align="middle"><div class="caption"><p>The file browser (while adding a game to the launcher).</p></div></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="screenshot"><div class="mediaobject" align="center"><img src="img/launcher-edit-game.png" align="middle"><div class="caption"><p>The dialog which allows you to edit the settings of a game target.</p></div></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="screenshot"><div class="mediaobject" align="center"><img src="img/launcher-after-add.png" align="middle"><div class="caption"><p>The launcher, after adding a game.</p></div></div></div></li></ol></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id899703"></a>Configuring a game</h3></div></div></div><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" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id899716"></a>The (global) options dialog</h3></div></div></div><p>TODO: Explain the various settings in this dialog, with screenshots.</p><div class="screenshot"><div class="mediaobject" align="center"><img src="img/launcher-options-graphics.png" align="middle"><div class="caption"><p>The global graphics settings.</p></div></div></div><div class="screenshot"><div class="mediaobject" align="center"><img src="img/launcher-options-audio.png" align="middle"><div class="caption"><p>The global audio settings.</p></div></div></div><div class="screenshot"><div class="mediaobject" align="center"><img src="img/launcher-options-misc.png" align="middle"><div class="caption"><p>More global settings.</p></div></div></div></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id899845"></a>Command line options</h2></div></div></div><div class="cmdsynopsis"><p><code class="command">scummvm</code> [<em class="replaceable"><code>OPTIONS</code></em>...] <em class="replaceable"><code>GAME</code></em> </p></div><div class="variablelist"><dl><dt><span class="term">-v, </span><span class="term">--version</span></dt><dd>Display ScummVM version information and exit.</dd><dt><span class="term">-h, </span><span class="term">--help</span></dt><dd>Display a brief help text and exit.</dd><dt><span class="term">-z, </span><span class="term">--list-games</span></dt><dd>Display list of supported games and exit</dd><dt><span class="term">-t, </span><span class="term">--list-targets</span></dt><dd>Display list of configured targets and exit</dd><dt><span class="term">-c, </span><span class="term">--config=<em class="replaceable"><code>CONFIG</code></em></span></dt><dd>Use alternate configuration file</dd><dt><span class="term">-p, </span><span class="term">--path=<em class="replaceable"><code>PATH</code></em></span></dt><dd>Path to where the game is installed</dd><dt><span class="term">-x, </span><span class="term">--save-slot[<span class="optional">=<em class="replaceable"><code>NUM</code></em></span>]</span></dt><dd>Save game slot to load (default: autosave)</dd><dt><span class="term">-f, </span><span class="term">--fullscreen</span></dt><dd>Force full-screen mode</dd><dt><span class="term">-F, </span><span class="term">--no-fullscreen</span></dt><dd>Force windowed mode</dd><dt><span class="term">-g, </span><span class="term">--gfx-mode=<em class="replaceable"><code>MODE</code></em></span></dt><dd>Select graphics scaler (see also section 5.3)</dd><dt><span class="term">-e, </span><span class="term">--music-driver=<em class="replaceable"><code>MODE</code></em></span></dt><dd>Select music driver (see also section 7.0)</dd><dt><span class="term">-q, </span><span class="term">--language=<em class="replaceable"><code>LANG</code></em></span></dt><dd>Select language (see also section 5.2)</dd><dt><span class="term">-m, </span><span class="term">--music-volume=<em class="replaceable"><code>NUM</code></em></span></dt><dd>Set the music volume, 0-255 (default: 192)</dd><dt><span class="term">-s, </span><span class="term">--sfx-volume=<em class="replaceable"><code>NUM</code></em></span></dt><dd>Set the sfx volume, 0-255 (default: 192)</dd><dt><span class="term">-r, </span><span class="term">--speech-volume=<em class="replaceable"><code>NUM</code></em></span></dt><dd>Set the voice volume, 0-255 (default: 192)</dd><dt><span class="term">-n, </span><span class="term">--subtitles</span></dt><dd>Enable subtitles (use with games that have voice)</dd><dt><span class="term">-b, </span><span class="term">--boot-param=<em class="replaceable"><code>NUM</code></em></span></dt><dd>Pass number to the boot script (boot param)</dd><dt><span class="term">-d, </span><span class="term">--debuglevel=<em class="replaceable"><code>NUM</code></em></span></dt><dd>Set debug verbosity level</dd><dt><span class="term">-u, </span><span class="term">--dump-scripts</span></dt><dd>Enable script dumping if a directory called 'dumps'
- exists in the current directory</dd><dt><span class="term">--cdrom=<em class="replaceable"><code>NUM</code></em></span></dt><dd>CD drive to play CD audio from (default: 0 = first drive)</dd><dt><span class="term">--joystick[<span class="optional">=<em class="replaceable"><code>NUM</code></em></span>]</span></dt><dd>Enable input with joystick (default: 0 = first joystick)</dd><dt><span class="term">--platform=<em class="replaceable"><code>WORD</code></em></span></dt><dd>Specify version of game (allowed values: amiga,
- atari, fmtowns, mac, pc, windows)</dd><dt><span class="term">--savepath=<em class="replaceable"><code>PATH</code></em></span></dt><dd>Path to where savegames are stored</dd><dt><span class="term">--multi-midi</span></dt><dd>Enable combination of Adlib and native MIDI</dd><dt><span class="term">--native-mt32</span></dt><dd>True Roland MT-32 (disable GM emulation)</dd><dt><span class="term">--output-rate=<em class="replaceable"><code>RATE</code></em></span></dt><dd>Select output sample rate in Hz (e.g. 22050)</dd><dt><span class="term">--aspect-ratio</span></dt><dd>Enable aspect ratio correction</dd><dt><span class="term">--alt-intro</span></dt><dd>Use alternative intro for CD versions of Beneath a
- Steel Sky and Flight of the Amazon Queen</dd><dt><span class="term">--copy-protection</span></dt><dd>Enable copy protection in SCUMM games, when
- ScummVM disables it by default.</dd><dt><span class="term">--demo-mode</span></dt><dd>Start demo mode of Maniac Mansion (Classic version)</dd><dt><span class="term">--tempo=<em class="replaceable"><code>NUM</code></em></span></dt><dd>Set music tempo (in percent, 50-200) for SCUMM games
- (default: 100)</dd><dt><span class="term">--talkspeed=<em class="replaceable"><code>NUM</code></em></span></dt><dd>Set talk speed for SCUMM games</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="id900436"></a><p class="title"><b>Example\xA03.1.\xA0Running Monkey Island, fullscreen, from a hard disk (Win32)</b></p><div class="example-contents"><pre class="screen">C:\Games\LucasArts\scummvm.exe -f -pC:\Games\LucasArts\monkey\ monkey</pre></div></div><br class="example-break"><div class="example"><a name="id900449"></a><p class="title"><b>Example\xA03.2.\xA0Running Full Throttle from CD, fullscreen and with subtitles enabled (Win32)</b></p><div class="example-contents"><pre class="screen">C:\Games\LucasArts\scummvm.exe -f -n -pD:\resource\ ft</pre></div></div><br class="example-break"><div class="example"><a name="id900462"></a><p class="title"><b>Example\xA03.3.\xA0Running Monkey Island, fullscreen, from a hard disk (Unix)</b></p><div class="example-contents"><pre class="screen">/path/to/scummvm -f -p/games/LucasArts/monkey/ monkey</pre></div></div><br class="example-break"><div class="example"><a name="id900475"></a><p class="title"><b>Example\xA03.4.\xA0Running Full Throttle from CD, fullscreen and with subtitles enabled (Unix)</b></p><div class="example-contents"><pre class="screen">/path/to/scummvm -f -n -p/cdrom/resource/ ft</pre></div></div><br class="example-break"></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id900489"></a>Hot Keys</h2></div></div></div><p>TODO: This also has to cover platform specific details...</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id900500"></a>Saving and loading</h2></div></div></div><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" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id900513"></a>Using Macintosh games</h2></div></div></div><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" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id900525"></a>Multi-CD Games</h2></div></div></div><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" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id900558"></a>The Curse of Monkey Island</h3></div></div></div><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" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id900579"></a>Broken Sword 1</h3></div></div></div><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" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id900609"></a>Broken Sword 2</h3></div></div></div><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" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id900632"></a>Chapter\xA04.\xA0Configuration</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><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></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id900638"></a>Using the launcher</h2></div></div></div><p>TODO</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id900648"></a>All config file switches in detail</h2></div></div></div><p>TODO</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id900659"></a>Graphics Filters</h2></div></div></div><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><span class="term">normal</span></dt><dd>No filtering, no scaling. Fastest.</dd><dt><span class="term">2x</span></dt><dd>No filtering, factor 2x (default for non 640x480 games).</dd><dt><span class="term">3x</span></dt><dd>No filtering, factor 3x.</dd><dt><span class="term">2xsai</span></dt><dd>2xsai filter, factor 2x.</dd><dt><span class="term">super2xsai</span></dt><dd>Enhanced 2xsai filtering, factor 2x.</dd><dt><span class="term">supereagle</span></dt><dd>Less blurry than 2xsai, but slower. Factor 2x.</dd><dt><span class="term">advmame2x</span></dt><dd>Doesn't rely on blurring like 2xSAI, fast. Factor 2x.</dd><dt><span class="term">advmame3x</span></dt><dd>Doesn't rely on blurring like 2xSAI, fast. Factor 3x.</dd><dt><span class="term">hq2x</span></dt><dd>Very nice high quality filter but slow. Factor 2x.</dd><dt><span class="term">hq3x</span></dt><dd>Very nice high quality filter but slow. Factor 3x.</dd><dt><span class="term">tv2x</span></dt><dd>Interlace filter, tries to emulate a TV. Factor 2x.</dd><dt><span class="term">dotmatrix</span></dt><dd>Dot matrix effect. Factor 2x.</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" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id900847"></a>Music and Sound</h2></div></div></div><p>TODO
- </p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id900856"></a>Music drivers</h3></div></div></div><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" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id900869"></a>Using compressed audiofiles</h3></div></div></div><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" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id900879"></a>Volume settings</h3></div></div></div><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" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id900892"></a>Output sample rate</h3></div></div></div><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" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="sec.supported-games"></a>Appendix\xA0A.\xA0Supported Games</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><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></div><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" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id900964"></a>LucasArts Games</h2></div></div></div><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"><table border="1"><colgroup><col><col></colgroup><thead><tr valign="top"><th colspan="2" align="center" valign="top">Monkey Island 2: LeChuck's revenge</th></tr></thead><tbody><tr valign="top"><td valign="top">Target(s):</td><td valign="top">monkey2</td></tr><tr valign="top"><td valign="top">Supported variants:</td><td valign="top">Amiga, FM-TOWNS, Mac and PC versions supported</td></tr><tr valign="top"><td valign="top">Known issues:</td><td valign="top">No known issues, game is completable</td></tr><tr valign="top"><td valign="top">Note:</td><td valign="top">Kanji version requires the FM-TOWNS Font ROM</td></tr><tr valign="top"><td valign="top">Required files:</td><td valign="top">
- <p>FM-TOWNS, Mac and PC:</p>
- <div class="itemizedlist"><ul type="disc" compact><li>MONKEY2.000</li><li>MONKEY2.001</li></ul></div>
- <p>Amiga:</p>
- <div class="itemizedlist"><ul type="disc" compact><li>amiga*.ims</li><li>monkey2.000</li><li>monkey2.001</li><li>monkey2.002</li><li>monkey2.003</li><li>monkey2.004</li><li>monkey2.005</li><li>monkey2.006</li><li>monkey2.007</li><li>monkey2.008</li><li>monkey2.009</li><li>monkey2.010</li><li>monkey2.011</li></ul></div>
- </td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id901174"></a>Humongous Games</h2></div></div></div><p>TODO</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id901184"></a>Adventure Soft Games</h2></div></div></div><p>TODO: Simon 1, Simon 2 (and their many variants)</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id901195"></a>Revolution Games</h2></div></div></div><p>TODO: BASS, BS1, BS2</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id901206"></a>Interactive Binary Illusions Games</h2></div></div></div><p>TODO: FOTAQ</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id901216"></a>Other Games</h2></div></div></div><p>TODO: Tell people here regarding support for additional games (FAQ); maybe
- point at FreeSCI, Dosbox, others</p></div></div><div class="appendix" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="id901229"></a>Appendix\xA0B.\xA0Tools</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><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></div><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" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id901243"></a>compress_san</h2></div></div></div><p>TODO</p><div class="cmdsynopsis"><p><code class="command">compress_san</code> <em class="replaceable"><code>inputfile</code></em> <em class="replaceable"><code>inputdir</code></em> <em class="replaceable"><code>outputdir</code></em> </p></div><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="id901297"></a><p class="title"><b>Example\xA0B.1.\xA0Using compress_san</b></p><div class="example-contents"><pre class="screen">compress_san opening.san uncomp comp</pre></div></div><br class="example-break"><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" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id901313"></a>compress_scumm_sou</h2></div></div></div><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
-
-Params:
- --mp3 encode to MP3 format (default)
- --vorbis encode to Vorbis format
- --flac encode to Flac format
-(If one of these is specified, it must be the first parameter.)
-
-MP3 mode params:
- -b RATE RATE is the target bitrate(ABR)/minimal bitrate(VBR) (default:24)
- -B RATE RATE is the maximum VBR/ABR bitrate (default:64)
- --vbr LAME uses the VBR mode (default)
- --abr LAME uses the ABR mode
- -V VALUE specifies the value (0 - 9) of VBR quality (0=best) (default:4)
- -q VALUE specifies the MPEG algorithm quality (0-9; 0=best) (default:2)
- --silent the output of LAME is hidden (default:disabled)
-
-Vorbis mode params:
- -b RATE RATE is the nominal bitrate (default:unset)
- -m RATE RATE is the minimum bitrate (default:unset)
- -M RATE RATE is the maximum bitrate (default:unset)
- -q VALUE specifies the value (0 - 10) of VBR quality (10=best) (default:3)
- --silent the output of oggenc is hidden (default:disabled)
-
-Flac mode params:
- [params] optional arguments passed directly to the encoder
- recommended is: --best -b 1152
-
- --help this help message
-
-
-If a parameter is not given the default value is used
-If using VBR mode for MP3 -b and -B must be multiples of 8; the maximum is 160!
-</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id901333"></a>queenrebuild</h2></div></div></div><p>TODO</p><p>Used to rebuild the datafile of Flight of the Amazon Queen,
- to allow optional MP3/Ogg/FLAC compression.</p><pre class="screen">
-Usage: ./queenrebuild [--mp3/--ogg/--flac [args]] queen.1
-
-Params:
- --mp3 [args] encode to MP3 format
- --ogg [args] encode to Ogg Vorbis Format
- --flac [args] encode to Flac Format
- (Optional: [args] are passed on to the encoder)
-
-Example: ./queenrebuild --mp3 -q 5 queen.1
-</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id901360"></a>compress_simon</h2></div></div></div><p>TODO</p><p>Compresses Simon voc/wav files to MP3/Ogg/FLAC.</p><pre class="screen">
-Usage: ./compress_simon [params] [file | mac]
-
-Params:
- --mp3 encode to MP3 format (default)
- --vorbis encode to Vorbis format
- --flac encode to Flac format
-(If one of these is specified, it must be the first parameter.)
-
-MP3 mode params:
- -b RATE RATE is the target bitrate(ABR)/minimal bitrate(VBR) (default:24)
- -B RATE RATE is the maximum VBR/ABR bitrate (default:64)
- --vbr LAME uses the VBR mode (default)
- --abr LAME uses the ABR mode
- -V VALUE specifies the value (0 - 9) of VBR quality (0=best) (default:4)
- -q VALUE specifies the MPEG algorithm quality (0-9; 0=best) (default:2)
- --silent the output of LAME is hidden (default:disabled)
-
-Vorbis mode params:
- -b RATE RATE is the nominal bitrate (default:unset)
- -m RATE RATE is the minimum bitrate (default:unset)
- -M RATE RATE is the maximum bitrate (default:unset)
- -q VALUE specifies the value (0 - 10) of VBR quality (10=best) (default:3)
- --silent the output of oggenc is hidden (default:disabled)
-
-Flac mode params:
- [params] optional arguments passed directly to the encoder
- recommended is: --best -b 1152
-
- --help this help message
-
-
-If a parameter is not given the default value is used
-If using VBR mode for MP3 -b and -B must be multiples of 8; the maximum is 160!
-Use the `mac' option instead of a filename if converting simon2mac sounds
-</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id901379"></a>compress_sword1</h2></div></div></div><p>TODO</p><p>Used to compress Broken Sword 1's music and speech files
- using mp3 or vorbis.</p><pre class="screen">
-Unable to find speech files.
-Please copy the SPEECH.CLU files from Broken Sword CD1 and CD2
-into the "SPEECH" subdirectory and rename them to
-SPEECH1.CLU and SPEECH2.CLU
-
-If your OS is case-sensitive, make sure the filenames
-and directorynames are all upper-case.
-
-Unable to find music files.
-Please copy the music files from Broken Sword CD1 and CD2
-into the "MUSIC" subdirectory.
-If your OS is case-sensitive, make sure the filenames
-and directorynames are all upper-case.
-
-Use --help for more information
-</pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id901399"></a>compress_sword2</h2></div></div></div><p>TODO</p><p>Used to compress Broken Sword 2's music and speech .clu
- files to .cl3 (MP3), .clg (Vorbis) or .clf (FLAC).
- </p><p>
- Please note that FLAC-compression will produce a larger file
- than the original! This is because the original files already
- use lossy compression.
- </p><pre class="screen">
-Usage: ./compress_sword2 [params] file.clu
-
-Params:
- --mp3 encode to MP3 format (default)
- --vorbis encode to Vorbis format
- --flac encode to Flac format
-(If one of these is specified, it must be the first parameter.)
-
-MP3 mode params:
- -b RATE RATE is the target bitrate(ABR)/minimal bitrate(VBR) (default:24)
- -B RATE RATE is the maximum VBR/ABR bitrate (default:64)
- --vbr LAME uses the VBR mode (default)
- --abr LAME uses the ABR mode
- -V VALUE specifies the value (0 - 9) of VBR quality (0=best) (default:4)
- -q VALUE specifies the MPEG algorithm quality (0-9; 0=best) (default:2)
- --silent the output of LAME is hidden (default:disabled)
-
-Vorbis mode params:
- -b RATE RATE is the nominal bitrate (default:unset)
- -m RATE RATE is the minimum bitrate (default:unset)
- -M RATE RATE is the maximum bitrate (default:unset)
- -q VALUE specifies the value (0 - 10) of VBR quality (10=best) (default:3)
- --silent the output of oggenc is hidden (default:disabled)
-
-Flac mode params:
@@ 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