Merge branch 'master' into ipv6-base-merge

Author: jrepp

docs/tutorial1.md

@@ -55,21 +55,24 @@ The sc2_coordinator is included from sc2_api.h, you will use it to start and man
 The coordinator requires some preliminary information to properly start and connect
 to the Starcraft executable.
 
-Add the following code inside the main function.
+Replace the `main` function with the following code:
 
 ```C++
-Coordinator coordinator;
-coordinator.LoadSettings(argc, argv);
+int main(int argc, char* argv[]) {
+    Coordinator coordinator;
+    coordinator.LoadSettings(argc, argv);
 
-Bot bot;
-coordinator.SetParticipants({
-    CreateParticipant(Race::Terran, &bot),
-    CreateComputer(Race::Zerg)
-});
+    Bot bot;
+    coordinator.SetParticipants({
+        CreateParticipant(Race::Terran, &bot),
+        CreateComputer(Race::Zerg)
+    });
 
-coordinator.LaunchStarcraft();
-coordinator.StartGame(sc2::kMapBelShirVestigeLE);
+    coordinator.LaunchStarcraft();
+    coordinator.StartGame(sc2::kMapBelShirVestigeLE);
 
+    return 0;
+}
 ```
 
 > If you have started the retail binary LoadSettings should automatically load necessary settings.

examples/CMakeLists.txt

@@ -40,11 +40,12 @@ example_project(bot_micro "bot_micro.cc")
 example_project(bot_mp "bot_mp.cc")
 example_project(intermediate_bot "intermediate_bot.cc")
 example_project(annoying_helper "annoying_helper.cc")
+example_project(proxy, "proxy.cc")
+example_project(save_load, "save_load.cc")
 # example_project(bot_mp_ipv6 "bot_mp_ipv6.cc")
 
 if (NOT APPLE)
     example_project_extra(feature_layers "feature_layers.cc" sc2renderer)
     example_project_extra(rendered "rendered.cc" sc2renderer)
 endif ()
 
-

examples/common/bot_examples.cc

@@ -14,9 +14,6 @@ namespace sc2 {
 
 static int TargetSCVCount = 15;
 
-struct IsVisible {
-    bool operator()(const Unit& unit) { return unit.display_type == Unit::Visible; };
-};
 struct IsAttackable {
     bool operator()(const Unit& unit) {
         switch (unit.unit_type.ToType()) {

examples/rendered.cc

@@ -49,7 +49,7 @@ int main(int argc, char* argv[]) {
 #if LINUX_USE_SOFTWARE_RENDER
     coordinator.AddCommandLine("-osmesapath /usr/lib/x86_64-linux-gnu/libOSMesa.so");
 #else
-    coordinator.AddCommandLine("-eglpath /usr/lib/nvidia-384/libEGL.so");
+    coordinator.AddCommandLine("-eglpath libEGL.so");
 #endif
 #endif
 
@@ -71,4 +71,4 @@ int main(int argc, char* argv[]) {
     }
 
     return 0;
-}
+}

examples/save_load.cc

@@ -0,0 +1,79 @@
+#include "sc2api/sc2_api.h"
+#include "sc2lib/sc2_lib.h"
+#include "sc2utils/sc2_manage_process.h"
+
+#include <iostream>
+
+using namespace sc2;
+
+class WorkerRushBot : public Agent {
+public:
+    void CenterCamera(std::vector<const Unit*> units) {
+        if (units.size() == 0)
+            return;
+
+        Point2D center;
+        for (auto unit : units) {
+            center += unit->pos;
+        }
+        center /= (float)units.size();
+
+        Debug()->DebugMoveCamera(center);
+        Debug()->SendDebug();
+    }
+
+    virtual void OnStep() final {
+        const ObservationInterface* obs = Observation();
+
+        // Worker rush the enemy!
+        //
+        auto enemy_base = obs->GetGameInfo().enemy_start_locations[0];
+        const auto& workers = obs->GetUnits(Unit::Alliance::Self, IsUnit(UNIT_TYPEID::TERRAN_SCV));
+        for (auto unit : workers) {
+            Actions()->UnitCommand(unit, ABILITY_ID::ATTACK, enemy_base);
+        }
+        CenterCamera(workers);
+
+        // Create a savepoint as we arrive at the enemy base
+        //
+        if (!has_save) {
+            const auto& enemies = obs->GetUnits(Unit::Alliance::Enemy, IsVisible());
+            if (enemies.size() > 0) {
+                Control()->Save();
+                has_save = true;
+            }
+        }
+
+        // All our workers died... Load the savepoint and try again.
+        //
+        if (has_save && workers.size() == 0) {
+            Control()->Load();
+        }
+    };
+
+private:
+    bool has_save = false;
+
+};
+
+//*************************************************************************************************
+int main(int argc, char* argv[]) {
+    sc2::Coordinator coordinator;
+    if (!coordinator.LoadSettings(argc, argv)) {
+        return 1;
+    }
+
+    WorkerRushBot bot;
+    coordinator.SetParticipants({
+        CreateParticipant(sc2::Race::Terran, &bot),
+        CreateComputer(sc2::Race::Protoss)
+    });
+
+    coordinator.LaunchStarcraft();
+    coordinator.StartGame(sc2::kMapBelShirVestigeLE);
+
+    while (coordinator.Update());
+    while (!sc2::PollKeyPress());
+
+    return 0;
+}

include/sc2api/sc2_client.h

@@ -134,5 +134,8 @@ bool IsCarryingMinerals(const Unit& unit);
 //!< \return Returns true if the unit is carrying vespene, false otherwise.
 bool IsCarryingVespene(const Unit& unit);
 
+struct IsVisible {
+    bool operator()(const Unit& unit);
+};
 
-}
+}

include/sc2api/sc2_control_interfaces.h

@@ -68,6 +68,10 @@ class ControlInterface {
     virtual void ClearProtocolErrors() = 0;
 
     virtual void UseGeneralizedAbility(bool value) = 0;
+
+    // Save/Load.
+    virtual void Save() = 0;
+    virtual void Load() = 0;
 };
 
 class AgentControlInterface {

include/sc2api/sc2_typeenums.h

@@ -179,18 +179,19 @@ namespace sc2 {
         PROTOSS_INTERCEPTOR = 85,    // SMART, MOVE, PATROL, HOLDPOSITION, STOP, ATTACK
         PROTOSS_MOTHERSHIP = 10,    // SMART, MOVE, PATROL, HOLDPOSITION, EFFECT_PHOTONOVERCHARGE, EFFECT_TIMEWARP, STOP, ATTACK, EFFECT_MASSRECALL
         PROTOSS_MOTHERSHIPCORE = 488,   // SMART, MOVE, PATROL, HOLDPOSITION, MORPH_MOTHERSHIP, EFFECT_PHOTONOVERCHARGE, EFFECT_TIMEWARP, CANCEL, STOP, ATTACK, EFFECT_MASSRECALL
-        PROTOSS_NEXUS = 59,    // SMART, EFFECT_CHRONOBOOST, TRAIN_PROBE, TRAIN_MOTHERSHIPCORE, CANCEL, CANCEL_LAST, RALLY_WORKERS
+        PROTOSS_NEXUS = 59,    // SMART, EFFECT_CHRONOBOOST, TRAIN_PROBE, TRAIN_MOTHERSHIP, CANCEL, CANCEL_LAST, RALLY_WORKERS
         PROTOSS_OBSERVER = 82,    // SMART, MOVE, PATROL, HOLDPOSITION, STOP, ATTACK
         PROTOSS_ORACLE = 495,   // SMART, MOVE, PATROL, HOLDPOSITION, EFFECT_ORACLEREVELATION, BEHAVIOR_PULSARBEAMON, BEHAVIOR_PULSARBEAMOFF, BUILD_STASISTRAP, CANCEL, STOP, ATTACK
         PROTOSS_ORACLESTASISTRAP = 732,   // CANCEL
         PROTOSS_PHOENIX = 78,    // SMART, MOVE, PATROL, HOLDPOSITION, EFFECT_GRAVITONBEAM, CANCEL, STOP, ATTACK
         PROTOSS_PHOTONCANNON = 66,    // SMART, CANCEL, STOP, ATTACK
-        PROTOSS_PROBE = 84,    // SMART, MOVE, PATROL, HOLDPOSITION, BUILD_NEXUS, BUILD_PYLON, BUILD_ASSIMILATOR, BUILD_GATEWAY, BUILD_FORGE, BUILD_FLEETBEACON, BUILD_TWILIGHTCOUNCIL, BUILD_PHOTONCANNON, BUILD_STARGATE, BUILD_TEMPLARARCHIVE, BUILD_DARKSHRINE, BUILD_ROBOTICSBAY, BUILD_ROBOTICSFACILITY, BUILD_CYBERNETICSCORE, STOP, HARVEST_GATHER, HARVEST_RETURN, ATTACK, EFFECT_SPRAY
+        PROTOSS_PROBE = 84,    // SMART, MOVE, PATROL, HOLDPOSITION, BUILD_NEXUS, BUILD_PYLON, BUILD_ASSIMILATOR, BUILD_GATEWAY, BUILD_FORGE, BUILD_FLEETBEACON, BUILD_TWILIGHTCOUNCIL, BUILD_PHOTONCANNON, BUILD_SHIELDBATTERY, BUILD_STARGATE, BUILD_TEMPLARARCHIVE, BUILD_DARKSHRINE, BUILD_ROBOTICSBAY, BUILD_ROBOTICSFACILITY, BUILD_CYBERNETICSCORE, STOP, HARVEST_GATHER, HARVEST_RETURN, ATTACK, EFFECT_SPRAY
         PROTOSS_PYLON = 60,    // CANCEL
         PROTOSS_PYLONOVERCHARGED = 894,   // SMART, STOP, ATTACK
         PROTOSS_ROBOTICSBAY = 70,    // RESEARCH_GRAVITICBOOSTER, RESEARCH_GRAVITICDRIVE, RESEARCH_EXTENDEDTHERMALLANCE, CANCEL, CANCEL_LAST
         PROTOSS_ROBOTICSFACILITY = 71,    // SMART, TRAIN_WARPPRISM, TRAIN_OBSERVER, TRAIN_COLOSSUS, TRAIN_IMMORTAL, TRAIN_DISRUPTOR, CANCEL, CANCEL_LAST, RALLY_UNITS
         PROTOSS_SENTRY = 77,    // SMART, MOVE, PATROL, HOLDPOSITION, EFFECT_GUARDIANSHIELD, HALLUCINATION_ARCHON, HALLUCINATION_COLOSSUS, HALLUCINATION_HIGHTEMPLAR, HALLUCINATION_IMMORTAL, HALLUCINATION_PHOENIX, HALLUCINATION_PROBE, HALLUCINATION_STALKER, HALLUCINATION_VOIDRAY, HALLUCINATION_WARPPRISM, HALLUCINATION_ZEALOT, EFFECT_FORCEFIELD, HALLUCINATION_ORACLE, HALLUCINATION_DISRUPTOR, HALLUCINATION_ADEPT, STOP, RALLY_UNITS, ATTACK
+        PROTOSS_SHIELDBATTERY = 1910,   // SMART, EFFECT_RESTORE
         PROTOSS_STALKER = 74,    // SMART, MOVE, PATROL, HOLDPOSITION, STOP, RALLY_UNITS, ATTACK, EFFECT_BLINK
         PROTOSS_STARGATE = 67,    // SMART, TRAIN_PHOENIX, TRAIN_CARRIER, TRAIN_VOIDRAY, TRAIN_ORACLE, TRAIN_TEMPEST, CANCEL, CANCEL_LAST, RALLY_UNITS
         PROTOSS_TEMPEST = 496,   // SMART, MOVE, PATROL, HOLDPOSITION, EFFECT_TEMPESTDISRUPTIONBLAST, CANCEL, STOP, ATTACK
@@ -314,6 +315,7 @@ namespace sc2 {
         BUILD_ROBOTICSBAY = 892,   // Target: Point.
         BUILD_ROBOTICSFACILITY = 893,   // Target: Point.
         BUILD_SENSORTOWER = 326,   // Target: Point.
+        BUILD_SHIELDBATTERY = 895,   // Target: Point.
         BUILD_SPAWNINGPOOL = 1155,  // Target: Point.
         BUILD_SPINECRAWLER = 1166,  // Target: Point.
         BUILD_SPIRE = 1158,  // Target: Point.
@@ -428,6 +430,7 @@ namespace sc2 {
         EFFECT_REPAIR = 3685,  // Target: Unit.
         EFFECT_REPAIR_MULE = 78,    // Target: Unit.
         EFFECT_REPAIR_SCV = 316,   // Target: Unit.
+        EFFECT_RESTORE = 3765,      // Target: Unit.
         EFFECT_SALVAGE = 32,    // Target: None.
         EFFECT_SCAN = 399,   // Target: Point.
         EFFECT_SHADOWSTRIDE = 2700,  // Target: Point.
@@ -673,6 +676,7 @@ namespace sc2 {
         TRAIN_MARAUDER = 563,   // Target: None.
         TRAIN_MARINE = 560,   // Target: None.
         TRAIN_MEDIVAC = 620,   // Target: None.
+        TRAIN_MOTHERSHIP = 110,  // Target: None.
         TRAIN_MOTHERSHIPCORE = 1853,  // Target: None.
         TRAIN_MUTALISK = 1346,  // Target: None.
         TRAIN_OBSERVER = 977,   // Target: None.

src/sc2api/sc2_client.cc

@@ -1429,14 +1429,17 @@ class ControlImp : public ControlInterface {
 
     void DumpProtoUsage() override;
 
-    void ResolveMap (const std::string& map_name, SC2APIProtocol::RequestCreateGame* request);
+    void ResolveMap(const std::string& map_name, SC2APIProtocol::RequestCreateGame* request);
 
     const std::vector<ClientError>& GetClientErrors() const final { return client_errors_; };
     const std::vector<std::string>& GetProtocolErrors() const final { return protocol_errors_; };
 
     void ClearClientErrors() override { client_errors_.clear(); };
     void ClearProtocolErrors() override { protocol_errors_.clear(); };
     void UseGeneralizedAbility(bool value) override { observation_imp_->use_generalized_ability_ = value; };
+
+    virtual void Save();
+    virtual void Load();
 };
 
 ControlImp::ControlImp(Client& client) :
@@ -2213,6 +2216,24 @@ void ControlImp::DumpProtoUsage() {
     std::cout << "******************************************************" << std::endl;
 }
 
+void ControlImp::Save() {
+    GameRequestPtr request = Proto().MakeRequest();
+    request->mutable_quick_save();
+    if (!Proto().SendRequest(request)) {
+        return;
+    }
+    WaitForResponse();
+}
+
+void ControlImp::Load() {
+    GameRequestPtr request = Proto().MakeRequest();
+    request->mutable_quick_load();
+    if (!Proto().SendRequest(request)) {
+        return;
+    }
+    WaitForResponse();
+}
+
 //-------------------------------------------------------------------------------------------------
 // Client
 //-------------------------------------------------------------------------------------------------
@@ -2270,4 +2291,8 @@ bool IsCarryingVespene(const Unit& unit) {
     return std::find_if(unit.buffs.begin(), unit.buffs.end(), is_vespene) != unit.buffs.end();
 }
 
+bool IsVisible::operator()(const Unit& unit) {
+    return unit.display_type == Unit::Visible;
+};
+
 }

src/sc2api/sc2_typeenums.cc

@@ -67,6 +67,7 @@ namespace sc2 {
         case UNIT_TYPEID::PROTOSS_FLEETBEACON:              return "PROTOSS_FLEETBEACON"; // 337
         case UNIT_TYPEID::PROTOSS_TWILIGHTCOUNCIL:          return "PROTOSS_TWILIGHTCOUNCIL"; // 1677
         case UNIT_TYPEID::PROTOSS_PHOTONCANNON:             return "PROTOSS_PHOTONCANNON"; // 8601
+        case UNIT_TYPEID::PROTOSS_SHIELDBATTERY:            return "PROTOSS_SHIELDBATTERY"; // 8601
         case UNIT_TYPEID::PROTOSS_STARGATE:                 return "PROTOSS_STARGATE"; // 2286
         case UNIT_TYPEID::PROTOSS_TEMPLARARCHIVE:           return "PROTOSS_TEMPLARARCHIVE"; // 342
         case UNIT_TYPEID::PROTOSS_DARKSHRINE:               return "PROTOSS_DARKSHRINE"; // 408
@@ -391,6 +392,7 @@ namespace sc2 {
         case ABILITY_ID::BUILD_FLEETBEACON:                 return "BUILD_FLEETBEACON"; // 130
         case ABILITY_ID::BUILD_TWILIGHTCOUNCIL:             return "BUILD_TWILIGHTCOUNCIL"; // 486
         case ABILITY_ID::BUILD_PHOTONCANNON:                return "BUILD_PHOTONCANNON"; // 2895
+        case ABILITY_ID::BUILD_SHIELDBATTERY:               return "BUILD_SHIELDBATTERY";
         case ABILITY_ID::BUILD_STARGATE:                    return "BUILD_STARGATE"; // 791
         case ABILITY_ID::BUILD_TEMPLARARCHIVE:              return "BUILD_TEMPLARARCHIVE"; // 167
         case ABILITY_ID::BUILD_DARKSHRINE:                  return "BUILD_DARKSHRINE"; // 165
@@ -565,6 +567,7 @@ namespace sc2 {
         case ABILITY_ID::CANCEL_MORPHMOTHERSHIP:            return "CANCEL_MORPHMOTHERSHIP"; // 5
         case ABILITY_ID::TRAIN_MOTHERSHIPCORE:              return "TRAIN_MOTHERSHIPCORE"; // 869
         case ABILITY_ID::EFFECT_MASSRECALL_MOTHERSHIPCORE:  return "EFFECT_MASSRECALL_MOTHERSHIPCORE"; // 46
+        case ABILITY_ID::TRAIN_MOTHERSHIP:                  return "TRAIN_MOTHERSHIP"; 
         case ABILITY_ID::MORPH_HELLION:                     return "MORPH_HELLION"; // 31
         case ABILITY_ID::MORPH_HELLBAT:                     return "MORPH_HELLBAT"; // 325
         case ABILITY_ID::BURROWDOWN_SWARMHOST:              return "BURROWDOWN_SWARMHOST"; // 19
@@ -654,6 +657,7 @@ namespace sc2 {
         case ABILITY_ID::EFFECT_REPAIR:                     return "EFFECT_REPAIR"; // 1
         case ABILITY_ID::EFFECT_MASSRECALL:                 return "EFFECT_MASSRECALL"; // 1
         case ABILITY_ID::EFFECT_BLINK:                      return "EFFECT_BLINK"; // 1
+        case ABILITY_ID::EFFECT_RESTORE:                    return "EFFECT_RESTORE"; // 1
         case ABILITY_ID::BEHAVIOR_HOLDFIREON:               return "BEHAVIOR_HOLDFIREON"; // 1
         case ABILITY_ID::BEHAVIOR_HOLDFIREOFF:              return "BEHAVIOR_HOLDFIREOFF"; // 1
         case ABILITY_ID::RALLY_WORKERS:                     return "RALLY_WORKERS"; // 1

src/sc2utils/sc2_manage_process.cc

@@ -20,6 +20,7 @@
 #include <string>
 #include <codecvt>
 #include <locale>
+#include <cstring>
 
 #elif defined(__APPLE__)
 

tests/test_rendered.cc

@@ -117,7 +117,7 @@ bool TestRendered(int argc, char** argv) {
     coordinator.SetRender(settings);
 
 #if defined(__linux__)
-    coordinator.AddCommandLine("-eglpath /usr/lib/nvidia-367/libEGL.so");
+    coordinator.AddCommandLine("-eglpath libEGL.so");
 #endif
 
     // Add the custom bot, it will control the players.
@@ -139,4 +139,4 @@ bool TestRendered(int argc, char** argv) {
     return bot.Success();
 }
 
-}
+}