Open main menu

Difference between revisions of "User Manual"

8 bytes added ,  17:02, 26 November 2007
m
→‎User's Guide: Give Launcher a capital L throughout, clarify a title
(→‎Running ScummVM from the command line: Make it clear how to run ScummVM if it's not in their path)
m (→‎User's Guide: Give Launcher a capital L throughout, clarify a title)
Line 205: Line 205:


== Running and using ScummVM ==
== Running and using ScummVM ==
=== The launcher ===
=== The Launcher ===
==== Managing your games ====
==== Managing your games ====
===== Adding a game =====
===== Adding a game =====
Line 217: Line 217:
===== Adding multiple games at once =====
===== Adding multiple games at once =====


# {{ManualScreenshot|name=Massadd.png | desc=Confirmation dialog for mass add}} If all of your games are in separate subdirectories of one "games" directory, you can add all of your games at once. Simply hold down the "shift" key, and the "Add Game..." button will switch to being a "Mass Add..." button. If you click on it, the ScummVM launcher will ask you to confirm that you really do want to do this.{{-}}
# {{ManualScreenshot|name=Massadd.png | desc=Confirmation dialog for mass add}} If all of your games are in separate subdirectories of one "games" directory, you can add all of your games at once. Simply hold down the "shift" key, and the "Add Game..." button will switch to being a "Mass Add..." button. If you click on it, the ScummVM Launcher will ask you to confirm that you really do want to do this.{{-}}
# {{ManualScreenshot|name=Massaddbrowse.png | desc=File browser for mass add}} You will then be presented with the same file browser that we used previously to select just one game. This time, however, click "Choose" when you are in the top-level directory which all your game directories are inside.{{-}}
# {{ManualScreenshot|name=Massaddbrowse.png | desc=File browser for mass add}} You will then be presented with the same file browser that we used previously to select just one game. This time, however, click "Choose" when you are in the top-level directory which all your game directories are inside.{{-}}
# {{ManualScreenshot|name=Launcherwithgames.png | desc=Mass add complete}} The mass add will then search for all the games it can find within that directory, and come back and let you know how many it found. You should then see all the games it found inside the launcher window.{{-}}
# {{ManualScreenshot|name=Launcherwithgames.png | desc=Mass add complete}} The mass add will then search for all the games it can find within that directory, and come back and let you know how many it found. You should then see all the games it found inside the Launcher window.{{-}}


===== Removing a game =====
===== Removing a game =====
{{ManualScreenshot|name=Deletegame.png|desc=Dialog to confirm deletion}} To remove a game from the ScummVM Launcher, just select the game you want to remove and click the "Remove Game" button on the right-hand side. ScummVM will ask you whether you are sure you want to remove it, so click yes to remove it. Note that this will not delete the game files from your hard drive: you can easily re-add it again later.{{-}}
{{ManualScreenshot|name=Deletegame.png|desc=Dialog to confirm deletion}} To remove a game from the ScummVM Launcher, just select the game you want to remove and click the "Remove Game" button on the right-hand side. ScummVM will ask you whether you are sure you want to remove it, so click yes to remove it. Note that this will not delete the game files from your hard drive: you can easily re-add it again later.{{-}}


==== Configuring individual games and the launcher ====
==== Configuring the Launcher and configuring individual games ====
There are many options to change the way that ScummVM runs games: for discussion of these options see the [[#Configuration|configuration]] section.
There are many options to change the way that ScummVM runs games: for discussion of these options see the [[#Configuration|configuration]] section.


=== Running ScummVM from the command line ===
=== Running ScummVM from the command line ===
As well as starting your ScummVM games using the graphical launcher, you can also start them from the command line. The simplest way to run a game from the command line is to type, for example:
As well as starting your ScummVM games using the graphical Launcher, you can also start them from the command line. The simplest way to run a game from the command line is to type, for example:
<pre>scummvm samnmax</pre>
<pre>scummvm samnmax</pre>


Line 236: Line 236:
<pre>/home/username/scummvm/scummvm samnmax</pre>
<pre>/home/username/scummvm/scummvm samnmax</pre>


The short game name you see at the end of the command line ("samnmax" in this case) specifies which game is started. It either corresponds to a user-defined target (i.e. one that has been added using the launcher: this is the case in the example above), or to a built-in gameid. A brief list of the latter can be found in the supported games section.
The short game name you see at the end of the command line ("samnmax" in this case) specifies which game is started. It either corresponds to a user-defined target (i.e. one that has been added using the Launcher: this is the case in the example above), or to a built-in gameid. A brief list of the latter can be found in the supported games section.


There are many different ''options'' that can be specified to make ScummVM run the game just the way you want, and these are listed in the table below. The meaning of most long options (that is, those options starting with a
There are many different ''options'' that can be specified to make ScummVM run the game just the way you want, and these are listed in the table below. The meaning of most long options (that is, those options starting with a
Line 474: Line 474:


== Configuration ==
== Configuration ==
=== Using the launcher to change the the options ===
=== Using the Launcher to change the options ===
=== All config file switches in detail ===
=== All config file switches in detail ===
=== Graphic filters ===
=== Graphic filters ===
306

edits