18
edits
Difference between revisions of "User Manual"
Jump to navigation
Jump to search
Added "How to obtain", "Binaries" and the Compiling TODO from Manual.xml. Fixed left over xml section links
(adding some information on Dreamcast CD burning) |
(Added "How to obtain", "Binaries" and the Compiling TODO from Manual.xml. Fixed left over xml section links) |
||
| Line 42: | Line 42: | ||
for that game, to ensure the issue is not already known. | for that game, to ensure the issue is not already known. | ||
Also, please do not report bugs on games that are not listed as being completable in | Also, please do not report bugs on games that are not listed as being completable in [[#Appendix: Supported games | Appendix: Supported games]] | ||
, or in the online [http://www.scummvm.org/compatibility.php compatibility list]. | |||
or in the online [http://www.scummvm.org/compatibility.php compatibility list]. | |||
We already <emphasis>know</emphasis> those games have bugs. | We already <emphasis>know</emphasis> those games have bugs. | ||
| Line 99: | Line 98: | ||
*RISC OS | *RISC OS | ||
If you plan to compile ScummVM yourself, you will need certain additional libraries. More on that in | If you plan to compile ScummVM yourself, you will need certain additional libraries. More on that in [[#Compiling from sources | Compiling from sources]]. | ||
=== How to obtain ScummVM === | === How to obtain ScummVM === | ||
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. | |||
==== Binaries ==== | ==== Binaries ==== | ||
You can download ScummVM from our downloads page: [http://www.scummvm.org/downloads.php]. 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. | |||
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): | |||
*Linux (Fedora Core) | |||
*Linux (Debian) | |||
*Windows | |||
*Mac OS X | |||
*Windows Mobile (WinCE / PocketPC / Smartphone) | |||
*Symbian | |||
*Dreamcast | |||
*PlayStation 2 | |||
*PlayStation Portable | |||
*Nintendo DS | |||
*GP2X | |||
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: | |||
*Linux (Mandrake) | |||
*Linux (Slackware) | |||
*Solaris | |||
*BeOS | |||
*AmigaOS 4 | |||
*MorphOS | |||
*OS/2 | |||
==== Compiling from sources ==== | ==== Compiling from sources ==== | ||
=== | 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. | |||
=== Installion === | |||
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. | 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. | ||
==== Debian ==== | ==== Debian ==== | ||
| Line 120: | Line 148: | ||
==== Dreamcast ==== | ==== Dreamcast ==== | ||
From the downloads page, download either the Dreamcast .zip file or the Nero image file. If you download the .zip file, you will need a program such as WinZip to open it. After opening the archive, copy it to the folder where you want to put it. The Nero image can be burned automatically to a CD using Nero Burning ROM or any other program that accepts NRG formatted disc images. | From the downloads page, download either the Dreamcast .zip file or the Nero image file. If you download the .zip file, you will need a program such as WinZip to open it. After opening the archive, copy it to the folder where you want to put it. The Nero image can be burned automatically to a CD using Nero Burning ROM or any other program that accepts NRG formatted disc images. | ||
==== GP2X ==== | ==== GP2X ==== | ||
==== GP32 ==== | ==== GP32 ==== | ||
| Line 145: | Line 172: | ||
==== Volumes settings ==== | ==== Volumes settings ==== | ||
==== Output sample rate ==== | ==== Output sample rate ==== | ||
== Appendix: Supported games (well this already exists on the wiki, so just link to these pages, but also see the extra notes below) | == Appendix: Supported games == | ||
== Appendix: Tools (describe each ScummVM command line tool in detail. Game pages might link to this.) | (well this already exists on the wiki, so just link to these pages, but also see the extra notes below) | ||
== Appendix: Tools == | |||
(describe each ScummVM command line tool in detail. Game pages might link to this.) | |||