1,079
edits
Difference between revisions of "User Manual"
Jump to navigation
Jump to search
Some tweaks
Spookypeanut (talk | contribs) (More copy & paste from manual.xml: command line & macintosh games) |
(Some tweaks) |
||
| Line 70: | Line 70: | ||
=== Contacting the developers === | === Contacting the developers === | ||
The easiest way to contact the ScummVM team is by submitting bug reports (see reporting-bugs) or by using our | The easiest way to contact the ScummVM team is by submitting bug reports (see reporting-bugs) or by using our | ||
[http://forums.scummvm.org forums] You can also join and email the scummvm-devel mailing list (see | [http://forums.scummvm.org forums]. You can also join and email the scummvm-devel mailing list (see | ||
[http://lists.sourceforge.net/lists/listinfo/scummvm-devel]). Or chat with us on IRC (channel #scummvm on irc.freenode.net). | [http://lists.sourceforge.net/lists/listinfo/scummvm-devel]). Or chat with us on IRC (channel #scummvm on irc.freenode.net). | ||
Please do not ask us to support an unsupported game -- read | Please do not ask us to support an unsupported game -- read | ||
[http://www.scummvm.org/faq.php our FAQ] for an explanation. | [http://www.scummvm.org/faq.php our FAQ] for an explanation. | ||
== Getting started == | == Getting started == | ||
=== Requirements === | === Requirements === | ||
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.) | 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.) | ||
| Line 111: | Line 113: | ||
=== 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. | 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 | You can download official binaries of ScummVM from our [http://www.scummvm.org/downloads.php downloads page]. 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. Alternatively, some third parties are providing unofficial ScummVM binaries for further platforms, but naturally, we can not make any statements about the quality of such unofficial builds - use them at your own risk! | ||
We always ship prebuilt binaries of ScummVM for the following platforms (note that it can | We always ship prebuilt binaries of ScummVM for the following platforms (note that it can some time after a release for all binaries to be available): | ||
*Linux (Fedora Core) | *Linux (Fedora Core) | ||
*Linux (Debian) | *Linux (Debian) | ||
| Line 137: | Line 140: | ||
==== Compiling from sources ==== | ==== Compiling from sources ==== | ||
TODO: | TODO: | ||
* Point to the [[Compiling ScummVM]] page, resp. integrate that here. | |||
* List all required libs; where to get them; how to install them | * List all required libs; where to get them; how to install them | ||
* List all optional libs etc. | * 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. | * 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. | ||
=== Installation === | === Installation === | ||
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 ==== | ||
TODO | |||
==== Fedora Core / Redhat ==== | ==== Fedora Core / Redhat ==== | ||
TODO | |||
==== Slackware ==== | ==== Slackware ==== | ||
TODO | |||
==== Windows ==== | ==== Windows ==== | ||
From the downloads page, download either the Win32 .zip file or the Win32 .exe 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. If you download the .exe installer, you will get options where you want to install it. Choose the location to where you want to install it. Also, the installer places a shortcut in the Start Menu. | From the downloads page, download either the Win32 .zip file or the Win32 .exe 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. If you download the .exe installer, you will get options where you want to install it. Choose the location to where you want to install it. Also, the installer places a shortcut in the Start Menu. | ||
==== Mac OS X ==== | ==== Mac OS X ==== | ||
From the downloads page, download the "Mac OS X Universal Binary" file. You will download a disk image (.dmg). To open it, double click on it and Disk Copy will mount the image. Once it is mounted, copy the files inside to a folder where you wish to store it. | From the downloads page, download the "Mac OS X Universal Binary" file. You will download a disk image (.dmg). To open it, double click on it and Disk Copy will mount the image. Once it is mounted, copy the files inside to a folder where you wish to store it. | ||
==== Windows Mobile (WinCE / PocketPC / Smartphone) ==== | ==== Windows Mobile (WinCE / PocketPC / Smartphone) ==== | ||
Create a folder on your device to put ScummVM into, e.g. "\My Device\SD-MMcard\ScummVM". From the downloads page, download the "Windows CE ARM package" zip file. Extract everything from this file, and place it all in the folder that you created on your device (using ActiveSync or similar: note that if your chosen location is short of space, the only absolutely ''required'' file is "scummvm.exe"). To run ScummVM just tap on "scummvm.exe" in File Explorer: you may wish to copy a shortcut of "scummvm.exe" to your Start Menu to allow for easier access. | Create a folder on your device to put ScummVM into, e.g. "\My Device\SD-MMcard\ScummVM". From the downloads page, download the "Windows CE ARM package" zip file. Extract everything from this file, and place it all in the folder that you created on your device (using ActiveSync or similar: note that if your chosen location is short of space, the only absolutely ''required'' file is "scummvm.exe"). To run ScummVM just tap on "scummvm.exe" in File Explorer: you may wish to copy a shortcut of "scummvm.exe" to your Start Menu to allow for easier access. | ||
==== PalmOS ==== | ==== PalmOS ==== | ||
From the downloads page, download the "PalmOS 5 binary" or the "PalmOS Tapwave Zodiac binary" and unzip the files to your computer. Using your hotsync tool, install the scummvm-frontend.prc and skin.pdb files to your device. Launch ScummVM to create the /PALM/Programs/ScummVM/ folders and subfolders on your memory card. Using a card reader, copy the engines you require to play your games to the /ScummVM/Mods/ folder on your card (scumm.engine for scumm games, queen.engine for FOTAQ, etc.) | From the downloads page, download the "PalmOS 5 binary" or the "PalmOS Tapwave Zodiac binary" and unzip the files to your computer. Using your hotsync tool, install the scummvm-frontend.prc and skin.pdb files to your device. Launch ScummVM to create the /PALM/Programs/ScummVM/ folders and subfolders on your memory card. Using a card reader, copy the engines you require to play your games to the /ScummVM/Mods/ folder on your card (scumm.engine for scumm games, queen.engine for FOTAQ, etc.) | ||
==== Symbian / EPOC ==== | ==== Symbian / EPOC ==== | ||
TODO | |||
==== Nintendo DS ==== | ==== Nintendo DS ==== | ||
TODO | |||
==== 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 ==== | ||
TODO | |||
==== GP32 ==== | ==== GP32 ==== | ||
TODO | |||
==== PlayStation 2 ==== | ==== PlayStation 2 ==== | ||
TODO | |||
==== PlayStation Portable ==== | ==== PlayStation Portable ==== | ||
TODO | |||
=== First steps === | === First steps === | ||
== Running and using ScummVM == | == Running and using ScummVM == | ||
=== The launcher === | === The launcher === | ||
==== Managing your games (adding/removing a game) ==== | ==== Managing your games (adding/removing a game) ==== | ||
TODO | |||
==== Configuring a game ==== | ==== Configuring a game ==== | ||
TODO | |||
==== The (global) options dialog (this will point to the "Configuration" section) ==== | ==== The (global) options dialog (this will point to the "Configuration" section) ==== | ||
TODO | |||
=== Command line options === | === Command line options === | ||
TODO: The following list is outdated, and looks ugly :-/ | |||
<code>scummvm [OPTIONS] ''GAME''</code> | <code>scummvm [OPTIONS] ''GAME''</code> | ||
| Line 230: | Line 266: | ||
=== Hotkeys === | === Hotkeys === | ||
TODO | |||
=== Saving and loading === | === Saving and loading === | ||
TODO | |||
=== Macintosh games: Accesing HFS filesystems === | === Macintosh games: Accesing HFS filesystems === | ||
You will need the "Windows Installer" from the download page. To copy the game data file from the CD to your hard disc, you will need [http://home.earthlink.net/~gamba2/pc2mac.html HFVExplorer]. Make sure you get the "HFV Explorer installer" rather than the zip file. When you choose to download the zip file, make sure you read the readme included with HFVExplorer, to set it up properly. Run the HFVExplorer installer and allow it to use its defaults. | You will need the "Windows Installer" from the download page. To copy the game data file from the CD to your hard disc, you will need [http://home.earthlink.net/~gamba2/pc2mac.html HFVExplorer]. Make sure you get the "HFV Explorer installer" rather than the zip file. When you choose to download the zip file, make sure you read the readme included with HFVExplorer, to set it up properly. Run the HFVExplorer installer and allow it to use its defaults. | ||