Tribal IDE

----------------------------------
Tribal IDE
The Tribes 2/Torque Script Development Environment

Version : Beta 3.9 Open Source
Date    : 20/03/2002
Author  : David Dunscombe 
email   : roceh@barrysworld.com
Website : http://tribes.barrysworld.net/ide/
----------------------------------


The following is from the GNU Public license, and is a general
disclaimer for Tribal IDE. This does not mean that Tribal IDE is
distributed under GPL.

          BECAUSE THE PROGRAM IS LICENSED FREE OF
     CHARGE, THERE IS NO WARRANTY  FOR THE
     PROGRAM, TO THE EXTENT PERMITTED BY
     APPLICABLE LAW.  EXCEPT WHEN  OTHERWISE
     STATED IN WRITING THE COPYRIGHT HOLDERS
     AND/OR OTHER PARTIES  PROVIDE THE PROGRAM
     "AS IS" WITHOUT WARRANTY OF ANY KIND,
     EITHER EXPRESSED  OR IMPLIED, INCLUDING, BUT
     NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
     MERCHANTABILITY AND FITNESS FOR A
     PARTICULAR PURPOSE.  THE ENTIRE RISK AS  TO
     THE QUALITY AND PERFORMANCE OF THE
     PROGRAM IS WITH YOU.  SHOULD THE  PROGRAM
     PROVE DEFECTIVE, YOU ASSUME THE COST OF
     ALL NECESSARY SERVICING,  REPAIR OR
     CORRECTION.

Whats New
---------

	Fixed - XP Theming was causing problems on Windows 95/98/NT/2000.

	Open Sourced - I've released this version as open source. You can use the editor source for 
anything you want, theres no specific licensing requirements. The IDE is written in Borland Delphi 5
( www.borland.com ) if you want to mess with the source. Thats a few gotchas with this as I
had used a couple of commercial components in previous versions. These being unziping support and
better handling of form docking. So these features are absent from this release. However I have added
XP theme support for Windows XP users and Office XP Styling for other Windows OS's, so at least it 
looks pretty =D. The components your gonna have to get to compile it are listed below.

These three components sets for the newly added XP theme support

* Toolbar 2000 - http://www.toolbar2000.com/
* TBX - http://www.g32.org/tbx/
* ThemeManager - http://www.lischke-online.de/ThemeManager.html

Main Editor component

* SynEdit - http://synedit.sourceforge.net/
* The Tribes2/Torque highlighter is including in the source zip

Treeview type component

* ElTree Lite - http://www.torry.net/vcl/lvtv/enhancedtreeviews/eltreelite.zip

Combobox used in find dialogs

* TRegCombobox - http://www.torry.net/vcl/sizers/other/regcontrols.zip

Preferences Form Controls

* Colorgrid component - http://www.torry.net/vcl/grids/drawgrids/rcg.zip
* Outlook2000 - included with source zip
* FontSizeCombobox - http://www.torry.net/vcl/lbcb/fontlistandcomboboxes/svfntcmb.zip

As you can see i'm a component monkey, Happy downloading ;)


Overview
--------

What is Tribal IDE?

	Tribal IDE is an easy to use environment in which to develop scripts and modifications for 
Tribes 2 and also GarageGames Torque Engine ( www.garagegames.com ). 


Installation
------------
If your reading this you've installed it =D. If you've used the install then Tribal IDE will require 
a restart as the install updates the common controls (although if you have Internet Explorer 5 installed 
you dont have to restart).


Shortcut Keys
-------------
Comment Block   [SHIFT+ALT+C] - Add comment '//' to begining of every selected line
UnComment Block [SHIFT+ALT+U] - Remove comment '//' from begining of every selected line
Indent Block    [TAB] - Indent selected block by specified tab width
UnIndent Block  [SHIFT+TAB] - Unindent block by specified tab width

Connect/Resume Debugging [F9] - Connect to debug server, once connected this will resume.
Step Into [F7] - Step into code on line.
Step Over [F8] - Step over current line.
Toggle Breakpoint [F5] - Toggle breakpoint (if possible) at current line.

Plus typical editor ones.

Creating a project
------------------
To create a new project click on the New Project button. This shows a window with a Project Name and
Base Path edit boxes. Type in a name for your project in the space provided. The base path is used
to work out the relative path names for a script. This is needed as the debugger will send the IDE 
filenames in the format 'scripts\turret.cs' without an absolute path. So this base path needs to be 
something like 'C:\Dynamix\Tribes2\GameData\MyMod\' where mymod is similar to base (ie. you scripts 
will be in C:\Dynamix\Tribes2\GameData\MyMod\scripts\ directory). Click OK and the IDE will ask you
whether you want to to scan for .cs files in all subdirectorys from this path. 

Function Browser
----------------
The function browser initially will parse all the files in your project for functions and the classes 
they are in. It will show them in a large list. As you save files in your project the list will 
instantly update with the functions your have added/edited or deleted. There is also a seperate list of
the functions in the active file. Also when you rigth click on a function in the editor, say for example

      %game.onAIFriendlyFire(%clVictim, %clAttacker, %damageType, %sourceObject);

if you right clicked on the on onAIFriendlyFire bit your would see on the popup menu 5 places where this 
function is defined CnHGame::onAIFriendlyFire, CTFGame::onAIFriendlyFire, etc. This can be clicked on to
jump to the relevant code.


Using the debugger
------------------
Tribes 2 has implemented a remote debugger. You can connect to it via a Tribes 2 client with debugger();
but I thought it'd be nice to have a windows app be able to do this. The first thing you need to do
is start up Tribes 2 either 

a) on another PC which is on the same network as you
b) run Tribes 2 in a window on same PC
c) run it as a dedicated server on same PC. 

For the debugging feature to work correctly you need to have a project with the same script files as 
Tribes 2 is running. Also the path for each

• Tribal IDE version Beta 3.8OS
• app/Tribal.exe
• app/Readme.txt
• fonts/Tahoma.TTF