GuiModernTextListCtrl TGEA 1.8.2 Edition version 1.02 -- 2013-02-27 (Wednesday, February 27th, 2013)

The use of the GuiModernTextListCtrl is governed by the license that you're using Torque under as the control
is a derivative of the core GUI subsystem code. This control edition was ported from the Torque 3D version and
tested on Torque TGEA 1.8.2, no promises for any earlier Torque engine.

Documentation and updates can be found at:
   http://dottools.net/doku.php/programming/tge/controls/guimoderntextlistctrl

The zip file contains the follow files and directories:
   TGEA_Fixes.patch                    -- Diff of the engine source code changes. Excluding the control code.
   StrongholdGameScriptChanges.patch   -- Diff of the script changes made to the Stronghold example under GameExamples.
   engine/                             -- Complete copy of the changed engine source files to suit control integration.
   GameExamples/                       -- Complete copy of the changed game script files to suit control demonstration.

The differential patch files are WinMerge diffs of the changes made to the vanilla/stock TGEA 1.8.2 source code
and scripts against the modifications made to support the GuiModernTextListCtrl GUI control. As mentioned above
the example torque scripts that demonstrate the GuiModernTextListCtrl have been merged into GameExamples/Stronghold
game example that is found under the TGEA installation directory.

Because patch/diff files aren't very portable nor easy to deal with on Windows operating systems the entire source
and script files that have been modified are provided for easy of merging the changes into your copy of the Torque
engine by using tools like WinMerge (on Windows) or Meld (on Linux) between the provided files against your current
working copy of the game engine.


Fastest Method To Install, Build, and Get Started:
   NOTE: Make sure you have latest backups of your working copy before performing these steps just in case!
   NOTE: If you have already made engine source modifications and you're not copying these files into a stock/vanilla
         copy of the Torque Advanced Game Engine then do NOT perform these steps, but instead skip to the next section!

1) Copy both engine/ and GameExamples/ directories and paste them into your TGEA install path, say Yes to
   all prompts to overwrite existing files. 

2) Navigate to <TGEA_Directory>/GameExamples/Stronghold/ and run generateProjects(.bat|.command) to update the
   buildFiles/ project files.

3) Navigate to <TGEA_Directory>/GameExamples/Stronghold/buildFiles/ and pick the directory that is relevant to
   your development environment tools, such as open VisualStudio 2008/ directory and then open Stronghold.sln.

   Then perform a build and eventually it should complete without error.

4) Navigate to <TGEA_Directory>/GameExamples/Stronghold/game/ and launch Stronghold(.exe|.app).

5) Click on the "Server Browser..." button above "Start Mission..." there a window simulating/faking a game
   server browser will be displayed that demonstrations most of the control's abilities.

6) Enjoy and have fun! :)


The Best Way to integrate The Control Into your Torque Project:

   I won't go into step by step directions as that is out of scope of this introduction document. Basically just
reiterating what was mentioned about and that is use a differential merging tool such as WinMerge for Windows or
Meld on Linux (I'm sure there's something for Mac OS X too) that you just compare the provided engine/ and
GameExamples/ directories against your existing installation of Torque engine and manually merge the changes as
you see fit. I will say that the changes made to the engine/ sources are mandatory in order for the GUI control
to function properly or even compile successfully. Keep that in mind if you just decide to only copy and paste
the GuiModernTextListCtrl.h/.cpp files as that won't work.

   You most definitely want to go this route if you've already made engine source changes and don't want to lose
any modifications made to your working copy of the files that are named the same as the files that are provided.



	-Nathan Martin / TRON

Document last updated on 2013-02-27.
