Skip to content

dgant/PurpleWave

Repository files navigation

PurpleWave

A tournament-winning AI player of StarCraft: Brood War

About

PurpleWave is a StarCraft: Brood War AI written in Scala. It can play all three races and a large variety of professional-style strategies.

PurpleWave has won:

PurpleWave has also ranked #1 on the BASIL, SSCAIT, and SAIL ladders.

Credits

Thanks to:

  • Nathan Roth (Antiga/Iruian) for strategy advice and consulting -- so much of the polish in PurpleWave's strategies comes from his wisdom and replay analysis
  • @JasperGeurtz @Bytekeeper and @N00byEdge for JBWAPI
  • @vjurenka for BWMirror
  • @Cmccrave for Horizon and BWEB
  • @MrTate for JBWEB
  • @lowerlogic for BWTA
  • Igor Dimitrijevic for BWEM
  • @JasperGeurtz for the Java port of BWEM
  • @kovarex and @heinermann for BWAPI
  • @michalsustr and @certicky for SC-Docker and @Bytekeeper for its BASIL port for powering PotatoPeeler
  • @jabbo16 for configuring PurpleWave's Maven build
  • @davechurchill @certicky @krasi0 @Bytekeeper @bgweber @SonkoMagnus Nathan Roth and the Cognition & Intelligence Lab at Sejong University for hosting Brood War competitions and environments that have given PurpleWave visibility and purpose
  • @chriscoxe for diagnosing and solving technical issues in tournament environments that have affected PurpleWave's ability to compete
  • @jaj22/JohnJ and Ankmairdor for lots of advice navigating Brood War mechanics
  • @IMP42 @AdakiteSystems and @tscmoo for helping me get BWAPI up and running when I was getting started
  • @tscmoo for OpenBW
  • NepetaNigra, ChoboSwaggins, @Nitekat, and CH Miner for sharing PurpleWave's games with the world and helping tell our story

The community around BWAPI and StarCraft AI is amazing and PurpleWave could not exist without building on the decade of work these folks have done.

How to build PurpleWave

See build instructions in install.md

Steps:

  • Clone or download this repository (I keep it in c:\p\pw but it should work from anywhere)
  • If you cloned the repository git submodule sync; git submodule update --init --recursive to clone JBWAPI
  • Open IntelliJ IDEA
  • In IntelliJ IDEA: File -> Settings -> Plugins -> Check off Scala
  • In IntelliJ IDEA: File -> Open -> Select the PurpleWave directory
  • In IntelliJ IDEA: File -> Project Structure -> Select the Java Development Kit directory (like c:\Program Files\Java\jdk\1.8.0_121)
  • In IntelliJ IDEA: File -> Project Structure -> Modules -> The green "+" -> Scala -> Create... -> Download... -> 2.12.6... -> OK
  • In IntelliJ IDEA: File -> Project Structure -> Modules -> Dependencies -> Under "Export" check scala-sdk-2.12.6
  • In IntelliJ IDEA: Build -> Build Artifacts... -> Build

This will produce PurpleWave.jar. See below for "How to run PurpleWave"

How to run PurpleWave

  • From IntelliJ IDEA: Run -> Run 'PurpleWave' or Debug 'PurpleWave'
  • As a JAR:
    • cd to the StarCraft directory
    • mkdir -p bwapi-data/AI; mkdir -p bwapi-data/read; mkdir -p bwapi-data/write to create the standard directories for BWAPI bot data
    • Copy PurpleWave.jar to bwapi-data/AI
    • java.exe -jar bwapi-data/AI/PurpleWave.jar <-- Run this from the StarCraft directory

Questions and feedback

Say hi! Post an issue here on Github or email dsgant at gmail

License

PurpleWave is published under the MIT License. I encourage you to use PurpleWave as a starting point for your own creation!