Compile BWAPI

Creating a Release

Building Binaries (Windows)

Requirements

• Microsoft Visual Studio Express 2013 for Windows Desktop
• Git (Ensure git is part of your PATH variable)

Instructions

1. Open the project solution in Visual Studio.
2. Ensure that you have permission to write to the Starcraft directory. This can be done by modifying the permissions of the directory or installing the program in the user space.
3. Build for both DEBUG and RELEASE.

Generating Documentation (Any OS)

Requirements

• Doxygen (1.8.6 or newer)
• Graphviz (For prettier diagrams)

Instructions

1. Navigate to bwapi/Documentation.
2. Change the version information in Doxyfile.
3. Run doxygen

Documentation should be created in bwapi/Release_Binary/documentation and ready for packaging. The generated log messages should contain no errors.

Building Installer (Windows)

In order to build the installer, you must first complete the Building Binaries and Generating Documentation steps.

Requirements

• Inno Setup (Get the QuickStart package with Inno Script Studio)

Instructions

1. Navigate to bwapi/Installer.
2. Open installer.iss.
3. Change the version information.
4. Click on Project and go to Compile.

Server/Full Stack Setup

These are the steps to compile EVERYTHING. You typically don't need to do this, unless you're working on all of the components. Usually you can leave the installer compilation to the BWAPI build server.

1. Install Microsoft Visual Studio Express 2013 for Windows Desktop
2. Install Microsoft Build Tools 2013 (?)
3. Download the Cygwin Installer
4. Run the following command on the Cygwin installer: setup-x86_64.exe -q -P git cppcheck doxygen graphviz bash pngcrush p7zip
5. Install Java
6. Install Inno Setup
7. Add the location of msbuild, Cygwin /bin, Java, and Inno Setup to your PATH variable