pandory500/redquark-amiberry-rb
2
0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fixed #608: Improved GUI documentation

Browse source
This commit is contained in:
Dimitris Panokostas 2020-03-16 22:06:28 +01:00
parent 9b4712cfd7
commit f6b22bb8e2
12 changed files with 49 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

10
src/osdep/gui/PanelCPU.cpp
View file

@ -442,14 +442,14 @@ bool HelpPanelCPU(std::vector<std::string>& helptext)
helptext.emplace_back("is selected and emulates simple prefetch of the 68000. This may improve compatibility");
helptext.emplace_back("in few situations but is not required for most games and demos.");
helptext.emplace_back(" ");
helptext.emplace_back("JIT enables the Just-in-time compiler. This may break compatibility in some games.");
helptext.emplace_back("");
helptext.emplace_back("JIT/JIT FPU enables the Just-in-time compiler. This may break compatibility in some games.");
helptext.emplace_back(" ");
helptext.emplace_back("The available FPU models depending on the selected CPU.");
helptext.emplace_back("The option \"More compatible\" activates more accurate rounding and compare of two floats.");
helptext.emplace_back(" ");
helptext.emplace_back("With \"CPU Speed\" you can choose the clock rate of the Amiga.");
helptext.emplace_back("Use 7MHz for A500 games or 14MHz for A1200 ones. Fastest uses more emulation time");
helptext.emplace_back("for the CPU, and Turbo will give only the minimum time to the chipset, using as");
helptext.emplace_back("With \"CPU Speed\" you can choose the clock rate of the emulated Amiga.");
helptext.emplace_back("Use 7MHz for A500 or 14MHz for A1200 speed. Fastest uses more emulation time");
helptext.emplace_back("for the CPU, and Turbo will give only the minimum time to the Chipset, using as");
helptext.emplace_back("much as possible for the CPU, usually resulting in dropping frames also.");
helptext.emplace_back(" ");
helptext.emplace_back("In current version, you will not see a difference in the performance for 68020,");

14
src/osdep/gui/PanelChipset.cpp
View file

@ -396,21 +396,21 @@ bool HelpPanelChipset(std::vector<std::string>& helptext)
{
helptext.clear();
helptext.emplace_back("If you want to emulate an Amiga 1200, select AGA. For most Amiga 500 games,");
helptext.emplace_back("select \"Full ECS\". Some older Amiga games requires \"OCS\" or \"ECS Agnus\".");
helptext.emplace_back(R"(select "Full ECS" instead. Some older Amiga games require "OCS" or "ECS Agnus".)");
helptext.emplace_back("You have to play with these options if a game won't work as expected. By selecting");
helptext.emplace_back("an entry in \"Extra\", all internal chipset settings will become the required values");
helptext.emplace_back("for the specified Amiga model. For some games, you have to activate \"NTSC\"");
helptext.emplace_back("an entry in \"Extra\", all internal Chipset settings will change to the required values");
helptext.emplace_back("for the specified Amiga model. For some games, you have to switch to \"NTSC\"");
helptext.emplace_back("(60 Hz instead of 50 Hz) for correct timing.");
helptext.emplace_back(" ");
helptext.emplace_back("When you see some graphic issues in a game, try \"Immediate\" or \"Wait for blit.\"");
helptext.emplace_back("for blitter and/or disable \"Fast copper\".");
helptext.emplace_back(R"(If you see graphic issues in a game, try the "Immediate" or "Wait for blitter")");
helptext.emplace_back("Blitter options and/or disable \"Fast copper\".");
helptext.emplace_back(" ");
helptext.emplace_back("\"Fast copper\" uses a prediction algorithm instead of checking the copper state");
helptext.emplace_back("on a more regular basis. This may cause issues but brings a big performance improvement.");
helptext.emplace_back("The option was removed in WinUAE in an early state, but for most games, it works fine and");
helptext.emplace_back("the better performance is helpful for low powered devices.");
helptext.emplace_back("the improved performance is helpful for low powered devices.");
helptext.emplace_back(" ");
helptext.emplace_back("For \"Collision Level\", select \"Sprites and Sprites vs. Playfield\" which is fine");
helptext.emplace_back(R"(For "Collision Level", select "Sprites and Sprites vs. Playfield" which is fine)");
helptext.emplace_back("for nearly all games.");
return true;
}

6
src/osdep/gui/PanelConfig.cpp
View file

@ -351,10 +351,10 @@ bool HelpPanelConfig(std::vector<std::string>& helptext)
{
helptext.clear();
helptext.emplace_back("To load a configuration, select the entry in the list and then click on \"Load\".");
helptext.emplace_back("If you doubleclick on an entry in the list, the emulation starts with this configuration.");
helptext.emplace_back("If you double-click on an entry in the list, the emulation starts with this configuration.");
helptext.emplace_back(" ");
helptext.emplace_back("If you want to create a new configuration, setup all options, enter a new name in");
helptext.emplace_back(R"("Name", provide a short description and then click on "Save".)");
helptext.emplace_back("If you want to create a new configuration, set all options, enter a new name in");
helptext.emplace_back(R"("Name", optionally provide a short description and then click on "Save".)");
helptext.emplace_back(" ");
helptext.emplace_back("\"Delete\" will delete the selected configuration.");
return true;

8
src/osdep/gui/PanelDisplay.cpp
View file

@ -369,6 +369,14 @@ bool HelpPanelDisplay(std::vector<std::string>& helptext)
helptext.emplace_back("Demo or Workbench uses HiRes mode and you selected a value for \"Width\" lower than 640,");
helptext.emplace_back("you will only see half of the pixels.");
helptext.emplace_back(" ");
helptext.emplace_back("You can use the Horizontal/Vertical centering options to center the image automatically");
helptext.emplace_back(" ");
helptext.emplace_back("The Aspect Ratio option allows you to choose if you want the correct Aspect Ratio");
helptext.emplace_back("to be kept always (default), or have the image stretched to fill the screen instead.");
helptext.emplace_back(" ");
helptext.emplace_back("The Full Screen option allows you to switch from Windowed to Full screen and back.");
helptext.emplace_back("This only works when running under X11 with SDL2, as KMSDRM is always Fullscreen.");
helptext.emplace_back(" ");
helptext.emplace_back("Select the scaling method for the Amiga screen. The default option \"Auto\", ");
helptext.emplace_back("will try to find the best looking scaling method depending on your monitor's resolution. ");
helptext.emplace_back("\"Nearest Neighbor\" will give you a more pixelated and crisp image, but it may come with ");

4
src/osdep/gui/PanelFloppy.cpp
View file

@ -612,8 +612,8 @@ bool HelpPanelFloppy(std::vector<std::string>& helptext)
helptext.emplace_back("The option \"Write-protected\" indicates if the emulator can write to the ADF.");
helptext.emplace_back("Changing the write protection of the disk file may fail because of missing rights");
helptext.emplace_back("on the host filesystem.");
helptext.emplace_back("The button \"...\" opens a dialog to select the required");
helptext.emplace_back("disk file. With the dropdown control, you can select one of the disks you recently used.");
helptext.emplace_back("The button \"...\" opens a dialog to select the required disk file.");
helptext.emplace_back("With the dropdown control, you can select one of the disks you recently used.");
helptext.emplace_back(" ");
helptext.emplace_back("You can reduce the loading time for lot of games by increasing the floppy drive");
helptext.emplace_back("emulation speed. A few games will not load with higher drive speed and you have");

2
src/osdep/gui/PanelHD.cpp
View file

@ -660,6 +660,6 @@ bool HelpPanelHD(std::vector<std::string>& helptext)
helptext.emplace_back(R"(Activate "CD drive" to emulate CD for CD32. Use "Eject" to remove current CD)");
helptext.emplace_back("and click on \"...\" to open a dialog to select the iso/cue file for CD emulation.");
helptext.emplace_back(" ");
helptext.emplace_back("In current version, WAV, MP3 and FLAC are supported for audio tracks.");
helptext.emplace_back("In the current version, WAV, MP3 and FLAC files are supported for audio tracks.");
return true;
}

2
src/osdep/gui/PanelInput.cpp
View file

@ -576,7 +576,7 @@ bool HelpPanelInput(std::vector<std::string>& helptext)
helptext.emplace_back("Set the emulated mouse speed to .25x, .5x, 1x, 2x and 4x to slow down or ");
helptext.emplace_back("speed up the mouse.");
helptext.emplace_back(" ");
helptext.emplace_back("When \"Enable mousehack\" is activated, you can use touch input to set .");
helptext.emplace_back("When \"Enable mousehack\" is activated, you can use touch input to set");
helptext.emplace_back("the mouse pointer to the exact position. This works very well on Workbench, ");
helptext.emplace_back("but many games using their own mouse handling and will not profit from this mode.");
helptext.emplace_back(" ");

8
src/osdep/gui/PanelMisc.cpp
View file

@ -403,12 +403,18 @@ bool HelpPanelMisc(std::vector<std::string>& helptext)
helptext.emplace_back("(red) access to the HDD. The next values are showing the track number for each disk drive");
helptext.emplace_back("and indicates disk access.");
helptext.emplace_back(" ");
helptext.emplace_back("When you deactivate the option \"Show GUI on startup\" and use this configuration ");
helptext.emplace_back("When you deactivate the option \"Show GUI on startup\" and use this configuration");
helptext.emplace_back("by specifying it with the command line parameter \"-config=<file>\", ");
helptext.emplace_back("the emulation starts directly without showing the GUI.");
helptext.emplace_back(" ");
helptext.emplace_back("\"bsdsocket.library\" enables network functions (i.e. for web browsers in OS3.9).");
helptext.emplace_back("You don't need to use a TCP stack (e.g. AmiTCP/Genesis/Roadshow) when this option is enabled.");
helptext.emplace_back(" ");
helptext.emplace_back("\"Master floppy drive protection\" will disable all write access to floppy disks.");
helptext.emplace_back(" ");
helptext.emplace_back("You can set some of the keyboard LEDs to react on drive activity, using the relevant options.");
helptext.emplace_back(" ");
helptext.emplace_back("Finally, you can assign the desired hotkeys to Open the GUI, Quit the emulator,");
helptext.emplace_back("open Action Replay/HRTMon or toggle Fullscreen mode ON/OFF.");
return true;
}

9
src/osdep/gui/PanelPaths.cpp
View file

@ -443,11 +443,14 @@ void RefreshPanelPaths()
bool HelpPanelPaths(std::vector<std::string>& 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("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("After changing the location of the kickstart roms, click on \"Rescan\" to refresh");
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.");
return true;
}

2
src/osdep/gui/PanelRAM.cpp
View file

@ -369,7 +369,7 @@ bool HelpPanelRAM(std::vector<std::string>& helptext)
helptext.emplace_back("a 32 bit CPU is selected. If you select some memory for this type,");
helptext.emplace_back("the Z3 RTG board will be activated.");
helptext.emplace_back(" ");
helptext.emplace_back("A4000 motherboard and processor board memory is only detected by the Amiga if ");
helptext.emplace_back("A4000 motherboard and processor board memory is only detected by the Amiga if");
helptext.emplace_back("you choose the correct Kickstart ROM (A4000).");
return true;
}

7
src/osdep/gui/PanelROM.cpp
View file

@ -393,12 +393,17 @@ void RefreshPanelROM()
bool HelpPanelROM(std::vector<std::string>& helptext)
{
helptext.clear();
helptext.emplace_back("Select the required kickstart ROM for the Amiga you want to emulate in \"Main ROM File\".");
helptext.emplace_back("Select the required Kickstart ROM for the Amiga you want to emulate in \"Main ROM File\".");
helptext.emplace_back(" ");
helptext.emplace_back("In \"Extended ROM File\", you can only select the required ROM for CD32 emulation.");
helptext.emplace_back(" ");
helptext.emplace_back("In \"Cartridge ROM File\", you can select the CD32 FMV module to activate video");
helptext.emplace_back("playback in CD32. There are also some Action Replay and Freezer cards and the built-in");
helptext.emplace_back("HRTMon available.");
helptext.emplace_back(" ");
helptext.emplace_back("The Advanced UAE Expansion/Boot ROM option allows you to set the following:");
helptext.emplace_back("Rom Disabled: All UAE expansions are disabled. Only needed if you want to force it.");
helptext.emplace_back("Original UAE: Autoconfig board + F0 ROM.");
helptext.emplace_back("New UAE: 64k + F0 ROM - not very useful (per Toni Wilen).");
return true;
}

4
src/osdep/gui/PanelSound.cpp
View file

@ -496,8 +496,8 @@ bool HelpPanelSound(std::vector<std::string>& helptext)
helptext.emplace_back("You can turn on sound emulation with different levels of accuracy and");
helptext.emplace_back("choose between Mono and Stereo.");
helptext.emplace_back(" ");
helptext.emplace_back("The different types of interpolation have different impact on performance. ");
helptext.emplace_back("Play with the settings to find the type you like most. You may need headphones .");
helptext.emplace_back("The different types of interpolation have different impact on performance.");
helptext.emplace_back("Play with the settings to find the type you like most. You may need headphones");
helptext.emplace_back("to really hear the difference between the interpolation types.");
helptext.emplace_back(" ");
helptext.emplace_back("With \"Filter\", you can select the type of the Amiga audio filter.");