ShuriZma
/
stella
mirror of https://github.com/stella-emu/stella.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Removed 'cfgdir', and have Distella config files placed with the ROM file they refer to. 

Updated docs for removal of statedir, propsfile, etc.
Added 'basedir' and 'baseinappdir' to the docs.
Updated changelog for above changes.
This commit is contained in:
Stephen Anthony 2019-08-30 23:32:57 -02:30
parent 2215b2dee6
commit 5f660383e5
7 changed files with 90 additions and 167 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Changes.txt
View File

@ -72,7 +72,18 @@
* Added hotkey for sound on/off.
* Paths have been simplified (TODO: doc)
* Paths have been simplified: (TODO - finish this)
- The following file/directory locations are no longer configurable
(statedir, nvramdir, cheatfile, palettefile, propsfile); they are
now all under the base directory
- Removed cfgdir; Distella config files are now placed with their
associated ROMs
- Added 'basedir' commandline argument, which allows to change the
base directory where almost all config-related items are stored;
related to this, discontinued the 'basedir.txt' functionality
- Added 'baseinappdir' commandline argument, which sets the base
directory to the application folder (Windows only for now); this
replaces the functionality of 'basedir.txt'
* Enhanced 'Command' menu to display current state and more commands.

BIN
docs/graphics/launcher_options_files.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 3.5 KiB

167
docs/index.html
View File

@ -566,13 +566,9 @@
<p>If this is your first time starting Stella, you may have to navigate to your ROMs.
The path of the first ROM you play automatically defines the default ROM path. You
can change it later in the <b><a href="#ConfigPaths">Configure Paths</a></b> dialog.
</p>
can change it later in the <b><a href="#ROMInfo">ROM Launcher</a></b> dialog.</p>
<p>At this point, you may want to set the locations for snapshots and other
external paths. This is described in more detail in
<b>Advanced Configuration - <a href="#Snapshots">Snapshot Settings</a></b> and
<b>Advanced Configuration - <a href="#ConfigPaths">Configure Paths</a></b>.
<p>At this point, you may want to set the locations for snapshots. This is described in more detail in <b>Advanced Configuration - <a href="#Snapshots">Snapshot Settings</a></b>.
These settings are optional, and can be left at the defaults if you won't be using
snapshots in the ROM launcher.</p>
@ -2348,36 +2344,6 @@
<td>Set the directory where the ROM launcher will start.</td>
</tr>
<tr>
<td><pre>-statedir &lt;dir&gt;</pre></td>
<td>Set the directory in which to access state files.</td>
</tr>
<tr>
<td><pre>-cheatfile &lt;file&gt;</pre></td>
<td>Set the full pathname of the cheatfile database.</td>
</tr>
<tr>
<td><pre>-palettefile &lt;file&gt;</pre></td>
<td>Set the full pathname of the user-defined palette file.</td>
</tr>
<tr>
<td><pre>-propsfile &lt;file&gt;</pre></td>
<td>Set the full pathname of the ROM properties file.</td>
</tr>
<tr>
<td><pre>-nvramdir &lt;dir&gt;</pre></td>
<td>Set the directory in which to access non-volatile (flash/EEPROM) files.</td>
</tr>
<tr>
<td><pre>-cfgdir &lt;dir&gt;</pre></td>
<td>Set the directory in which to access Distella config files.</td>
</tr>
<tr>
<td><pre>-avoxport &lt;name&gt;</pre></td>
<td>Set the name of the serial port where an AtariVox is connected.</td>
@ -2389,6 +2355,16 @@
can be created, allowing to simulate testing on 'smaller' systems.</td>
</tr>
<tr>
<td><pre>-basedir &lt;dir&gt;</pre></td>
<td>Override the base directory for all config files.</td>
</tr>
<tr>
<td><pre>-baseinappdir</pre></td>
<td>Override the base directory for all config files by attempting to use the application directory. For now this is only supported in Windows.</td>
</tr>
<tr>
<td><pre>-help</pre></td>
<td>Prints a help message describing these options, and then
@ -2867,26 +2843,6 @@
</tr>
</table>
<br>
<a name="ConfigPaths"></a>
<p><b>Configure Paths</b> dialog:</p>
<table border="5" cellpadding="2" frame="box" rules="none">
<tr>
<td><img src="graphics/launcher_options_files.png"></td>
<td>&nbsp;&nbsp;&nbsp;&nbsp;</td>
<td valign="top">
<table border="1" cellpadding="4">
<tr><th>Item</th><th>Brief description</th><th>For more information,<br>see <a href="#CommandLine">CommandLine</a></th></tr>
<tr><td>ROM path</td><td>Specifies location of ROM files<br/>(only enabled in ROM launcher mode)</td><td>-romdir</td></tr>
<tr><td>Cheat file</td><td>Specifies location of cheatfile database</td><td>-cheatfile</td></tr>
<tr><td>Palette file</td><td>Specifies location of user palette</td><td>-palettefile</td></tr>
<tr><td>Properties file </td><td>Specifies location of external stella.pro database</td><td>-propsfile</td></tr>
<tr><td>State path</td><td>Specifies location of state files</td><td>-statedir</td></tr>
<tr><td>NVRAM path</td><td>Specifies location of NVRAM (flash/EEPROM) files</td><td>-nvramdir</td></tr>
</table>
</td>
</tr>
</table>
<br>
<p><b>Developer Settings</b> dialog:</p>
<table border="5" cellpadding="2" frame="box" rules="none">
<tr>
@ -3200,34 +3156,30 @@
This is very useful in the testing stages of creating a new game, since
writing to a real EEPROM many times will eventually wear it out.</p>
<p>The location of the EEPROM files are configurable through the
'<i>-nvramdir</i>' commandline argument and within the application itself
(see <b>Advanced Configuration - <a href="#ConfigPaths">Configure Paths</a></b>).
If the path for these files hasn't been set, the default location will depend on the
version of Stella, as follows:</p>
<p>The location of EEPROM files will depend on the version of Stella, as follows:</p>
<p><table cellpadding="4" border="1">
<tr>
<td><b>Linux/Unix</b></td>
<td><i>~/.stella/nvram/atarivox_eeprom.dat<br>
~/.stella/nvram/savekey_eeprom.dat</i></td>
<td><i>$HOME/.config/stella/nvram/atarivox_eeprom.dat<br>
$HOME/.config/stella/nvram/savekey_eeprom.dat</i></td>
</tr>
<tr>
<td><b>Macintosh</b></td>
<td><i>~/Library/Application Support/Stella/nvram/atarivox_eeprom.dat<br>
~/Library/Application Support/Stella/nvram/savekey_eeprom.dat</i></td>
<td><i>$HOME/Library/Application Support/Stella/nvram/atarivox_eeprom.dat<br>
$HOME/Library/Application Support/Stella/nvram/savekey_eeprom.dat</i></td>
</tr>
<tr>
<td><b>Windows</b></td>
<td><i>%APPDATA%\Stella\nvram\atarivox_eeprom.dat<br>
%APPDATA%\Stella\nvram\savekey_eeprom.dat</i>&nbsp;&nbsp;&nbsp;
<b>OR</b><br>
<i>_BASEDIR_\nvram\atarivox_eeprom.dat<br>
_BASEDIR_\nvram\savekey_eeprom.dat<br></i>
(if a file named 'basedir.txt' exists in the application
directory containing the full pathname for _BASEDIR_)
%APPDATA%\Stella\nvram\savekey_eeprom.dat</i></td>
</td>
</tr>
<tr>
<td><b>If using 'basedir'<br>or 'baseinappdir'</b></td>
<td><i>_BASEDIR_/nvram/atarivox_eeprom.dat<br>
_BASEDIR_/nvram/savekey_eeprom.dat</i></td>
</tr>
</table>
<p>Note that these EEPROM files will be created when necessary, and
@ -3490,7 +3442,7 @@
</table>
<p>The settings file has a special name/location depending on which version of Stella
you use, which is currently not configurable:</p>
you use, which is not configurable:</p>
<p><table cellpadding="4" border="1">
<tr>
@ -3499,16 +3451,15 @@
</tr>
<tr>
<td><b>Macintosh</b></td>
<td>Not applicable; settings are saved in <i>~/Library/Preferences/Stella-emu.plist</i></td>
<td>Not applicable; settings are saved in <i>$HOME/Library/Preferences/Stella-emu.plist</i></td>
</tr>
<tr>
<td><b>Windows</b></td>
<td><i>%APPDATA%\Stella\stella.ini</i>&nbsp;&nbsp;&nbsp;
<b>OR</b><br>
<i>_BASEDIR_\stella.ini</i>&nbsp;&nbsp;&nbsp;
(if a file named 'basedir.txt' exists in the application
directory containing the full pathname for _BASEDIR_)
</td>
<td><i>%APPDATA%\Stella\stella.ini</i></td>
</tr>
<tr>
<td><b>If using 'basedir'<br>or 'baseinappdir'</b></td>
<td><i>_BASEDIR_/stellarc (or stella.ini)</i></td>
</tr>
</table>
</blockquote></br>
@ -3585,11 +3536,7 @@ Ms Pac-Man (Stella extended codes):
108fea1 - infinite lives
</pre>
<p>The name of the cheat database file is configurable through the
'<i>-cheatfile</i>' commandline argument and within the application itself
(see <b>Advanced Configuration - <a href="#ConfigPaths">Configure Paths</a></b>). If the
path for this file hasn't been set, the default filename will depend on the
version of Stella, as follows:</p>
<p>The name of the cheat database file will depend on the version of Stella, as follows:</p>
<p><table cellpadding="4" border="1">
<tr>
@ -3598,16 +3545,15 @@ Ms Pac-Man (Stella extended codes):
</tr>
<tr>
<td><b>Macintosh</b></td>
<td><i>~/Library/Application Support/Stella/stella.cht</i></td>
<td><i>$HOME/Library/Application Support/Stella/stella.cht</i></td>
</tr>
<tr>
<td><b>Windows</b></td>
<td><i>%APPDATA%\Stella\stella.cht</i>&nbsp;&nbsp;&nbsp;
<b>OR</b><br>
<i>_BASEDIR_\stella.cht</i>&nbsp;&nbsp;&nbsp;
(if a file named 'basedir.txt' exists in the application
directory containing the full pathname for _BASEDIR_)
</td>
<td><i>%APPDATA%\Stella\stella.cht</i></td>
</tr>
<tr>
<td><b>If using 'basedir'<br>or 'baseinappdir'</b></td>
<td><i>_BASEDIR_/stella.cht</i></td>
</tr>
</table>
<p>Stella will require a restart for changes to this file to take effect.</p>
@ -3931,11 +3877,7 @@ Ms Pac-Man (Stella extended codes):
</table>
<p>The name of the properties file is configurable through the
'<i>-propsfile</i>' commandline argument and within the application itself
(see <b>Advanced Configuration - <a href="#ConfigPaths">Configure Paths</a></b>). If the
path for this file hasn't been set, the default filename will depend on the
version of Stella, as follows:</p>
<p>The name of the properties file will depend on the version of Stella, as follows:</p>
<p><table cellpadding="4" border="1">
<tr>
@ -3944,17 +3886,15 @@ Ms Pac-Man (Stella extended codes):
</tr>
<tr>
<td><b>Macintosh</b></td>
<td><i>~/Library/Application Support/Stella/stella.pro</i></td>
<td><i>$HOME/Library/Application Support/Stella/stella.pro</i></td>
</tr>
<tr>
<td><b>Windows</b></td>
<td><i>%APPDATA%\Stella\stella.pro</i>&nbsp;&nbsp;&nbsp;
<b>OR</b><br>
<i>_BASEDIR_\stella.pro</i>&nbsp;&nbsp;&nbsp;
(if a file named 'basedir.txt' exists in the application
directory containing the full pathname for _BASEDIR_)
</td>
<td><i>%APPDATA%\Stella\stella.pro</i></td>
</tr>
<tr>
<td><b>If using 'basedir'<br>or 'baseinappdir'</b></td>
<td><i>_BASEDIR_/stella.pro</i></td>
</tr>
</table>
<p>Stella will require a restart for changes to this file to take effect.</p>
@ -3996,11 +3936,7 @@ Ms Pac-Man (Stella extended codes):
need to specify those colours in the palette file.
</ul>
<p>The name of the palette file is configurable through the
'<i>-palettefile</i>' commandline argument and within the application itself
(see <b>Advanced Configuration - <a href="#ConfigPaths">Configure Paths</a></b>). If the
path for this file hasn't been set, the default filename will depend on the
version of Stella, as follows:</p>
<p>The name of the palette file will depend on the version of Stella, as follows:</p>
<p><table cellpadding="4" border="1">
<tr>
@ -4009,16 +3945,15 @@ Ms Pac-Man (Stella extended codes):
</tr>
<tr>
<td><b>Macintosh</b></td>
<td><i>~/Library/Application Support/Stella/stella.pal</i></td>
<td><i>%HOME/Library/Application Support/Stella/stella.pal</i></td>
</tr>
<tr>
<td><b>Windows</b></td>
<td><i>%APPDATA%\Stella\stella.pal</i>&nbsp;&nbsp;&nbsp;
<b>OR</b><br>
<i>_BASEDIR_\stella.pal</i>&nbsp;&nbsp;&nbsp;
(if a file named 'basedir.txt' exists in the application
directory containing the full pathname for _BASEDIR_)
</td>
<td><i>%APPDATA%\Stella\stella.pal</i></td>
</tr>
<tr>
<td><b>If using 'basedir'<br>or 'baseinappdir'</b></td>
<td><i>_BASEDIR_/stella.pal</i></td>
</tr>
</table>
<p>Note that to actually use the external palette, the palette file must

60
src/debugger/CartDebug.cxx
View File

@ -696,7 +696,7 @@ string CartDebug::loadListFile()
if(lst.isFile() && lst.isReadable())
myListFile = lst.getPath();
else
return DebuggerParser::red("list file not found in:\n " + lst.getShortPath());
return DebuggerParser::red("list file \'" + lst.getShortPath() + "\' not found");
}
FilesystemNode node(myListFile);
@ -741,7 +741,7 @@ string CartDebug::loadListFile()
}
myDebugger.rom().invalidate();
return "loaded " + node.getShortPath() + " OK";
return "list file '" + node.getShortPath() + "' loaded OK";
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
@ -756,7 +756,7 @@ string CartDebug::loadSymbolFile()
if(sym.isFile() && sym.isReadable())
mySymbolFile = sym.getPath();
else
return DebuggerParser::red("symbol file not found in:\n " + sym.getShortPath());
return DebuggerParser::red("symbol file \'" + sym.getShortPath() + "\' not found");
}
FilesystemNode node(mySymbolFile);
@ -801,32 +801,22 @@ string CartDebug::loadSymbolFile()
}
myDebugger.rom().invalidate();
return "loaded " + node.getShortPath() + " OK";
return "symbol file '" + node.getShortPath() + "' loaded OK";
}
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
string CartDebug::loadConfigFile()
{
// There are two possible locations for loading config files
// (in order of decreasing relevance):
// 1) ROM dir based on properties entry name
// 2) CFG dir based on properties entry name
// The default naming/location for config files is the ROM dir based on the
// actual ROM filename
if(myCfgFile == "")
{
const string& propsname =
myConsole.properties().get(PropType::Cart_Name) + ".cfg";
FilesystemNode case1(myOSystem.romFile().getParent().getPath() + propsname);
FilesystemNode case2(myOSystem.cfgDir() + propsname);
if(case1.isFile() && case1.isReadable())
myCfgFile = case1.getPath();
else if(case2.isFile() && case2.isReadable())
myCfgFile = case2.getPath();
FilesystemNode cfg(myOSystem.romFile().getPathWithExt("") + ".cfg");
if(cfg.isFile() && cfg.isReadable())
myCfgFile = cfg.getPath();
else
return DebuggerParser::red("config file not found in:\n " +
case1.getShortPath() + "\n " + case2.getShortPath());
return DebuggerParser::red("config file \'" + cfg.getShortPath() + "\' not found");
}
FilesystemNode node(myCfgFile);
@ -910,7 +900,7 @@ string CartDebug::loadConfigFile()
stringstream retVal;
if(myConsole.cartridge().bankCount() > 1)
retVal << DebuggerParser::red("config file for multi-bank ROM not fully supported\n");
retVal << "loaded " << node.getShortPath() << " OK";
retVal << "config file '" << node.getShortPath() << "' loaded OK";
return retVal.str();
}
@ -918,29 +908,25 @@ string CartDebug::loadConfigFile()
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
string CartDebug::saveConfigFile()
{
// While there are two possible locations for loading config files,
// the main 'config' directory is used whenever possible when saving,
// unless the rom-specific file already exists
// The default naming/location for config files is the ROM dir based on the
// actual ROM filename
FilesystemNode node;
FilesystemNode case0(myCfgFile);
if(myCfgFile != "" && case0.isFile() && case0.isWritable())
node = case0;
else
FilesystemNode cfg;
if(myCfgFile == "")
{
const string& propsname =
myConsole.properties().get(PropType::Cart_Name) + ".cfg";
node = FilesystemNode(myOSystem.cfgDir() + propsname);
cfg = FilesystemNode(myOSystem.romFile().getPathWithExt("") + ".cfg");
if(cfg.isFile() && cfg.isWritable())
myCfgFile = cfg.getPath();
else
return DebuggerParser::red("config file \'" + cfg.getShortPath() + "\' not writable");
}
const string& name = myConsole.properties().get(PropType::Cart_Name);
const string& md5 = myConsole.properties().get(PropType::Cart_MD5);
ofstream out(node.getPath());
ofstream out(cfg.getPath());
if(!out.is_open())
return "Unable to save directives to " + node.getShortPath();
return "Unable to save directives to " + cfg.getShortPath();
// Store all bank information
out << "//Stella.pro: \"" << name << "\"" << endl
@ -955,7 +941,7 @@ string CartDebug::saveConfigFile()
stringstream retVal;
if(myConsole.cartridge().bankCount() > 1)
retVal << DebuggerParser::red("config file for multi-bank ROM not fully supported\n");
retVal << "saved " << node.getShortPath() << " OK";
retVal << "config file '" << cfg.getShortPath() << "' saved OK";
return retVal.str();
}

4
src/emucore/OSystem.cxx
View File

@ -276,9 +276,6 @@ void OSystem::setConfigPaths()
buildDirIfRequired(myStateDir, myBaseDir + "state");
buildDirIfRequired(myNVRamDir, myBaseDir + "nvram");
#ifdef DEBUGGER_SUPPORT
buildDirIfRequired(myCfgDir, myBaseDir + "cfg");
#endif
#ifdef PNG_SUPPORT
mySnapshotSaveDir = mySettings->getString("snapsavedir");
@ -303,7 +300,6 @@ void OSystem::setConfigPaths()
dbgPath("base dir ", myBaseDir);
dbgPath("state dir ", myStateDir);
dbgPath("nvram dir ", myNVRamDir);
dbgPath("cfg dir ", myCfgDir);
dbgPath("ssave dir ", mySnapshotSaveDir);
dbgPath("sload dir ", mySnapshotLoadDir);
dbgPath("cheat file", myCheatFile);

8
src/emucore/OSystem.hxx
View File

@ -262,13 +262,6 @@ class OSystem
const string& cheatFile() const { return myCheatFile; }
#endif
#ifdef DEBUGGER_SUPPORT
/**
Return the full/complete directory name for storing Distella cfg files.
*/
const string& cfgDir() const { return myCfgDir; }
#endif
#ifdef PNG_SUPPORT
/**
Return the full/complete directory name for saving and loading
@ -540,7 +533,6 @@ class OSystem
string mySnapshotSaveDir;
string mySnapshotLoadDir;
string myNVRamDir;
string myCfgDir;
string myDefaultSaveDir;
string myDefaultLoadDir;

5
src/emucore/Settings.cxx
View File

@ -495,7 +495,7 @@ void Settings::usage() const
<< " -ctrldelay <delay> Delay before controller input is repeated in UI\n"
<< " -ctrlrate <rate> Rate per second of repeated controller input in UI\n"
<< " -basic_settings <0|1> Display only a basic settings dialog\n"
<< " -romdir <dir> Directory from which to load ROM files\n"
<< " -romdir <dir> Set the directory where the ROM launcher will start\n"
<< " -avoxport <name> The name of the serial port where an AtariVox is\n"
<< " connected\n"
<< " -holdreset Start the emulator with the Game Reset switch\n"
@ -508,6 +508,9 @@ void Settings::usage() const
<< " direction/fire button held down\n"
<< " -maxres <WxH> Used by developers to force the maximum size of\n"
<< " the application window\n"
<< " -basedir <path> Override the base directory for all config files\n"
<< " -baseinappdir Override the base directory for all config files\n"
<< " by attempting to use the application directory\n"
<< " -help Show the text you're now reading\n"
#ifdef DEBUGGER_SUPPORT
<< endl