Pakfront's BullRun Editor Version 1.4beta

A simple editor for Mad Minute Game's

 Civil War
 The Battle of Bull Run
 Take Command:1861

This Editor is in no way supported or endorsed by Mad Minute Games or Activision.
http://www.madminutegames.com/ 

[TOC]

• Bugs
• Installation
• Usage
  • Tutorial 1
• Version History

[What Is It?]

A graphical interface for editing units.csv and objectives.csv files. Support for editing events.csv is planned.Useful data is pulled from formations.csv, unitcommon.csv and and Weapons.csv. These are not editable via this editor.You will still need to edit level.ini by hand 

[Reporting A Bug]

• Please email all bug reports to me,  pakfront at gmail.com , with the
  Subject: [CWBR ED] Some descriptive name of your bug
• Write a description of what went wrong. Please be very specific about what happened, and what application it happeneded in. Does it happen in my editor? Or in the CWBR game?
• Also please zip up and attach your Scenario folder and a your Data Files folder from you main CWBR install. E.g.:
  C:\Program Files\Activision Value\Civil War Bull Run\Data Files
  C:\Program Files\Activision Value\Civil War Bull Run\Scenarios\Burnside Goes Left

[Installation]

[Extracting the ZIP]

You should have the following files extracted into a folder called BullRunEditor-v1.3.1,

1.  ScenarioEditor.bat
2.  readme.html (this file)
3.  ostermillerutils_1_04_03.jar
4.  bullruneditor.jar
5.  custom_editor.ini

[Java Installation]

You will need to install the Sun Java Runtime Edition 5.0, Update 1 or later (JRE 5.0 Update 1).
You can download it here:
http://java.sun.com/j2se/1.5.0/download.jsp
It is about 15 megabytes.
Install it first.

Read the Java Instructions here:
http://java.sun.com/j2se/1.5.0/install-windows.html

[Setup - Standard Install]

If you have a standard install of the Bull Run game under
(Some drive):Program Files\Activision Value\Civil War Bull Run
and your 1.1 SDK under
(Some drive):Program Files\Activision Value\Civil War Bull Run\SDK
you should not do do any setup other than get Java installed (above).

[Setup - Custom Install]

If you have a non-standard install of the Rull Run game,  you will to tell the editor where your install is.
Rename custom_editor.ini to editor.ini. Open it in a text editor. You should see something like the following:
BULLRUN_ROOT="C:/Program Files/Activision Value/Civil War Bull Run/"
BULLRUN_SDK=" C:/Program Files/Activision Value/Civil War Bull Run/SDK"

Edit the paths in the quotes to point to your installation of Battle of Bull Run, and where the 1.1 SDK is.
Note the slashes are UNIX style /, not DOS style \. DOS \ should work too, but haven't been totally tested. Also, make sure you have a trailing carriage return - that is, an empty line at
the end of the file.

 [Running the Scenario Editor]

Navigate to the folder where you unzipped the BullRunEditor files and double click on the ScenarioEditor.bat file in Windows Explorer.
A DOS window will open and the program should launch. If it doesn't launch, look at the DOS window for errors. When the program does run, some feedback is sent to the DOS box. Most of this
is for debugging and can be ignored unless you are having problems.

[Possible Errors on Launch]

If you don't have an SDK folder under your CWBR install, you will need your CWBR CD in the drive.

['java' is not recognized as an internal or external command...]
If you do not see the splash screen and you have this error:
please see above and java.sun.com to make sure you have Java 5.0 Update 1 (aka 1.5.0_01) installed and in your PATH.
You should make sure your PATH environment variable to point to the Java installation
you can check your PATH by typing this in a Command Prompt:
echo %PATH%

 [Wrong java version]
if you type java -version at the command prompt, you should see the following output on your command line:
java version "1.5.0_01"

If you have a later version of java, the program should still run. Earlier versions will not run the Editor. Follow the instructions for installing Java, above.

[Using The Scenario Editor]

**Back up all your current Custom Scenarios!**

[Tutorial 1]

1. Be sure to at least read the 'by-hand' tutorial at http://www.madminutegames.com/modding/article1.htm
2. Start the Scenario Editor by Double Clicking on the ScenarioEditor.bat file
3. File -> Load Open Default Scenario brings up a File Chooser
   1. Navigate into the Burnside folder
   2. Select the level.ini file, and hit Open
4. On color map, click on the Blue Box surrounded by the yellow circle. This is 'you'.
   1. (Advanced Users) Changing who 'you' is can be done by hand editing the level.ini [Rank] fields.
5. You should notice that the Order of Battle window has expanded to show 'you" (Burnside) in the order of battle. Also the Unit Table window shows a bunch of information about Burnside's unit.
   1. Unit Table -> Show allows you to display various information about the selected units. Most of these fields are editiable too.
6. Move Burnside the the Wilkins House by (Middle Mouse) or (Alt+ Left Mouse) dragging his icon on either the Color map or the Larger scale B&W map.
   1. You can Zoom in and out by right clicking on the Map.
   2. You can Rotate the selected Units by Ctrl+Middle Mouse dragging.
   3. Rotate Burnside to face South (down). The little stick indicates the direction he is facing.
7. Now let's add a new Unit to Burnside's command. We'll have them keep him company near the Wilkins House.
8. Select the 2nd_NH in the Order of Battle. Note that the information on the Unit Table changes. The map may also shift to center the Unit.
   1. Right Click and Hold on the 2nd_NH entry in the Unit Table. Select Duplicate from the menu.
   2. A New Unit Appears on the Order of Battle tree. It's called Unnamed_Infantry_Gray...
   3. Select this new unit in the Order of Battle. It is positioned right on top of 2nd_NH. Not so good.
   4. Move the Unit (Middle Mouse) on the map to the field just above the Wilkins house, very close to Burnside.
9. We will rename the Unit... Units must have idnames to be used, otherwise they are ignored by CWBR. N.B. idnames and names are different. idnames are used by CWBR to keep track of the units. They must be unique for each unit. They shouldnt have spaces. Use _ instead. Names are what is displayed to the user in CWBR. The can be whatever you want and can have spaces.
   1. Make sure that your Unit Table -> Show -> is at Default.
   2. Double click on the empty idname field.
   3. Enter 1st_AL in the idname field of the Unit Table
   4. Likewise, enter 1st Alaskan Regt in the name field.
10. Now we will save the scenario as a New Scenario
    1. File->Save As
    2. Enter Alaskans as the name for your new scenario. Hit OK.
    3. This made a new directory in your CWBR install: Scenarios\Alaskans.
11. Now Start up CWBR.
    1. Go to Custom Scenarios.
    2. Choose Alaskans
    3. You should be in htere as Burnside, now near the Wilkins house, and with a new regiment of fresh faced Alaskans to command.

[Menus]

 [File menu]
-Open Custom Scenario - one from your Bull Run install. Navigate into the directory that contains the level.ini file, select the level.ini and click OK.
-Open Default Scenario - one from the CD
-Save and Save As save the units.csv. Save As also moves over the other Data Files from the previous Scenario. You probably want to do a Save As after editing one of the default scenarios.
-Import Order of Battle - Import any units format .csv as the current scenarios units list. Arranges them on the map by Corps.
-Import Selected from unitlocs.csv - Will move and orient the currently selected units to match what you exported out of the Bull Run game when you hit the 'l' (L) key.
-Open Last Open Play - Allows you to load your last open play game as a scenario.

 [Scenario menu - level.ini.]
-Set Player's Unit to Current - Used to change which unit is the player in the Scenario. See Scenario Table for more options

[Windows]

 [MiniMap & Terrain Map - edits units.csv]
MiniMap is what you see in the game, Terrain Map is the greyscale used by the engine to determine underlying terrain types (not the elevations!).
- Left click to select Units. Left Click + Ctrl to multiselect.
- Middle Drag (or Left Click + Alt) to move selected Units
- Middle Drag + Ctrl (or Left Click + Alt + Ctrl) to rotate selected units
- Right Click to Popup to:
  + Select Subunits, Select Parents
  + Sort Units (Rearranges them on the map in an organigram style layout)
  + Switch between Objective and Unit editing mode
  + Add and Remove Objectives
  + Load a custom background image. This must be square, but any resolution is OK.
    Map automatically figures out scale for new image.
- Right Click + Shift to Zoom In
- Right Click + Ctrl to Zoom Out

 [Order of Battle edits units.csv]
A hierarchal browser. Double Click to get the Branches to open.
Entries that say Placeholder are 'undefined' units. They will not be exported back into the units.csv but are placeholders to keep the proper ranks.
Units that say "UnnamedBlah" Have some or all attributes defined except a unique idname. You will have to give them a unique idname for them to export.
Right Click to get
 Copy, Paste, Duplicate, Remove menu.
currently there is no checking to see if idnames are unique. I'll get this in there ASAP.

 [Unit Table - edits units.csv]
For Editing the attributes of the selected units. Use the SHOW menu to choose which attributes to show. There are Combo boxes for Unit Class and Weapons & Formations entires.

 [Objective Table - edits objectives.csv]
Use the SHOW menu to choose which attributes to show. There are Combo boxes for Major/minor objectives. If we get more info about objectives, ill add more options.

 [Scenario Properties Table - edits level.ini]
change settings such as time, weather. See Scenario Menu in main menu bar for other options

 [Events Table - edits events.csv]

• Edit Menu
  • Cut and Copy events from the table. 
  • Use Shift Selected Event Time to shift selected events times.
• Use RIGHT Click to access context sensitve menu 
• In ALL Columns
  • Duplicate the objective to the slot below
  • Paste Events that were Copied Or Cut from the Edit menu
  • Make New Events below current one
• Over the Trigger Column
  • change trigger type if not a Time event or an evtobjdone (These are special cases)
• Over the Unit Column
  • Assign event to currently selected Unit or Objective. Seletciton can be done on the maps or the OOB Tree
• Over the Command Menu
  • Select from a list of common commands. This will place an example command in the cell
• Over the LocX or LocY Column
  • Use the 'Stored Position.' This is set on the MiniMap right click popup menu and is represented by a Magenta crosshair

[Version History]

                [New for 1.4 Beta]
Events Table editor - Edit and save changes to events.ini. See Events Table documentation for detail
Scenario Properties Editor - change settings such as time, weather. Edits the level.ini
File Menu - Open Last Open Play - Allows you to load your last open play game as a scenario.

                [New for 1.3]
Load custom background image from Right Click menu in MiniMap. This must be square, but any resolution is OK. Map automatically figures out scale for new image.
Draws unit footprints. These are drawn as the full size of the formation as defined in formations.csv, regardless of the actual number of men in the unit.  Hope to get this fixed later.

                [New for 1.2.1]
Can use Left Click + Alt instead of Middle Click on Minimap, for those with uncooperative mouse wheels.

                [New for 1.2]
Added Import OOB to File menu.
Minimap Right Click menu added Select Subunits, Select Parents, Sort Units (Rearranges them on the map in an organigram style layout)

                [New for 1.1]
Made setup simpler and more robust.
Fixed "Show" menu repeats on opening a scenario.
Added Objective editor.
Map Zoom in with Shift Right Mouse, Zoom out with Ctrl Right mouse.
Added Right click menu in Minimap for editing objectives. You can move, add, and delete objectives.
Added events.csv synch check.

                [New For Beta 2]
Multiple Bug fixes for GUI, including working scroll bars for OOB and most update issues.
Maps now center on selected units if they are off screen.
Map Zoom in with Right Mouse, Zoom out with Ctrl Right mouse. This is still kinda not working right.
Paste Below in OOB Editor                
Custom formation.csv, Weapons.csv and unitcommon.csv are detected and used.
Reads formation.csv.
More robust Read/Write for all .csv files.
Accepts any of the maps in level.ini (1st_BULL_RUN, 1st_BULL_RUN_HIST, Cedar_Ridge, Laurel_Junction) Remember, capitalization must match the .lsl and map graphic's names.

[Possible Future Features]

• Icon Resizing
• Editable Events
• Editable Terrain properties
• Sprite Browsers for Flags, Uniforms, etc.
• These will only be added if there is demand.

 [Other Notes]

Bull Run Editor uses the Ostermill utilities under the GPL. See http://ostermiller.org/utils/