********************************************************************************
  NEXGEN HELP PLUGIN VERSION 1.01
  Sp0ngeb0b, November 2009
  spongebobut@yahoo.com
  www.unrealriders.de
********************************************************************************



********************************************************************************
  TABLE OF CONTENTS.
********************************************************************************
 1. INTRODUCTION.
 2. QUICK INSTALLATION GUIDE.
 3. UPGRADING FROM A PREVIOUS VERSION.
 4. THE NexgenHelpPlugin.ini FILE.
 5. NEXGENHELPPLUGIN VERSION HISTORY.



********************************************************************************
  1. INTRODUCTION.
********************************************************************************
 This is my first official released Nexgen Plugin. It adds a new tab called
 'Help' into Nexgen. There are displayed Nexgen speach commands; Keybinds; UU
 (UniversalUnreal) commands and buttons for Online Help.

 You can modify or add new things in the config file 'NexgenHelpPlugin.ini'
 
 
 Author's note:
 Please be patient that this may not work 100%. Report any bugs to me.
 You use this at your own risk! ;)


********************************************************************************
  2. QUICK INSTALLATION GUIDE.
********************************************************************************
 1. Make sure your server has been shut down.

 2. Copy the NexgenHelpPlugin100.u and the NexgenHelpPlugin.ini
    file to the system folder of your UT server.

 3. If your server is using redirect upload the NexgenHelpPlugin100.u.uz file to
    the redirect server.

 4. Open your servers configuration file and add the following server package:

      ServerPackages=NexgenHelpPlugin101

    Also add the following server actor:

      ServerActors=NexgenHelpPlugin101.NHPMain

    Note that the actor should be added AFTER the Nexgen controller server actor
    (ServerActors=Nexgen110.NexgenActor).

 5. Now modify the NexgenHelpPlugin.ini file for your needs.
    Get more information in 4.
    
 6. Restart your server.


********************************************************************************
  3. UPGRADING FROM A PREVIOUS VERSION.
********************************************************************************
 1. Make sure your server has been shut down.

 2. Delete NexgenHelpPlugin1xx.u (where xx is the previous version of Nexgen)
    from your servers system folder and upload NexgenHelpPlugin101.u to the same
    folder.

 3. If your server is using redirect you may wish to delete
    NexgenHelpPlugin1xx.u.uz if it is no longer used by other servers.
    Also upload NexgenHelpPlugin101.u.uz to the redirect server.

 4. Open NexgenHelpPlugin.ini.

 5. Do a search and replace where the string "NexgenHelpPlugin1xx." should be
    replaced with "NexgenHelpPlugin101." (without the quotes). Again the xx
    denotes the previous version of NexgenHelpPlugin that was installed on your
    server.

 6. If you upgrade from version 1.00 you can remove the following lines (they
    are not needed anymore):

    Button4=
    url4=
    keybind1a=
    keybind1b=
    keybind2a=
    keybind2b=
    keybind3a=
    keybind3b=

 7. Save the changes and close the file.

 8. Goto the [Engine.GameEngine] section and edit the server package and
    server actor lines for Nexgen. They should look like this:

       ServerActors=NexgenHelpPlugin101.NHPMain

       ServerPackages=NexgenHelpPlugin101

 9. Save changes to the servers configuration file and close it.

 10.Restart your server.

 11.After the server has succesfully restarted shut it down again. Open
    NexgenHelpPlugin.ini again and modify the new lines. Save the changes and
    restart the server again.


********************************************************************************
  4. The NexgenHelpPlugin.ini file.
********************************************************************************
 In this file you can modify the view of the Help Plugin.
 _______________________________________________
 [NexgenHelpPlugin101.NHPConfigExt]
 lastInstalledVersion=101
 enableHelpTab=True
 enableKeyBindregion=True
 enableUUregion=True
 enableButtonregion=True
 buttonHeader=Online Help
 Button1=Button1 Text
 Button2=Button2 Text
 Button3=Button3 Text
 url1=start http://www.example.org
 url2=start http://www.example.net
 url3=start http://www.example.com
 command1a=!nscstats
 command1b=(View the ServerRankings)
 command2a=
 command2b=
 command3a=
 command3b=
 keybindtext1=Suicide
 keybindtext2=Toogle SmartCTF Stats on/off
 keybindtext3=Toogle UUHud on/off
 bindCommand[0]=suicide
 bindCommand[1]=mutate smartctf showstats
 bindCommand[2]=mutate universalunreal togglehud
 _______________________________________________
 
 
 Explanation:

 enableHelpTab       = Show the Help-tab?

 enableKeyBindregion = Whether to display the KeyBind region.

 enableUUregion      = Whether to display the UniversalUnreal region.

 enableButtonregion  = Whether to display the Button region.
 
 buttonHeader        = The Head-Line of the Button region.
 
 Button[x]           = Here you can enter the text which will be visible on the
                       button. Leave it empty and the button will be disabled.
            
 url[x]              = This is the console command the client does when a button
                       is pushed.
                       If you want it to open a page, use the
                      'start http://..' command. DO NOT remove the http!
                       You can also perform other client commands like
                       'open unreal://..'(This would send the player to a server)
            
 command[x]a         = This will modifiy the command region. Only add the
                       command itself here! (e.g. !test)
 
 command[x]b         = Here goes the explanation for the command.
                       (e.g. '(Testing)')

 keybindtext[x]      = Add the explanation for the keybind here.
              
 bindCommand[x]      = This is the command of the keybind. Example:
                       'suicide'
                       'MUTATE BDBMAPVOTE VOTEMENU'
                       More can be found in your User.ini



********************************************************************************
  5. NEXGENHELPPLUGIN VERSION HISTORY.
********************************************************************************

=== NEXGENHELPPLUGIN v1.01 =====================================================
 - Added:   In-Game options for ServerAdmins are now avaible.
 - Added:   Option to display only specific regions of the HelpTab.
 - Added:   KeyBinds are now checked on the client's config and the region will 
            now display the specific key for the speficic command.
 - Removed: From now on there are only 3 buttons, not 4. 
          

=== NEXGENHELPPLUGIN v1.00 =====================================================
 - Misc:    First public release of the Nexgen Help Plugin.

