diff --git a/docs/index.html b/docs/index.html index db7957c7c..730e41d44 100644 --- a/docs/index.html +++ b/docs/index.html @@ -61,7 +61,7 @@
@@ -484,7 +484,7 @@
-snapname <int|rom>
-Stella has the ability to rename all your ROMs according to the name - specified in the properties database. This is useful if you've downloaded + specified in the ROM properties database. This is useful if you've downloaded ROMs in DOS 8.3 naming format, and wish the filenames to be more descriptive, or the current filenames are too large to see in the launcher.
@@ -4124,7 +4124,7 @@Stella supports real Atari 2600 joysticks, paddles, driving controllers and trackballs (CX22/CX80 'Trak-Ball', Atari and Amiga mouse) using the - Stelladaptor and + Stelladaptor and 2600-daptor devices.
Stella can use up to two adaptors; any extra ones are ignored. @@ -4425,66 +4425,74 @@ this page for integrated debugger documentation.
-@@ -4512,7 +4520,7 @@Stella will remember when you change a setting either at the command line - or while the emulation is running, and use the settings the next time - you start the emulator. The settings are saved in a text file which can - be edited outside of Stella. This file can contain your default options, - and eliminates the need to specify them on the command line. Any - options specified on the command line will override those in the settings file.
+Stella will remember when you change a setting or game property or save a + new high score. It will use saved data the next time you start the emulator. + The data is stored in a SQLite database which can be edited outside of + Stella (e.g. with + DB Browser for SQLite).
-The syntax for the settings file is very straightforward. Any line starting with - a ';' character is considered a comment and is ignored. Other lines must be of - the form: command = value, where command is the same as that - specified on the command line (without the '-' character), and value - is dependent on the command.
+Settings can be changed either at the command line or while the emulation + is running. The database can contain your default options and eliminates the + need to specify them on the command line. Any options specified on the + command line will override those in the user database.
-For example, the following table illustrates how command line and settings entries - are similar:
+To manually edit the settings, browse the data in the table of the same + name. The table has two columns. The first column contains the setting + command, which is the same as the one specified on the + Command Line (without the '-' character). + The second column holds the value, which is dependent on the command.
+ +For example, the following table illustrates how command line and settings + entries are similar:
-
Command Line -Settings File +Column setting +Column value -video opengl -video = opengl +video +opengl -volume 75 -volume = 75 +volume +75 -center 1 -center = 1 (or center = true) +center +1 (or true) The settings file has a special name/location depending on which version of Stella - you use, which is not configurable:
+The database file is named 'stella.sqlite3' and has a special, + non-configurable location depending on which version of Stella you use:
Linux/Unix -$HOME/.config/stella/stellarc +$HOME/.config/stella/ Macintosh -Not applicable; settings are saved in $HOME/Library/Preferences/Stella-emu.plist +$HOME/Library/Application Support/Stella/ Windows -%APPDATA%\Stella\stella.ini +%APPDATA%\Stella\ If using 'basedir' -
or 'baseinappdir'_BASEDIR_/stellarc (or stella.ini) +_BASEDIR_/
Stella uses game properties to specify the "best" emulator settings for a - game. As of version 2.2 of Stella, a default database of properties are - built-in, but you may modify these through the use of a stella.pro file - or within the corresponding Game Properties dialogs. - This file will contain all properties modified by the user. So this + game. As of version 2.2 of Stella, a default ROM database of properties are + built-in, but you may modify these through the properties table in the + user database or within the corresponding Game Properties dialogs. + This user database will contain all properties modified by the user. So this means that when you upgrade Stella, your personal properties settings are preserved.
Property File
-A property file consists of some number of blocks. Each block in the file - contains the properties for a single game. For example the general format of - a property file is:
+Besides storing the properties in the User Database, + you can create a property file per game using the `Export...` button in the + Game Properties dialog. -
-
- ; Comments - "Cart.MD5" "Value" - "Property" "Value" - "" + This property file consists of the properties for a single game. For example + the general format of a property file is: - ; Comments - "Cart.MD5" "Value" - "Property" "Value" - "" - - . . . - - ; Comments - "Cart.MD5" "Value" - "Property" "Value" - ""- -Every block in the property file must have a unique value for the - Cart.MD5 property.
++ ; Comments + "Cart.MD5" "Value" + "Property#1" "Value" + "Property#2" "Value" + ...+ The Cart.MD5 property must be defined, all other properties are optional.
Properties
-Each block in a property file consists of a set of properties for a single - game. Stella supports the properties described below:
+Stella supports the properties described below:
Emulation Properties
@@ -4839,7 +4835,7 @@ Ms Pac-Man (Stella extended codes):
AmigaMouse Commodore Amiga computer mouse. AtariMouse Atari ST computer mouse. - Trakball Standard Atari 2600 CX22/CX80 'Trak-Ball' controller. + AtariVox ¹ A SpeakJet based unlimited-vocabulary speech/sound synthesizer with 32K EEPROM. AtariVox ¹ A SpeakJet based unlimited-vocabulary speech/sound synthesizer with 32K EEPROM. SaveKey A 32K EEPROM for saving high scores, etc. (the EEPROM portion of an AtariVox). Genesis Sega Genesis controller, which can be used similar to a BoosterGrip, giving an extra button. @@ -4927,7 +4923,7 @@ Ms Pac-Man (Stella extended codes): CompuMate ¹ Spectravideo CompuMate (if either left or right is set, CompuMate is used for both). Joystick Atari's famous black joystick that was originally included with the system. Paddles Standard paddle controllers, only (up to 8) fire buttons supported for QuadTari. - Driving Looks like a paddle, but allows 360° movement. Only one unit per connector, unlike paddles which were sold in pairs. + AtariVox A SpeakJet based unlimited-vocabulary speech/sound synthesizer with 32K EEPROM. AtariVox A SpeakJet based unlimited-vocabulary speech/sound synthesizer with 32K EEPROM. @@ -5020,7 +5016,7 @@ Ms Pac-Man (Stella extended codes): SaveKey A 32K EEPROM for saving high scores, etc. (the EEPROM portion of an AtariVox).
- Defaults: Reset the properties to those built into Stella.
- Export: Export the properties for the currently selected ROM only - to a properties file in the user's default save directory.
+ to a properties file in the user's default storage directory.