Black & White World Modifier v1.0
============================

This tool enables you to edit/modify B&W scripts according to a dictionary of known script commands. However; you can also use numeric values which are not listed in the dictionary (yet).
Please check http://www.bweditors.com/mods/bwwm.phtml for future updates. Don't forget to also check http://www.planetblackandwhite.com/bwmaps for all the maps you'll ever need !


Features
=======
- shows lists of known parameter alternates for each script command
- 2D visualisation of object placement on a generated screenshot of the landscape
- point'n'click object placement
- color picker for MIST colors
- context sensitive help (Morquis'Mapping List v1.02 HTML)
- toolbar button for autosaving current script (to 'BWWorldModEditScript.txt') and quickstart Black & White in skirmish mode
- selecting & starting your preferred landscape editor along with the current landscape
- read/write multiplayer/online maps (fully functional)
- log windows for errors/warnings/messages generated for actions performed on current script


Log windows
==========
The log windows (see the 'View' menu bar or use keyboard shortcuts) provide you with an overview of errors/warnings and/or messages wich apply to the current script. 
For example, when you load a script the error/warning log window will pop up to inform you about any errors encountered. Everytime you perform an action like loading/saving the action result will be appended to the logwindow.
However you can also close the logwindow and open it at any time to see the results again.
The same principles apply to messages. Messages are not necessarily related to the current script- messages are generated whenever you select 'Create/split multiplayer maps'.


External landscape editor
====================
when using an external landscape editor, please keep in mind that :
- After exiting the external landscape editor, BWWorldMod will refresh the landscape to which the current script refers to (possibly NOT the landscape that was saved by the editor); so possibly you need to change the LOAD_LANDSCAPE script line and regenerate the landscape manually (see the 'Land' menu)
- Possibly the external landscape editor will not update the lorestextures associated with a LND file. so what ? => this means that when the bitmap for the landscape is generated by BWWorldMod; it will *not* reflect the changes made to the landscape. This problem will be solved in a future version of BWWorldMod
- Currently, there are two known landscape editors : Eden project and SculptEd. Due to a bug (in EdenProject :-) EdenProject will crash when running the program with a startup parameter (will be fixed in next version, thanx DrogonBLK). SculptEd does not support startup parameters...
- ... but, bundled with this release of BWWorldMod is a special edition of SculptEd. This version (1.0b SE) supports command line parameters. All future releases of SculptEd will support commandline parameters (the more HEAL miracles we cast towards the author of SculptEd- the sooner a new version will be released =).


Point'n'click object placement
=======================
When you've selected a script line (representing an object) with one or more positions (for example CREATE_ABODE); a red circle will appear (for each of the script line's positions) in the LND bitmaps. You can use the left LND bitmap to navigate through the LND (press left mouse to navigate, press right mouse to zoom in/out). When you move the mouse over the rightmost (more detailed) LND picture you will see the current coordinates in the top left corner of the picture. Now here comes the barba-trick : pressing the left mousebutton will select the current position into the 1st position parameter of the selected script line. Pressing the right mousebutton will select the current position into the 2nd position parameter of the selected script line. This means that you can use your keyboard to scroll through the script list and your mouse to modify the positions of the object. Uhh; if you are confused->experiment with it. I need someone to write me a neat help file ;-)
When you've selected a script line (or marked a position on the map) you will see one or more flashing circles on the LND pictures. Yellow represents position #1, red represents position #2, and cyan represents the marked position.
Finally, if you dont like this feature you can always use the 'M' key to copy the current position to the clipboard, or even enter the new object coordinates manually (and no one will hate you for that :-) !


Multiplayer/online maps
=====================
You can now split existing multiplayer maps (located in the '.\Online Maps' folder in the Black & White program folder), after which you can edit/modify the land and/or play it in skirmish mode.
The editor also allows you to create a multiplayer map file from any singleplayer map. Just select any (non single player) skirmish map and follow the on-screen instructions. An installation manual is automatically created for your convenience.
Quick note on creating multiplayer maps : there must be at least 2 citadels in the skirmish script (use the CREATE_CITADEL function). Possibly you should remove any TOGGLE_COMPUTER_PLAYER references too, to switch between cpu/human opponents :-)


Menu/Keyboard/Mouse shortcuts
===========================
*** Menu ***
CTRL+N - [FILE] new script
CTRL+L - [FILE] load script
CTRL+S - [FILE] save script
CTRL+A - [FILE] save script to different file
CTRL+X - [FILE] exit BWWorldMod
CTRL+R - [LAND] regenerate landscape
CTRL+E - [LAND] edit landscape
CTRL+O - [LAND] set landscape editor
CTRL+P - [VIEW] color picker
CTRL+M - [VIEW] messages
CTRL+W - [VIEW] errors/warnings
CTRL+U - [MULTIPLAYER] create map
CTRL+Z - [MULTIPLAYER] split map
CTRL+G - [BNW] start Black & White skirmish
CTRL+H - [HELP] Script Help
CTRL+I - [HELP] General information (you're looking at it :-)

*** LND overview picture (leftmost picture) ***
left mouse - move display rectangle
right mouse - zoom in/out

*** LND detail picture (rightmost picture) ***
left mouse - assign current position to position parameter #1 of selected script line 
right mouse - assign current position to position parameter #2 of selected script line 
UP - select previous script line
DOWN 	- select next script line
M - mark/copy current position to clipboard (CTRL+V to paste)
DEL - delete current script line / object
INS - duplicate current script line / object

*** Command list ***
dblclick left mouse - insert script line into script list

*** Script list ***
UP - select previous script line
DOWN 	- select next script line
M - mark/copy current position to clipboard (CTRL+V to paste)
DEL - delete current script line / object
INS - duplicate current script line / object


Known bugs
==========
- please use your own intelligence when editing the files. (for example, do not use quotes in parameter values)
- pressing 'go' when Black & White is already running does not work correctly (the screen will go 'black' ;-). You need to use alt-tab to actually switch to Black & White.
- if marking a position does not work at first -> please right click on the land detail picture and then try again.


Future versions
=============
The future is uncertain...


v1.0 changes
===========
- general bugfixes (big thanx to Dragon and Doctoid for helping me track down & fix bugs)
- improved LND visualisation
- editor should work fine on 800*600
- 'Store' button which stores all parameters for current script line as default


v0.9 changes
===========
- home sweet home : the editor now has its own webspace @ BWEDITORS... Thanx Nick (and GUGBE)!
- fully functional online/multiplayer map creation


v0.8 changes
===========
- point'n'click object placement
- CREATE_MIST colorpicker
- keyboard shortcuts to improve navigation
- Faster loading of scripts
- Select/start external landscape editor 
- aspexec.dll no longer required
- save/save as...
- error/warning log window
- read/write multiplayer/online maps (untested though, see readme)
- bug fix (crashed when deleting script line)
- bug fix (crashed when entering incorrect coordinate parameter)
- editor now asks user for Black & White location is if it's not automatically found


V0.7 changes
============
- fullscreen mode implemented
- (hopefully)more stable script parser. the parser had some problems with scripts which contain errors. i tried loading about 50 maps and the editor did not crash (anymore ;-). but please keep those bugreports coming =)
- flicker free screen updates
- smoother zooming
- no script size limitation


V0.6 changes
============
- fixed bug for using () characters within script parameters
- added toolbar
- (accidentally) fixed memory consumption problem (but it still is a lot :-)
- added 'go' button which saves the currently loaded script to 'BWWorldModEditScript.txt' and starts Black N White in skirmish mode 


V0.5 changes
===========
- no installer exe.
- removed mirror feature of generated lnd bitmaps
- removed 'tiling effect' bug of generated lnd bitmaps
- disabled compiler 'nag for updated controls' option 
- fixed position accuracy bug
- hilites of selected object in LND overview pictures makes it easier to find currently selected object
- overview pictures are updated on each script line change.
- small other changes which i cant remember at this moment


V0.4 changes
===========
- zooming in/out on the land bitmap now supported
- general UI changes


V0.3 changes
===========
- added BMP visualisation of LND files (thanx DragonBLK & DarkYoda!!)
- added object placement visualisation. you can now view where all script objects are placed on the map !!


v0.2 changes
===========
- merged MorQuis' Black & White Mapping List v1.04 with parameter dictionary 
- some UI changes (move mouse over parameter boxes to see a description)
- disabled dictionary modifications (obsolete)
- context sensitive help. press Help when you've selected a script line to open the function definition in Morquis' Mapping List


Thanks & Acknowledgements 
========================
I would like to thank :
- Morquis - for letting me use his mapping list- it really is a great document
- DarkYoda - for hist landviewer, and for general help & support
- DragonBLK - for helping me out with the LND2BMP tool!!
- Agonized Menace - for general info & feedback
- Panic - for allowing me to include a special edition of SculptEd
- Gugbe - for providing me with a real home for the editor @ BWMAPS!!! ( => moved to BWEditors )
- Nick - for providing me with a real home for the editor @ BWEDITORS!!! 
- Lunar - for beta testing and sending me his ideas for new features... thnx!

Whenever you find a bug, report it to me and i'll try to fix it. 

If there's anyone out there who is serious about expanding BWWorldMod functionality, please contact me to obtain the source code.

You can email me at the adress below:

sacha@ranzigeventjes.com