WME Visual Script Editor
========================

Version 0.5

coded by Marcus 'Mac' Rckendorf in 2005
Copyright (C)2005 by Bullshit Softworx



What is it ?
------------
WME Visual Script Editor (VSE) is an Editor application specially designed for
use with the Wintermute Engine (WME) by Jan 'Mnemonic' Nedoma (www.dead-code.org).
You can also edit normal text files but that won't get you the kick.



What are it's features ?
------------------------
- All WME methods are included with parameters and tool-tips
- Syntax checking via 'wme_comp.exe'
- Syntax highlighting (colors and font styles)
- IntelliSense-like behaviour when you type a '.'-character
- Quick access to code-blocks and user-keywords
- Script printing
- and all that boring text edit stuff



How to work with it:
--------------------
The usage is very similar to Microsoft's masterpiece 'Notepad', with some WME specific
specialities. First you got an ever present tree view on the right side of the main
window that gives you quick access to all WME methods with parameters and short descriptions
that are shown in the status bar when you click a method. With a double click you are
able to insert this method to your script directly at the current cursor position. By default
'()' is added to the end but if the option 'Insert full parameters' is checked (below the
tree view) the full parameters are inserted.

For example:

- Option unchecked and double clicking on 'LOG()': 'LOG()' is inserted
- Option checked and double clicking on 'LOG()': 'LOG(Text)' is inserted

Other things are included in the tree view too. These are user keywords (just edit 'WME_User_List.txt'
to use your own keywords for quick access), WME keywords (like 'this','self',...), directions
('DI_UP','DI_UPLEFT',...), low level events ('LeftClick','Keypress',...) and code blocks, which
are a nice way to insert whole functions or text passages at once.
The ESC key can be used to open or close the method list quickly. The splitter between the
editor and the tree view can be dragged to change the horizontal scaling of both.

Another cool feature (at least in my opinion) is the 'IntelliSense'-like behaviour (I call it
'MinitelliSense' :) ). When typing a '.'-character a small list box appears below the cursor
from which you can choose a method to insert after the '.'. The 'Game', 'Scene' and 'actor' members
will be recognized and the method list will be filtered right. When the method list is open you
can switch to it by holding down the 'CTRL' key and scroll through it via cursor keys and insert
the active method from the list to your script. YOu can of course use the mouse instead.

I won't tell you to use the common edit functions of a text editor now, I think you all know
how to print, find words in the script and so on.



The settings window:
--------------------
Here is your place to change VSEs behaviour for some things.

General tab:
- Editor font - Click on the 'Choose' button to open a standard file requester where you
    can choose the font to be used in the editor and its size, too
- Associated project file - To make the syntax checking work you will have to choose
    the WME project file that your script belongs to

Code parsing tab:
- Enable syntax highlighting - Lets you enable the code coloring
- ... on script opening - enables coloring of the whole script when it's loaded
- ... for realtime editing - enables coloring of the last edited line on a line change
    (this function makes the text a bit flickering when running through it with the cursor keys)
- Highlighting style - Here you can control whether colors or font styles are used for
    syntax highlighting (or both)
- Enable point recognition - switches the 'MinitelliSense' stuff on/off

Colors tab:
- Here you can choose the different colors and font styles for the syntax highlighting.
    Click on the color buttons to choose a color, use B (Bold), I (Italic) or U (Underline)
    for selecting the required style

Printing tab:
- Let you choose the default printer and the printing color (color choosing not available yet)



Thanks to all guys at the WME forums (forum.dead-code.org) and Mnemonic for support and
this overwhelming engine.

For bug reporting, suggestions and wishes please post to the following thread at the WME
forums:
http://forum.dead-code.org/index.php?topic=1200.0
or send a mail to:
bullshit.softworx@mac-bs.de

Hope you like it and it's useful for ya.

Cheers
Mac
