idealBuild Files

idealBuild - A Starcraft 2 build order simulator
by gorfou

Project homepage: http://sourceforge.net/projects/idealbuild
Author contact: gorfou@m4tp.org

---------------------------------------
1. License
2. How to
3. Changelog
---------------------------------------
---------------------------------------
1. License
---------------------------------------
	This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
---------------------------------------
2. How to use it
---------------------------------------
* You need a JRE (tested with 1.6, 1.5 should also work)
* Type your orders in the file "input" with a text editor
** Authorized orders are listed in the constants.properties file in the form X.Y where X is a unit, a building or a research and Y a property (mineral cost...)
** The default input file is an example of what you can do
* Double click on the idealBuild.jar file to run the program
* The simulated build is written in the file named output with additional columns:
** Start time in seconds
** Name + id
** Food count before the order
** Minerals and Gas before the order
** Production end time
** Extra minerals and gas when the production started
** Number of active gateways/warpgates
** Energy count on the Nexi
* For a very verbose output of what the program is doing, execute it in a command line terminal (java -jar idealBuild.jar)
---------------------------------------
---------------------------------------
3. Changelog
---------------------------------------
1.0 - (2010/07/24)
* Protoss only
* One order per line in the input file
* One order per line in the output file; warnings appears when supply blocked
* Units, buildings and researches availables are described in the constants.properties file
** The following entities are not supported: PhotonCannon, Hallucination, Upgrades level 2 and 3, Archon, FleetBeacon and its upgrades, Carrier, Mothership 
* Expanding is not supported
* When a worker is produced, it is automatically rallied to the minerals line
* When an assimilator is finished, 3 mining probes are automatically assigned to it
* The simulator will wait for enough resources (minerals, gas and food), tech requirement, and a building to be available before executing the order. The build will fail when it reaches the maximum time limit of 900 seconds
* The constants.properties file specify the caracteritics of each unit/building/research and game mechanics constants. Values can be changed but not the names of the properties
* Minerals collection rate is affected whenever a probe is sent to build something
* Chronoboost is supported with the order "action:Chronoboost:TARGET" where TARGET is a type of building
** the order will be silently ignored if there is no Nexus with enough energy or the target is already being chronoboosted
* Morphing and demorphing warpgates are supported with the actions "action:WarpGate" and "action:Gateway"
** The simulator will wait for a gateway or warpgate to be available