Contextual Help

Overview

This OXP adds contextual help to 11 different GUI screens, to provide some support for players who are unfamiliar with the game mechanics and ways to interact with each game screen. It also supports the ability for other OXP's to add their own text to the help shown.

The default key used for each page is Ctrl-H.

Important Note

This mod will only work with the latest Oolite release (v1.91 or newer).

Installation

Place the 'ContextualHelp.oxz' into your 'AddOns' folder and when you start the game, hold down 'Shift' until you see the spinning Cobra.
Alternatively, you can download the expansion using the expansion pack manager in the game itself.

OXP integrations

To add extra help to a particular GUI screen, use the following command:

 var w = worldScripts.ContextualHelp;
 if (w) {
     w.$addHelpTextToGuiScreen(this.name, "GUI_SCREEN_MARKET", "Some extra text to show.");
 }

To apply a specific background image to a GUI screen help page, use the following code:

 var w = worldScripts.ContextualHelp;
 if (w) {
     w.$setBackgroundForHelpScreen("GUI_SCREEN_MARKET", "my_background_image.png");
 }

To apply a specific overlay image to a GUI screen help page, use the following code:

 var w = worldScripts.ContextualHelp;
 if (w) {
     w.$setOverlayForHelpScreen("GUI_SCREEN_MARKET", "my_overlay_image.png");
 }

Download

Download ContextualHelp.oxz (v1.1).

License

This work is licensed under the Creative Commons Attribution-Noncommercial-Share Alike 4.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/4.0/