ScriptEd is Copyright 2005-2012 Steven Berry <berrys66@yahoo.co.

uk>

Installation
============

This program has been tested on, and is known to work under, the following Windows
versions:

* Windows 7 Home 64-bit

* Windows 7 Home 32-bit
* windows Vista Business Edition 32-bit
* Windows Vista Home Premium 32-bit
* Windows XP Home service pack 2
* Windows XP Professional
* Windows 2000 Professional service pack 4
* Windows 2000 Server serivce pack 4
* Windows 98
* Windows 95 (ScriptEd only)

1) Please read License.txt before proceeding. If you don't agree with the license
then delete this software now! ;)

** Scintilla is Copyright 1998-2003 by Neil Hodgson <neilh@scintilla.org>

** CPicker is Copyright 2004 by nICO <chick80@libero.it>

2) You can run ScriptEd from anywhere just so long as scintilla.dll, scilexer.dll,
cpicker.dll and scriptinfo.xml are in the same folder as the exe. If you want to
set up file associations (see below) then copy scripted.exe, scintilla.dll,
scilexer.dll, cpicker.dll and scriptinfo.xml to your Windows folder.

Note: ScriptEd uses a special hack of scintilla and scilexer. It will not work
with any other version of these DLLs (unless of course you compile your own version
of Scintilla and incorporate the hacks found in the source code sub-folder).

Note: If you have previously installed ScriptEd you should overwrite your existing
installation with this new distribution.

For support and bug reporting visit AIScripters forums at

http://forums.aiscripters.com/

Compiling source code

=====================

You will need Microsoft Visual C++ 2010 in order to compile the source code for
ScriptEd using
either the workspace or solution file. You can use the Express version of Visual
Studio. However,
if you use the Express edition you will not be able to edit the resource files in
VS, instead,
if you want to chang these you will need to manually edit resource.h and aisedit.rc
using
something like notepad.exe

Download the Scintilla source code from http://www.scintilla.org/

Download the CPicker source code from
http://www.codeproject.com/miscctrl/CPicker.asp
To compile aicheck and aichecker you will need Microsoft Visual C# 2010. The
Express version
works fine.

History
=======

Version 3.0.0.42
----------------

Compatibilty note: the version of scintilla.dll, scilexer.dll and scriptinfo.xml

supplied
with this release are NOT backwards compatible with older versions
of
scripted.exe and using the new files with old versions of ScriptEd
will
almost certainly cause it to crash horribly.

* Upgraded: ScriptEd now uses the latest version of Scintilla and SciLexer
(v3.0.3).
* Added: The auto-completion list now has colour coded icons for different keyword
types
* Added: Code folding. #load directives are automatically detected and the code
between the
#load... and #end-if can be collapsed or expanded by clicking on the
margin icon.
User regions can be defined using the following directive:
;!region ....
{code here}
;!endregion
* Added: Full syntax checking. This is accessible from the Tools menu, or by
pressing F9.
Note: the syntax checker works from the copy of the file on disk rather
than the
copy of the file stored in the editor's memory; you will need to save
the file
first before running the checker.
The following directive can be used for multi-file AIs in order to
tell the checker
what options to use and which file is the top-level loader:

;![@ScriptEd main="<path>" options="<options>" symbols="<symbols>"]

where:
<path> is the full path to the top-level AI file
<options> are one or more of the following separated by
spaces:
--stats - prints file-
level statistics
--no-stats - suppresses file-level
stats
--warnings - prints warning
messages
--no-warnings - suppresses warning
messages
--info - prints
informational messages
 --no-info - suppresses
informational messages
<symbols> is a space-delimited list of definable system
symbols
The <options> and <symbols> sections are optional.
Example:
;![@ScriptEd main="c:\Program Files\Microsoft Games\Age of Empires
II\AI\minimus.per"]
* Added: UP command support to scriptinfo.xml bringing it in line with UP release
20120130-142304
* Added: New registry setting required: HKCU\Software\AIScripters\ScriptEd\aiCheck.
This
stores the full path to the aicheck.exe program. see below for more
information.
* Fixed: Missing or incorrect scriptinfo.xml entries:
Missing identifiers:
my-player-number
my-unique-unit
this-any-ally
this-any-computer
this-any-computer-ally
this-any-computer-enemy
this-any-computer-neutral
this-any-enemy
this-any-human
this-any-human-ally
this-any-human-enemy
this-any-human-neutral
this-any-neutral
REAL-WORLD-BYZANTIUM-MAP
REAL-WORLD-CARIBBEAN-MAP (called central america)
REAL-WORLD-ENGLAND-MAP (called britain)
REAL-WORLD-FRANCE-MAP
REAL-WORLD-ITALY-MAP
REAL-WORLD-JUTLAND-MAP (called norse lands)
REAL-WORLD-MIDEAST-MAP
REAL-WORLD-NIPPON-MAP (called sea of japan)
REAL-WORLD-SPAIN-MAP (called iberia)
REAL-WORLD-TEXAS-MAP
CUSTOM-MAP
ri-elite-turtle-ship
gaia
gate
ri-elite-war-wagon
48 UP operators
ri-elite-plumed-archer

Fixed items:
siege-workshop (now classified correctly)
SCANDANAVIA-MAP (spelling changed to the incorrect spelling
used by game engine)
KING-OF-THE-HILL (changed from KING)
DEFEND-WONDER (changed from DEFEND-THE-WONDER)
TURBO-RANDOM-MAP (now classified as game setting)
monk-set (UP change 20120130-142304)
trebuchet-set (UP change 20120130-142304)
huskarl-set (UP change 20120130-142304)
* New Program: aicheck.exe
The aicheck.exe program is written in .NET framework v2.0 so in order to use this
program
you must have the .NET v2 run-time installed on your computer. This program is the
back-end
parser used by ScriptEd and AIChecker (see below), but can also be run from the
command line.
The command line syntax is:

aicheck aifile [options symbols]

where options and symbols have the same meanings and values as decribed above in
the section
relating to the ;![@ScriptEd directive.
If aicheck is not passed any symbols then all rules and file structures will be
checked. If
symbols are passed then only rules included by the corresponding #load-if-defined
and
#load-if-not-defined directives will be reported (all rules are still checked for
consistency).
AICheck supports all 1.0c and UP v1.1 identifiers and should correctly parse the
new load-random
features in UP v1.1
Note: aicheck needs to know where scriptinfo.xml is stored and looks for the
ScriptEd registry
setting for the correct path. The program will not run if this value is not set or
points
to a pre-version-3 version of the file.
Note: to ensure that the HKCU\Software\AIScripters\ScriptEd\aiCheck registry
setting is correcly
set, copy the file to the folder in which you intend to run it from (probably the
same folder you
copied ScriptEd to) and run it once.

* New Program: aichecker.exe

This is a Windows GUI front-end for aicheck.exe and is independent of ScriptEd.
Settings in the
GUI correspond to the command line options for aicheck and the same rules apply for
what
will be parsed. This program requires the .NET v2.0 framework and the registry
settings for
scriptinfo.xml and aicheck.exe to be set correctly.

Version 2.2.0.41
----------------

* Added: Basic syntax checker - checks parentheses and arrows. Note: the line
number
reported will not be exact, but will refer to the defrule statement
immediately
above the line reported. This also reports the number of rules and
defconsts
found in the file. Hotkey: F8.
* Added: scriptinfo.xml support for User Patch facts, actions, sn's, etc.
* Fixed: Mouse-over tip-text no longer displayed for editor windows that do not
have the focus.
* Fixed: Numerous fixes to scriptinfo.xml related to missing or incorrect
definitions
* Fixed: Multiple defconsts declared on the same line are now loaded correctly
* Fixed: Creating a new document and then maximizing when existing document is
maximised
no longer corrupts the screen.

Version 2.1.4.38
----------------

* Added: Replace All now tells you how many occurences were replaced.
* Fixed: serious bug in "replace all" causing program to crash.

Version 2.1.3.37
----------------

* Changed: All colours are now customisable to any shade you want.

* Note: This version will automatically convert your registry settings for colour
settings. This means that you will not be able to use any previous version
of scriptEd unless you manually delete all of the registry values under
HKEY_CURRENT_USER\Software\AIScripters\ScriptEd.

Version 2.1.2.36
----------------

* Added: Two new colours - "Rice Yellow" and "Dull Gold"

Version 2.1.1.35
----------------

* Changed: The program now searches for the scriptinfo.xml data file in the
following order:-
(1) The location specified by the registry key string value "XMLFile"
under HKEY_CURRENT_USER\Software\AIScripters\ScriptEd
(2) The path of the EXE
(3) The current working directory
(4) The Windows directory
If the program finds the file it will update the registry. If it is unable
to find
the file the program will terminate. You will need to use regedit to
manually
edit the registry and set the correct file location.
* Changed: Makefile support removed for compiling source code

Version 2.1.0.34
----------------

* Added: Toolbar - covers most of the menu optons.

* Added: Status bar - displays current line/total lines, file size, command usage
string
when mouse is over a keyword and current status of "tips".
* Added: Various articles and tips to the script reference XML file

* Changed: Script reference window is now a proper re-sizable MDI child window

* Fixed: Goto Line goes to previous line in file (line number counts 0 - (total
lines -1) )

* Fixed (2.1.0.33): Incorrect description of "archer-line" keyword

* Fixed (2.1.0.33): Missing sub-category "RESOURCE" in XML file
* Fixed (2.1.0.32): Toolbar buttons not disabled when they should be and vice-versa
* Fixed (2.1.0.31): Many menu options crash the program if all child windows are
closed

Version 2.0.1.30
----------------

*Fixed: Auto-completions stops working when more than one character deleted at a
time

*Updated: XML data file now includes my-unique-unit-line keyword.

Version 2.0.0.29
----------------

* Added: MDI window interface

* Added: Load keyword data from XML
* Added: ALT+Left arrow, ALT+Right arrow for switching between editor windows
* Added: Tile/Cascade window options
* Added: System cancel box to all pop-up dialogues
* Added: Auto-complete now more intelligent and produces shorter lists
* Added: Tips. Holding the mouse over a keyword pops-up information about the
keyword. clicking on the tip will bring up more information about
the keyword. Tips can be toggled on or off from the Tools menu.
* Added: Scripting reference. Available from the menu under "Help" or F1.
* Added: Recent file list under the File menu
* Added: About and credits dialogue windows
* Added: Opens most recently accessed file on program start
* Added: Defconst names available in the auto-completion list. These are added
at file load time, and can be updated by pressing F5, or removed by
pressing F6. eg. (defconst my-constant 45) will cause "my-constant" to
be added to the auto-completion list of keywords.
* Added: The display colour for defconst words can be specified in the Settings
dialogue. The default colour is the default foreground colour.

* Changed (2.0.0.24): Reference window no longer opens on program start

* Updated (2.0.0.23): XML data file now includes many more descriptions and usages

* Fixed: Escape didn't close dialogue windows

* Fixed: Goto Line/Find/Find+Replace dialogue default selection
* Fixed: Find did not wrap to start of document and re-search
* Fixed: Re-opening a previously closed file corrupts other windows
* Fixed: Menu option availablity and focusing sometimes incorrect

* Fixed (2.0.0.28): new constants are not colourised in the file they are declared
 when F5 hit.
* Fixed (2.0.0.28): Program crashes when closing default document using hotkeys
* Fixed (2.0.0.25): Program doesn't auto-detect location of XML data file
* Fixed (2.0.0.25): Command font name truncated in registry
* Fixed (2.0.0.24): Tips with empty descriptions are shown
* Fixed (2.0.0.22): XML data has long descriptions that run off the end of the
screen
* Fixed (1.0.3.17): Saving a script with no name crashes the program
* Fixed (1.0.3.15): Open file window creation is arse-about-face
* Fixed (1.0.3.14): Goto Line dialogue stopped working
* Fixed (1.0.3.11): auto-complete keyword recognition buffer problem
* Fixed (1.0.3.11): Window list not updated correctly

Version 1.0.2.10
----------------

* Added: Search and replace

* Added: Option to change fonts and colour scheme
* Added: Command line support (allows file association for .per files to work)
* Added: Ability to switch auto-complete off

* Fixed: Auto-complete backspace problem

* Fixed: Auto-complete "chat-local-to-self" problem

Version 1.0.1.2
---------------

* Added: Find/Find next (ctrl+F/F3)

* Added: Keyword auto-completion

* Fixed: Focus problem in Goto Line dialogue