Contextual Help
===============
by phkb

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. 

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");
    }

License
-------
Creative Commons Attribution Non-Commercial Share-Alike 4.0 (https://creativecommons.org/licenses/by-nc-sa/4.0/)

Version History
---------------
1.1
- Small tweak to the info text at the bottom of the screen.
- Removed debug message.
- Expanded readme.txt info.

1.0
- Initial release

