From 9d0e6686c8b056559145b2db5f2ec8b7ac80fa2f Mon Sep 17 00:00:00 2001 From: Dimitris Panokostas Date: Tue, 14 Nov 2023 14:25:32 +0100 Subject: [PATCH] doc: Improved documentation in GUI -> Paths -> Help --- src/osdep/gui/PanelPaths.cpp | 82 +++++++++++++++++++++++++++--------- 1 file changed, 63 insertions(+), 19 deletions(-) diff --git a/src/osdep/gui/PanelPaths.cpp b/src/osdep/gui/PanelPaths.cpp index cad87a07b..a6c0a9641 100644 --- a/src/osdep/gui/PanelPaths.cpp +++ b/src/osdep/gui/PanelPaths.cpp @@ -529,23 +529,67 @@ void RefreshPanelPaths() bool HelpPanelPaths(std::vector& helptext) { - helptext.clear(); - helptext.emplace_back("Specify the location of your Kickstart ROMs and the folders where the configurations"); - helptext.emplace_back("and controller files should be stored. With the \"...\" button you can open a dialog"); - helptext.emplace_back("to choose the folder."); - helptext.emplace_back(" "); - helptext.emplace_back("You can enable/disable logging and specify the location of the logfile with the relevant"); - helptext.emplace_back("options."); - helptext.emplace_back(" "); - helptext.emplace_back("After changing the location of the Kickstart ROMs, click on \"Rescan\" to refresh"); - helptext.emplace_back("the list of the available ROMs."); - helptext.emplace_back(" "); - helptext.emplace_back("You can download the latest version of the WHDLoad Booter XML file, using the"); - helptext.emplace_back("relevant button. You will need an internet connection for this to work."); - helptext.emplace_back(" "); - helptext.emplace_back("You can also download the latest Game Controller DB file, using the relevant button."); - helptext.emplace_back("BEWARE: this will overwrite any changes you may have had in your local file!"); - helptext.emplace_back(" "); - helptext.emplace_back("These settings are saved automatically when you click Rescan, or exit the emulator."); - return true; + helptext.clear(); + helptext.emplace_back("Here you can configure the various paths for Amiberry resources. In normal usage,"); + helptext.emplace_back("the default paths ahould work fine, however if you wish to change any path, you"); + helptext.emplace_back("can use the \"...\" button, to select the folder/path of your choosing. Details"); + helptext.emplace_back("for each path resource appear below."); + helptext.emplace_back(" "); + helptext.emplace_back("You can enable/disable logging and specify the location of the logfile by using"); + helptext.emplace_back("the relevant options. A logfile is useful when trying to troubleshoot something,"); + helptext.emplace_back("but otherwise this option should be off, as it will incur some extra overhead."); + helptext.emplace_back(" "); + helptext.emplace_back("The \"Rescan Paths\" button will rescan the paths specified above and refresh the"); + helptext.emplace_back("local cache. This should be done if you added kickstart ROMs for example, in order"); + helptext.emplace_back("for Amiberry to pick them up. This button will regenerate the amiberry.conf file"); + helptext.emplace_back("if it's missing, and will be populated with the default values."); + helptext.emplace_back(" "); + helptext.emplace_back("The \"Update WHDLoad XML\" button will attempt to download the latest XML used for"); + helptext.emplace_back("the WHDLoad-booter functionality of Amiberry. It requires an internet connection to"); + helptext.emplace_back("work, obviously. The downloaded file will be stored in the default location of"); + helptext.emplace_back("(whdboot/game-data/whdload_db.xml). Once the file is successfully downloaded, you"); + helptext.emplace_back("will also get a dialog box informing you about the details. A backup copy of the"); + helptext.emplace_back("existing whdload_db.xml is made (whdboot/game-data/whdload_db.bak), to preserve any"); + helptext.emplace_back("custom edits that may have been made."); + helptext.emplace_back(" "); + helptext.emplace_back("The \"Update Controllers DB\" button will attempt to download the latest version of"); + helptext.emplace_back("the bundled gamecontrollerdb.txt file, to be stored in the Configuration files path."); + helptext.emplace_back("The file contains the \"official\" mappings for recognized controllers by SDL2 itself."); + helptext.emplace_back("Please note that this is separate from the user-configurable gamecontrollerdb_user.txt"); + helptext.emplace_back("file, which is contained in the Controllers path. That file is never overwritten, and"); + helptext.emplace_back("it will be loaded after the official one, so any entries contained there will take a "); + helptext.emplace_back("higher priority. Once the file is successfully downloaded, you will also get a dialog"); + helptext.emplace_back("box informing you about the details. A backup copy of the existing gamecontrollerdb.txt"); + helptext.emplace_back("(conf/gamecontrollerdb.bak) is created, to preserve any custom edits it may contain."); + helptext.emplace_back(" "); + helptext.emplace_back("The paths for Amiberry resources include;"); + helptext.emplace_back(" "); + helptext.emplace_back("- System ROMs: The Amiga Kickstart files are by default located under 'kickstarts'."); + helptext.emplace_back(" After changing the location of the Kickstart ROMs, or adding additional ROMs, "); + helptext.emplace_back(" click on the \"Rescan\" button to refresh the list of the available ROMs."); + helptext.emplace_back(" "); + helptext.emplace_back("- Configuration files: These are located under \"conf\" by default. This is where your"); + helptext.emplace_back(" configurations will be stored, but also where Amiberry keeps the special amiberry.conf"); + helptext.emplace_back(" file, which contains the default settings the emulator uses when it starts up. This"); + helptext.emplace_back(" is also where the bundled gamecontrollersdb.txt file is located, which contains the"); + helptext.emplace_back(" community-maintained mappings for various controllers that SDL2 recognizes."); + helptext.emplace_back(" "); + helptext.emplace_back("- NVRAM files: the location where CDTV/CD32 modes will store their NVRAM files."); + helptext.emplace_back(" "); + helptext.emplace_back("- Screenshots: any screenshots you take will be saved by default in this location."); + helptext.emplace_back(" "); + helptext.emplace_back("- Save state files: if you use them, they will be saved in the specified location."); + helptext.emplace_back(" "); + helptext.emplace_back("- Controller files: any custom (user-generated) controller mapping files will be saved"); + helptext.emplace_back(" in this location. This location is also used in RetroArch environments (ie; such as"); + helptext.emplace_back(" RetroPie) to point to the directory containing the controller mappings."); + helptext.emplace_back(" "); + helptext.emplace_back("- RetroArch configuration file (retroarch.cfg): only useful if you are using RetroArch"); + helptext.emplace_back(" (ie; in RetroPie). Amiberry can pick-up the configuration file from the path specified"); + helptext.emplace_back(" here, and load it automatically, applying any mappings it contains. You can ignore this"); + helptext.emplace_back(" path if you're not using RetroArch."); + helptext.emplace_back(" "); + helptext.emplace_back("These settings are saved automatically when you click Rescan, or exit the emulator."); + helptext.emplace_back(" "); + return true; }