Updated manual and txt files, and bumped version for upcoming release.

git-svn-id: svn://svn.code.sf.net/p/stella/code/trunk@1080 8b62c5a3-ac7e-4cc8-8f21-d9a121418aba

stella/Announce.txt

@@ -9,7 +9,7 @@
      SSSS     ttt  eeeee llll llll  aaaaa
 
 ===============================================================================
-                  Release 2.1 for Linux, Mac OSX and Windows
+                  Release 2.2 for Linux, Mac OSX and Windows
 ===============================================================================
 
 The Atari 2600 Video Computer System (VCS), introduced in 1977, was the most 
@@ -21,22 +21,24 @@ of your favorite Atari 2600 games again!  Stella was originally developed for
 Linux by Bradford W. Mott, however, it has been ported to a number of other
 platforms.
 
-This is the 2.1 release of Stella for Linux, Mac OSX and Windows.  Distributions
+This is the 2.2 release of Stella for Linux, Mac OSX and Windows.  Distributions
 for other operating systems will appear as they become available. The
 distributions currently available are:
 
-  * Binary distribution in RPM format for Linux (stella-2.1-1.i586.rpm)
+  * Binary distribution in RPM format for Linux (stella-2.2-1.i586.rpm)
 
-  * Binary distribution for Mac OSX (StellaOSX2.1.dmg.gz)
+  * Binary distribution for Mac OSX (StellaOSX2.2.dmg.gz)
 
-  * Binary installer (exe) for Windows (stella-2.1-win32.exe)
+  * Binary installer (exe) for Windows (stella-2.2-win32.exe)
 
-  * Binary zip for Windows (stella-2.1-win32.zip)
+  * Binary zip for Windows CE (stella-2.2-wince.zip)
 
-  * Source code distribution for Linux, Mac OSX and Windows (stella-2.1-src.tar.gz)
+  * Binary zip for GP2X (stella-2.2-gp2x.zip)
 
   * Source code in SRPM format for Linux RPM-based systems (stella-2.1-1.src.rpm)
 
+  * Source code distribution for all platforms (stella-2.1-src.tar.gz)
+
 PLEASE DO NOT WRITE ASKING FOR ROM IMAGES TO USE WITH STELLA! ALL SUCH
 REQUESTS WILL BE IGNORED!
 

stella/Changes.txt

@@ -12,6 +12,76 @@
                                Release History
 ===============================================================================
 
+2.1 to 2.2: (April 7, 2006)
+
+  * Added new ROM browser option which works like a normal filesystem
+    browser, allowing navigation throughout the filesystem.
+    The old mode of browsing is still present, and can be toggled at
+    runtime.  Related to this, fixed bug whereby sorting in the ROM
+    launcher sometimes didn't work.
+
+  * Integrated stella.pro properties into the application, resulting in
+    faster startup time.  Now Stella can be redistributed as a single
+    binary; no external files are needed, but they will still be used
+    if present.
+
+  * Reworked ROM properties files once again.  The 'user.pro' file has
+    been removed, and all user-defined properties are stored in
+    'stella.pro' instead.  You should delete all properties files when
+    upgrading to this version, to take advantage of the speed increases.
+
+  * Reworked settings files once again.  Removed all references to a
+    global settings file.  Each user now gets a user-specific settings
+    file only.  If that file doesn't exist, the built-in defaults are
+    used.
+
+  * Added 'conditional saving' of the cheatcode and settings files, so
+    that these files are only written to disk when absolutely
+    necessary.  This doesn't really affect desktop systems, but is very
+    useful for systems with flashram-based storage (GP2X, WinCE, etc).
+
+  * Reworked Settings class, hopefully fixing a bug whereby settings
+    weren't being saved in certain cases (most evident in the OSX port).
+
+  * Added 'tiadefaults' commandline option, which can also be toggled
+    from within the GUI.  This option disables all TIA positioning
+    'tweaks' that typically make a game look better, and present the
+    image exactly as it would appear on a real 2600.
+
+  * Added jitter-detection code for the paddle emulation, which should
+    eliminate an annoying 'jittering' effect when using paddles with
+    a Stelladaptor.
+
+  * Related to jitter-detection, added '-pthresh' commandline option
+    and GUI entry, which sets a bound below which the emulation detects
+    jitter.
+
+  * Fixed crash when adding one-shot cheats.
+
+  * Fixed bug in RAM comparitive searches in the debugger.
+
+  * Fixed bug with setting snapshot naming type from the GUI (it was
+    always being set to 'romname').
+
+  * Re-added low compatibility CPU emulation mode, since it benefits
+    some slower systems.  This is activated with the commandline argument
+    '-cpu low'.
+
+  * For the OSX port, added Universal binary support.
+
+  * For the OSX port, reworked the menu handling, so that certain menu
+    options are only enabled when it makes sense to do so.
+
+  * For the GP2X port, fixed joystick deadzone issues and scroll bug in
+    ROM launcher.
+
+  * For the GP2X port, fixed issue with PAL ROMs causing a crash because of
+    screen size.  A message is now shown indicating that PAL ROMs are not
+    yet supported.
+
+Have fun!
+
+
 2.0.1 to 2.1: (January 29, 2006)
 
   * Added phosphor effect, similar to z26.  Useful on ROMs which alternate
@@ -80,8 +150,6 @@
 
   * Implemented dynamic loading of OpenGL library.
 
-Have fun!
-
 
 2.0 to 2.0.1: (October 24, 2005)
 

stella/docs/index.html

@@ -10,7 +10,7 @@
 	<br><br>
 	<center><h2><b>A multi-platform Atari 2600 VCS emulator</b></h2></center>
 
-	<center><h4><b>Release 2.1</b></h4></center>
+	<center><h4><b>Release 2.2</b></h4></center>
 	<br><br>
 
 	<center><h2><b>User's Guide</b></h2></center>
@@ -36,7 +36,7 @@
 
 	<br><br><br>
 
-	<center><b>February 1999 - January 2006</b></center>
+	<center><b>February 1999 - April 2006</b></center>
 	<center><b>The Stella Team</b></center>
 	<center><b><a href="http://stella.sourceforge.net">Stella Homepage</a></b></center>
 
@@ -215,75 +215,73 @@
     Sega Dreamcast, Unix, and Windows.
 	</p>
 
-	<h2><b>New in Release 2.1</b></h2>
+	<h2><b>New in Release 2.2</b></h2>
 
 	<ul>
-		<li>Added <b>phosphor effect</b>, similar to z26.  Useful on ROMs which
+<li>Added new ROM browser option which works like a normal filesystem
-			alternate sprites from one frame to another, resulting in an
+    browser, allowing navigation throughout the filesystem.
-			annoying flicker.  When using phosphor mode, a pixels colour is mixed
+    The old mode of browsing is still present, and can be toggled at
-			with its previous value, resulting in a blended image that doesn't
+    runtime.  Related to this, fixed bug whereby sorting in the ROM
-			flicker, emulating the phosphoresence effect on a real television.</li>
+    launcher sometimes didn't work.</li>
 
-		<li>Added 'pp' developer commandline argument to set the "Display.Phosphor"
+<li>Integrated stella.pro properties into the application, resulting in
-			property, and 'ppblend' to set the amount to blend pixels in
+    faster startup time.  Now Stella can be redistributed as a single
-			phosphor mode.  Also added 'Alt p' key to enable/disable phosphor
+    binary; no external files are needed, but they will still be used
-			effect while ROM is emulated.  By default, phosphor mode is only used
+    if present.</li>
-			when necessary, as specified in the stella.pro file.</li>
 
-		<li>Renamed 'cheetah' commandline argument to 'cheat'.</li>
+<li>Reworked ROM properties files once again.  The 'user.pro' file has
+    been removed, and all user-defined properties are stored in
+    'stella.pro' instead.  You should delete all properties files when
+    upgrading to this version, to take advantage of the speed increases.</li>
 
-		<li>Added per-frame cheatcodes (4 characters long), which are evaluated
+<li>Reworked settings files once again.  Removed all references to a
-			each frame.</li>
+    global settings file.  Each user now gets a user-specific settings
+    file only.  If that file doesn't exist, the built-in defaults are
+    used.</li>
 
-		<li>Added cheatcode GUI, where cheats can be named, edited, saved, etc.</li>
+<li>Added 'conditional saving' of the cheatcode and settings files, so
+    that these files are only written to disk when absolutely
+    necessary.  This doesn't really affect desktop systems, but is very
+    useful for systems with flashram-based storage (GP2X, WinCE, etc).</li>
 
-		<li>Cheat codes are now saved to stella.cht file and are automatically
+<li>Reworked Settings class, hopefully fixing a bug whereby settings
-			reloaded when Stella starts.</li>
+    weren't being saved in certain cases (most evident in the OSX port).</li>
 
-		<li>Improved 'joymouse' functionality.  While in GUI mode, any axis
+<li>Added 'tiadefaults' commandline option, which can also be toggled
-			will simulate mouse movement, and any button will simulate a mouse
+    from within the GUI.  This option disables all TIA positioning
-			click.  So the GUI can be completely navigated without a mouse.</li>
+    'tweaks' that typically make a game look better, and present the
+    image exactly as it would appear on a real 2600.</li>
 
-		<li>Improved CommandDialog and LauncherDialog wrt joymouse functionality.
+<li>Added jitter-detection code for the paddle emulation, which should
-			These dialogs are used more than any other on devices without a mouse,
+    eliminate an annoying 'jittering' effect when using paddles with
-			so joystick axis movement switches between GUI objects, rather than
+    a Stelladaptor.</li>
-			simulating the mouse.  This leads to much faster selection of objects.</li>
 
-		<li>Added mapping of multiple SDL joystick axis to Event Mapping.</li>
+<li>Related to jitter-detection, added '-pthresh' commandline option
+    and GUI entry, which sets a bound below which the emulation detects
+    jitter.</li>
 
-		<li>Added joystick hat support, and mapping of multiple hats to Event
+<li>Fixed crash when adding one-shot cheats.</li>
-			Mapping.</li>
 
-		<li>Added remapping of paddle emulation to the keyboard or joystick axis
+<li>Fixed bug in RAM comparitive searches in the debugger.</li>
-			(the mouse is still used by default for paddles).  Related to this,
-			use more precise analog values when analog axis are mapped to
-			analog-type events (such as paddles).</li>
 
-		<li>Treat joystick events as other types of controllers based on the
+<li>Fixed bug with setting snapshot naming type from the GUI (it was
-			virtual port entry in stella.pro.  This means that mappings for a
+    always being set to 'romname').</li>
-			joystick will emulate other devices when necessary.</li>
 
-		<li>Added 'sp' developer commandline argument, which sets the 
+<li>Re-added low compatibility CPU emulation mode, since it benefits
-			"Console.SwapPorts" property and swaps the arrangement of the
+    some slower systems.  This is activated with the commandline argument
-			virtual ports.  Useful for games like "Raiders of the Lost Ark",
+    '-cpu low'.</li>
-			where the joysticks are normally swapped.</li>
 
-		<li>Added ability to set which Stelladaptor device emulates which virtual
+<li>For the OSX port, added Universal binary support.</li>
-			joystick port ('sa1' and 'sa2' commandline arguments, which accept
-			'left' or 'right').</li>
 
-		<li>Fixed issues with jittering joysticks/mice causing weird events when
+<li>For the OSX port, reworked the menu handling, so that certain menu
-			starting Stella.</li>
+    options are only enabled when it makes sense to do so.</li>
 
-		<li>Added 'freq', 'tiafreq' and 'clipvol' commandline arguments, which
+<li>For the GP2X port, fixed joystick deadzone issues and scroll bug in
-			affect the sound subsystem (see manual for further info).</li>
+    ROM launcher.</li>
 
-		<li>Made state files completely cross-platform, both in terms of endianness
+<li>For the GP2X port, fixed issue with PAL ROMs causing a crash because of
-			as well as CPU size (32 vs. 64 bit).</li>
+    screen size.  A message is now shown indicating that PAL ROMs are not
-
+    yet supported.</li>
-		<li>Fixed crash with using 'cheat' and 'break' from the commandline.</li>
-
-		<li>Implemented dynamic loading of OpenGL library.</li>
 	</ul>
 
 	<p>
@@ -369,7 +367,7 @@
 	the following:</p>
 	<ul>
 		<li>Mac OSX 10.1 or Above</li>
-		<li>500 MHz G4 PPC processor or above (Stella <b>may</b> work with a G3
+		<li>500 MHz G4 PPC/Intel processor or above (Stella <b>may</b> work with a G3
 			processor, but this is still a work-in-progress)</li>
 		<li>OpenGL capable video card.  Software rendering mode is still available,
 			but as of OSX 10.4 is substandard compared to OpenGL.</li>
@@ -749,7 +747,19 @@
 		</tr>
 
 		<tr>
-			<td><pre>-accurate &lt;0|1&gt;</pre></td>
+			<td><pre>-pthresh &lt;number&gt;</pre></td>
+			<td>Set threshold for eliminating paddle jitter.</td>
+		</tr>
+
+		<tr>
+			<td><pre>-tiadefaults &lt;1|0&gt;</pre></td>
+			<td>Use TIA positioning defaults instead of enhanced values.  The
+				default values result in the image appearing as it does on
+				a real 2600 system (in most cases).</td>
+		</tr>
+
+		<tr>
+			<td><pre>-accurate &lt;1|0&gt;</pre></td>
 			<td>Linux only, may be removed in future versions.  Use this when 
 				running under the Linux 2.4 kernel.  Otherwise, this should probably
 				not be used.</td>
@@ -978,10 +988,7 @@
 	<p>
 	<h2><b>Linux/UNIX</b></h2>
 	<p>The Linux and UNIX version of Stella searches for the <i>stellarc</i> file in
-	two places.  First, it will look for <i>stellarc</i> in your $HOME/.stella directory.
+	your $HOME/.stella directory.</p>
-	Then, it will look for <i>stellarc</i> in the system-wide directory, which is
-	determined when Stella was built.  By default, this would be the
-	<i>/usr/share/stella</i> directory.</p>
 
 	<p>
 	<h2><b>Macintosh</b></h2>
@@ -1814,31 +1821,25 @@ Ms Pac-Man (Stella extended codes):
 	<hr>
 
 	<p>Stella uses game properties to specify the "best" emulator settings for a
-	game. As of Version 1.2 of Stella, there are no longer any properties built-in.
+	game. As of version 2.2 of Stella, a default database of properties are
-	You must use the included <b>stella.pro</b> file.  Otherwise, the emulator
+	built-in, but you may modify these through the use of a <b>stella.pro</b> file.
-	will try to guess the best settings for the game.</p>
+	This per-user file will contain all properties 'merged' by the user
-
+	(by pressing Alt-s while a game is running).  So this means that when you
-	<p>As of Stella 2.0, the properties file handling has changed.  Stella now uses
+	upgrade Stella, your personal properties settings are preserved.</p>
-	two properties files; a system-wide <b>stella.pro</b> and a per-user <b>user.pro</b>.
-	The system-wide file will not be modified by Stella, and is used as a default
-	database of properties.  The per-user file will contain all properties 'merged' by
-	the user (by pressing Alt-s while a game is running).  So this means that when
-	you upgrade Stella and stella.pro, your personal profile settings are preserved.</p>
 
 	<p>
 	<h2><b>Linux/Unix</b></h2>
-	<p>The Linux and Unix versions of Stella looks for the system properties file
+	<p>The Linux and Unix versions of Stella looks for your personal properties
-	in <i>/usr/share/stella/stella.pro</i> and your personal properties
+	file in	<i>$HOME/.stella/stella.pro</i>.
-	file in	<i>$HOME/.stella/user.pro</i>.
 
 	<p>
 	<h2><b>Macintosh</b></h2>
-	<p>The Mac version of Stella looks for the properties file(s) in the
+	<p>The Mac version of Stella looks for your personal properties	file in
-	directory containing the application.</p>
+	<i>$HOME/.stella/stella.pro</i>.
 
 	<p>
 	<h2><b>Windows</b></h2>
-	<p>The Windows version of Stella looks for the properties file(s) in the directory
+	<p>The Windows version of Stella looks for the properties file in the directory
 	containing the application.  Future versions of Stella for Windows may look in
 	user-specific locations	(C:\Documents and Settings\...).</p>
 
@@ -1878,15 +1879,6 @@ Ms Pac-Man (Stella extended codes):
 	game.  Stella supports the properties described below:</p>
 
 	<table CELLSPACING="10">
-		<tr>
-			<td VALIGN="TOP"><i>Cartridge.Filename:</i></td>
-			<td>This property indicates the name of the file containing the ROM image.
-			<!--In general this property is not needed, however, if present Stella uses it
-			while attempting to match a game with its block of properties.  If the
-			value of the property matches the filename of the ROM image then Stella
-			uses that block of properties for the game.--></td>
-		</tr>
-
 		<tr>
 			<td VALIGN="TOP"><i>Cartridge.MD5:</i></td>
 			<td>This property indicates the MD5 checksum of the ROM image as a
@@ -1914,16 +1906,18 @@ Ms Pac-Man (Stella extended codes):
 
 		<tr>
 			<td VALIGN="TOP"><i>Cartridge.Name:</i></td>
-			<td>This property indicates the actual name of the game.  It is very
+			<td>This property indicates the actual name of the game.</td>
-			important that this property's value be unique from all other cartridge
-			names in the property file.</td>
 		</tr>
 
 		<tr>
 			<td VALIGN="TOP"><i>Cartridge.Note:</i></td>
-			<td>This property contains any special notes about playing the game.
+			<td>This property contains any special notes about playing the game.</td>
-			Currently this property is not being used, however, future versions of
+		</tr>
-			Stella will probably allow the user to view this information.</td>
+
+		<tr>
+			<td VALIGN="TOP"><i>Cartridge.Rarity:</i></td>
+			<td>This property indicates how rare a cartridge is, based on the scale
+				described on AtariAge.</td>
 		</tr>
 
 		<tr>
@@ -2302,6 +2296,11 @@ Ms Pac-Man (Stella extended codes):
 			<td>Provided technical data sheet for the 6532 RIOT chip</td>
 		</tr>
 
+		<tr>
+			<td VALIGN="TOP">Alex&nbsp;Zaballa</td>
+			<td>Maintainer of the GP2X version of Stella starting with the 2.1 release</td>
+		</tr>
+
 	</table>
 
 	<br><br>

stella/src/common/Version.hxx

@@ -13,13 +13,13 @@
 // See the file "license" for information on usage and redistribution of
 // this file, and for a DISCLAIMER OF ALL WARRANTIES.
 //
-// $Id: Version.hxx,v 1.14 2006-01-31 14:02:07 urchlay Exp $
+// $Id: Version.hxx,v 1.15 2006-04-05 16:06:59 stephena Exp $
 //============================================================================
 
 #ifndef VERSION_HXX
 #define VERSION_HXX
 
-#define STELLA_BASE_VERSION "2.1.1"
+#define STELLA_BASE_VERSION "2.2"
 
 #ifdef NIGHTLY_BUILD
 #define STELLA_VERSION STELLA_BASE_VERSION "pre-" NIGHTLY_BUILD

stella/src/gui/AboutDialog.cxx

@@ -13,7 +13,7 @@
 // See the file "license" for information on usage and redistribution of
 // this file, and for a DISCLAIMER OF ALL WARRANTIES.
 //
-// $Id: AboutDialog.cxx,v 1.11 2006-03-25 00:34:17 stephena Exp $
+// $Id: AboutDialog.cxx,v 1.12 2006-04-05 16:06:59 stephena Exp $
 //
 //   Based on code from ScummVM - Scumm Interpreter
 //   Copyright (C) 2002-2004 The ScummVM project
@@ -104,8 +104,6 @@ void AboutDialog::updateStrings(int page, int lines, string& title, string* &dsc
 
     case 3:
       title = "The Stella team";
-      ADD_ATEXT("\\L\\c0""  Erik \"Voch\" Kovach");
-      ADD_ATEXT("\\L\\c2""    Maintainer of the 'stella.pro' game properties file");
       ADD_ATEXT("\\L\\c0""  Joe D'Andrea");
       ADD_ATEXT("\\L\\c2""    Maintainer for Solaris port");
       ADD_ATEXT("\\L\\c0""  Darrell Spice Jr. & Doodle");
@@ -114,6 +112,8 @@ void AboutDialog::updateStrings(int page, int lines, string& title, string* &dsc
       ADD_ATEXT("\\L\\c2""    Maintainer for PSP port");
       ADD_ATEXT("\\L\\c0""  Kostas Nakos");
       ADD_ATEXT("\\L\\c2""    Author/maintainer for WinCE port");
+      ADD_ATEXT("\\L\\c0""  Alex Zaballa");
+      ADD_ATEXT("\\L\\c2""    Maintainer for GP2X port");
       break;
 
     case 4:
@@ -124,17 +124,17 @@ void AboutDialog::updateStrings(int page, int lines, string& title, string* &dsc
       ADD_ATEXT("\\L\\c0""  Dan Boris, Piero Cavina, Bob Colbert");
       ADD_ATEXT("\\L\\c0""  Renato Ferreira, Ron Fries, Aaron Giles");
       ADD_ATEXT("\\L\\c0""  Mark Hahn, Kevin Horton, Thomas Jentzsch");
-      ADD_ATEXT("\\L\\c0""  Daniel Marks, James Mcclain, David McEwen");
+      ADD_ATEXT("\\L\\c0""  Erik \"Voch\" Kovach, Daniel Marks, James Mcclain");
-      ADD_ATEXT("\\L\\c0""  Jeff Miller, Dan Mowczan, Jack Nutting");
+      ADD_ATEXT("\\L\\c0""  David McEwen, Jeff Miller, Dan Mowczan");
-      ADD_ATEXT("\\L\\c0""  Manuel Polik, Jim Pragit, John Saeger");
+      ADD_ATEXT("\\L\\c0""  Jack Nutting, Manuel Polik, Jim Pragit");
-      ADD_ATEXT("\\L\\c0""  Chris Salomon, Jason Scott, David Shaw");
+      ADD_ATEXT("\\L\\c0""  John Saeger, Chris Salomon, Jason Scott");
       break;
 
     case 5:
       title = "Retired members / Contributors";
       ADD_ATEXT("\\L\\c0""See Stella manual for contribution details");
       ADD_ALINE;
-      ADD_ATEXT("\\L\\c0""  Raul Silva, Chris Snell, John Stiles");
+      ADD_ATEXT("\\L\\c0""  David Shaw, Raul Silva, Chris Snell, John Stiles");
       ADD_ATEXT("\\L\\c0""  Matthew Stroup, Joel Sutton, Greg Troutman");
       ADD_ATEXT("\\L\\c0""  Curt Vendel, Keith Wilkins, Jeff Wisnia");
       ADD_ALINE;