Skip to content

Commit

Permalink
doc: improve help text regarding mt32 roms (fixes #1287)
Browse files Browse the repository at this point in the history
  • Loading branch information
midwan committed Apr 19, 2024
1 parent 2bb6930 commit b8f889a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 14 deletions.
20 changes: 11 additions & 9 deletions src/osdep/gui/PanelIOPorts.cpp
Expand Up @@ -447,15 +447,17 @@ bool HelpPanelIO(std::vector<std::string>& helptext)
helptext.emplace_back("uaeserial.device: You can use this option if you want to use multiple serial ports,");
helptext.emplace_back(" by mapping Amiga side unit X = host serial port X");
helptext.emplace_back(" ");
helptext.emplace_back("MIDI Out/In: If you have any MIDI devices connected, you can select them here.");
helptext.emplace_back(" Amiberry uses the PortMidi library to send and receive MIDI messages.");
helptext.emplace_back(" Amiberry also offers the option to emulate a Roland MT-32 MIDI device,");
helptext.emplace_back(" if you have the required ROMs installed. The dropdown will indicate if");
helptext.emplace_back(" the required ROM files were detected or not. Please note that the path");
helptext.emplace_back(" Amiberry will look for, is hardcoded to be \"<kickstarts dir>/mt32-roms\".");
helptext.emplace_back(" If the ROMs were detected, you can set the MIDI Out to an MT-32 option and");
helptext.emplace_back(" use any software that makes use of it (e.g. several Sierra games).");
helptext.emplace_back(" The audio output is mixed with Paula's output.");
helptext.emplace_back("MIDI Out/In: Amiberry uses the PortMidi library to send and receive MIDI messages,");
helptext.emplace_back(" so if you have any MIDI devices connected, you can select them here. You");
helptext.emplace_back(" can also emulate a Roland MT-32 MIDI device using Amiberry, if you have");
helptext.emplace_back(" the required MT-32 ROM files installed. Please note that the path for ");
helptext.emplace_back(" these ROM files must be in your System ROMs: directory as set in the ");
helptext.emplace_back(R"( "Paths" panel, or inside a "mt32-roms" directory under that location.)");
helptext.emplace_back(" ");
helptext.emplace_back(" If the required MT-32 ROMs are detected by Amiberry, you can then select");
helptext.emplace_back(" the emulated MT-32 device, using the MIDI \"Out:\" dropdown options. This");
helptext.emplace_back(" allows you to use any Amiga software that makes use of it (several Sierra");
helptext.emplace_back(" games for example). The audio output here is mixed with Paula's output.");
helptext.emplace_back(" ");
helptext.emplace_back("Route MIDI In to MIDI Out: This option will reroute the MIDI In to the MIDI Out port,");
helptext.emplace_back(" as the name implies.");
Expand Down
10 changes: 5 additions & 5 deletions src/osdep/gui/PanelPaths.cpp
Expand Up @@ -782,11 +782,11 @@ bool HelpPanelPaths(std::vector<std::string>& helptext)
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. Please");
helptext.emplace_back(" note that the directory \"mt32-roms\" must exist in this location, and contain the");
helptext.emplace_back(" required MT-32 roms if you wish to use that MIDI feature in Amiberry.");
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 any additional ROMs, ");
helptext.emplace_back(" click on the \"Rescan\" button to refresh the list of the available ROMs. Please");
helptext.emplace_back(" note that MT-32 ROM files may also reside here, or in a \"mt32-roms\" directory");
helptext.emplace_back(" at this location, if you wish to use the MT-32 MIDI emulation feature in Amiberry.");
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");
Expand Down

2 comments on commit b8f889a

@giantclambake
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tiny blemish here...

ex

The word "Paths" is not justified left correctly. This happens when I submit text like this;

helptext.emplace_back(" \"Paths\" panel,

...that is committed as;

helptext.emplace_back(R"( "Paths" panel,

The 2 backslash escapes end up being deleted, and the displayed text moves 2 chars to left in result.

Adding two chars of whitespace in front of "Paths" seems to fix.

TIA

@midwan
Copy link
Collaborator Author

@midwan midwan commented on b8f889a Apr 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My bad, I'll fix it

Please sign in to comment.