[Scummvm-cvs-logs] SF.net SVN: scummvm:[33922] scummvm/branches/gsoc2008-rtl

[cpage88 at users.sourceforge.net]

Revision: 33922
          http://scummvm.svn.sourceforge.net/scummvm/?rev=33922&view=rev
Author:   cpage88
Date:     2008-08-16 02:57:30 +0000 (Sat, 16 Aug 2008)

Log Message:
-----------
Added documentation to the README, also added --list-saves to the HELP_STRING in commandline.cpp

Modified Paths:
--------------
    scummvm/branches/gsoc2008-rtl/README
    scummvm/branches/gsoc2008-rtl/base/commandLine.cpp

Modified: scummvm/branches/gsoc2008-rtl/README
===================================================================
--- scummvm/branches/gsoc2008-rtl/README	2008-08-16 02:53:16 UTC (rev 33921)
+++ scummvm/branches/gsoc2008-rtl/README	2008-08-16 02:57:30 UTC (rev 33922)
@@ -39,10 +39,12 @@
  * 5.1 Command Line Options
  * 5.2 Language Options
  * 5.3 Graphics Filters
- * 5.4 Hotkeys
+ * 5.4 Global Menu
+ * 5.5 Hotkeys
 6.0) Savegames
  * 6.1 Autosaves
  * 6.2 Converting savegames
+ * 6.3 Viewing/Loading savegames from the command line
 7.0) Music and Sound
  * 7.1 Adlib emulation
  * 7.2 FluidSynth MIDI emulation
@@ -781,6 +783,7 @@
   -h, --help               Display a brief help text and exit
   -z, --list-games         Display list of supported games and exit
   -t, --list-targets       Display list of configured targets and exit
+  --list-saves=TARGET	   Display a list of savegames for the game (TARGET) specified
 
   -c, --config=CONFIG      Use alternate configuration file
   -p, --path=PATH          Path to where the game is installed
@@ -968,7 +971,37 @@
 will be scaled to 1280x960 and 1920x1440.
 
 
-5.4) Hot Keys:
+5.4) Global Menu:
+---- ------------
+
+The Global Menu is a general menu which is available to all of the game engines by pressing F6.
+From this menu there are the following buttons: Resume, Options, About, Return to Launcher,
+and Quit. Selecting 'Options' will display a dialog where basic audio settings, such as
+volume levels, can be adjusted.  Selecting 'Return to Launcher' will close the current game
+and return the user back to the ScummVM Launcher, where another game may be selected to
+play.
+
+Note: Returning to the Launcher is not supported by all of the engines, and the button will be 
+diabled in the Global Menu if it is not supported.
+
+Engines which currently support Returning to the Launcher are:
+
+	AGI
+	AGOS
+	GOB
+	KYRA
+	LURE
+	PARALLACTION
+	QUEEN
+	SAGA
+	SCUMM
+	SKY
+	SWORD1
+	SWORD2
+	TOUCHE
+	
+
+5.5) Hot Keys:
 ---- ---------
 TODO
 TODO: Rework this section to clearly state which hotkeys are implemented in *all*
@@ -982,7 +1015,8 @@
 other games.
 
     Common:
-        Cmd-q                  - Quit (Mac OS X)
+        F6		       - Displays the Global Menu
+	Cmd-q                  - Quit (Mac OS X)
         Ctrl-q                 - Quit (other unices including Linux)
         Ctrl-z OR Alt-x        - Quit (other platforms)
         Ctrl-m                 - Toggle mouse capture
@@ -1139,15 +1173,15 @@
 6.1) Autosaves:
 ---- ----------
 For some games (namely "Beneath a Steel Sky", "Flight of the Amazon
-Queen" and all SCUMM games), ScummVM will by default automatically
+Queen", all AGI games,  and all SCUMM games), ScummVM will by default automatically
 save the current state every five minutes (adjustable via the
-"autosave_period" config setting). For the SCUMM engine, it will save
-in Slot 0. This savestate can then be loaded again via Ctrl-0, or the
-F5 menu.
+"autosave_period" config setting). For the AGI and SCUMM engines, it will save
+in Slot 0. For the SCUMM engine, this savestate can then be loaded again via Ctrl-0, 
+or the F5 menu.
 
 
 6.2) Converting Savegames:
----- ----------
+---- ---------------------
 Using savegames from original versions, isn't supported by all game engines. Only
 the following games, can use savedgames from their original versions.
 
@@ -1177,6 +1211,54 @@
 Where 'xxx' is exact the saved game slot (ie 001) under ScummVM
 
 
+6.3) Viewing/Loading savegames from the command line:
+---- ------------------------------------------------
+
+--list-saves:
+
+	This switch may be used to display a list of the current savegames 
+	of the specified target game and their corresponding save slots.  
+
+	Usage: --list-saves=[TARGET], where [TARGET] is the target game.
+
+	Engines which currently support --list-saves are:
+
+		AGI
+		AGOS
+		CINE
+		KYRA
+		LURE
+		PARALLACTION
+		QUEEN
+		SAGA
+		SCUMM
+		SKY
+		SWORD1
+		SWORD2
+		TOUCHE
+	
+--save-slot/-x:
+
+	This switch may be used to load a savegame directly from the command line.
+
+	Usage: --save-slot[SLOT] or -x[SLOT], where [SLOT] is the save slot number.
+
+	Engines which currently support --save-slot/-x are:
+
+		AGI
+		CINE
+		KYRA
+		LURE
+		PARALLACTION
+		QUEEN
+		SAGA
+		SCUMM
+		SKY
+		SWORD1
+		SWORD2
+		TOUCHE
+
+
 7.0) Music and Sound:
 ---- ----------------
 

Modified: scummvm/branches/gsoc2008-rtl/base/commandLine.cpp
===================================================================
--- scummvm/branches/gsoc2008-rtl/base/commandLine.cpp	2008-08-16 02:53:16 UTC (rev 33921)
+++ scummvm/branches/gsoc2008-rtl/base/commandLine.cpp	2008-08-16 02:57:30 UTC (rev 33922)
@@ -56,6 +56,7 @@
 	"  -h, --help               Display a brief help text and exit\n"
 	"  -z, --list-games         Display list of supported games and exit\n"
 	"  -t, --list-targets       Display list of configured targets and exit\n"
+	"  --list-saves=TARGET	    Display a list of savegames for the game (TARGET) specified\n"
 	"\n"
 	"  -c, --config=CONFIG      Use alternate configuration file\n"
 	"  -p, --path=PATH          Path to where the game is installed\n"


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