______________________________________________________________________________

           README - WinEdit Support for UnrealScript within WinEdit
                by "Devon 'TherMight' Tuck" <devon@eversmile.com>
                            Created 21 January, 2000
______________________________________________________________________________


What is the purpose of this package?
____________________________________

This is a set of files that add WinEdit support for editing and compilation
of UnrealScript (http://unreal.epicgames.com) source code.


Features
________

* Recognition of .uc files with language keywords highlighted

* The names of over 1400 UnrealScript classes that were distributed with the
  release of Unreal Tournament (through version 405b) will highlight in
  a separate color as "library" classes.

* A "Compile" option is available from a right click within the editing
  window of an UnrealScript (.uc) file.  It will remove the project file
  for the package you are editing within and re-run "ucc make"
  NOTE: This feature is only supported when editing "YourFile.uc" within
  the package/project directory "YourPackage" as described below.
  "YourUnrealTournamentDirectory\YourPackage\Classes\YourFile.uc"

* Compilation errors show up in the output window of WinEdit.

* Double-clicking on an error in the output window launches an edit window
  positioned at the error's line number. 


Contents
________

WinEditUnrealScript.txt       - This file
ViewOptionsUC.jpg             - Screen shot that shows my options dialog
                                support for the .UC file type using the
                                MNU, WBT, CLR files
System\UnrealScriptPopup.MNU  - Support for right-click-menu in a .uc file
                                edit window
System\UnrealScriptError.WBT  - Support for ucc make error output
System\Syntax\UC.CLR          - Defines UnrealScript keyword and library
                                highlighting for 1400+ base UnrealScript
                                classes

Installation
____________

1. Install the files from this zip
Extract the contents of the zip file within your WinEdit directory,
so that the files in the "System" directory tree are saved along-
side your other WinEdit "System" files.

2. Add support in View->Options for the UC file type
See the included screen shot, ViewOptionsUC.jpg which shows you the
settings required to get .uc file type support in WinEdit using the
supplied MNU, WBT and CLR files.

Briefly, go to the View->Options dialog box, hit "Edit" then "New"
then type in "UC" (leave off the "Files" part).  Then "Close" and
select "UC Files" as the File type in the Options dialog box.
Fill in the various file names for "Error parsing", "Context Menu"
and then finally click the "Syntax Coloring" button and put in
the // and /* */ comment support. (See the screen shot, a picture
is worth a thousand words)

3. Load up a .uc file within a project/package directory structured
like "YourUnrealTournamentDir\YourPackage\Classes\YourFile.uc"
right click on the window and select "Compile"

The System\YourPackage.u file will be deleted, and the "ucc make"
command will run and compile YourFile.uc, showing any errors
clickable in the ouput window.

You're done!  Enjoy!


Why WinEdit for UnrealScript Development?
_________________________________________

WinEdit from http://www.winedit.com is an excellent, flexible and powerful
programmers editor available for the Windows platform.

From http://www.winedit.com/download.html
  "You are welcome to download a fully functional copy of WinEdit for
  evaluation, or to upgrade from an earlier release you may already have.
  There is no charge for the download, but you must license the software
  if you decide to keep it."


What Other Editors Support UnrealScript?
________________________________________

With the addition of WinEdit support, there are now several
programmer's editors that the community has hand-rolled
UnrealScript support for, to various unsupported degrees.
You could ask around in the #unrealscript channel at
irc.gameslink.net or check through some of the many UT development
web sites on the net for more info.

  WinEdit (www.winedit.com)
        UScript Support by Devon'TherMight' <devon@eversmile.com>
        http://www.eversmile.com/devon/ut
  VIM - Clone of that trusty old Unix editor for Windows (www.vim.org)
        UScript Support by Major'Trips' <major@planetquake.com>
        http://www.fleiner.com/vim/syntax/uc.vim
  TextPad (http://www.textpad.com)
        UScript Support by "Ob1-Kenobi" <ob1@planetunreal.com>
        http://www.planetunreal.com/umodwizard/UScript_TextPadSyntax.zip
  Microsoft Visual Studio (http://www.microsoft.com)
        I believe people just use the C/C++ highlighting
        It sure would be great if someone could extend this
        to support browsing class files by keyword though...
  UnrealEd (Built-in level & source editing tool. Has pros and cons)


History
_______

Jan 21 00 - Iniital release
Jan 26 00 - Modified the Popup menu script so that "ucc make" output
  always goes to the output window where errors can be double-clicked


Good luck with all your UnrealScript endeavors,
     Devon 'TherMight' Tuck

______________________________________________________________________________

