sc2ai 0.1.0 → 0.3.0

data/lib/templates/new/api/sc2api.proto

@@ -1,5 +1,5 @@
 
-syntax = "proto2";
+syntax = "proto3";
 
 package Api;
 
@@ -155,13 +155,14 @@ message Response {
 }
 
 enum Status {
-  launched = 1;                                 // Game has been launch and is not yet doing anything.
-  init_game = 2;                                // Create game has been called, and the host is awaiting players.
-  in_game = 3;                                  // In a single or multiplayer game.
-  in_replay = 4;                                // In a replay.
-  ended = 5;                                    // Game has ended, can still request game info, but ready for a new game.
-  quit = 6;                                     // Application is shutting down.
-  unknown = 99;                                 // Should not happen, but indicates an error if it occurs.
+  ENUM_STATUS_UNSET = 0; // PROTO3 COMPAT
+  LAUNCHED = 1;                                 // GAME HAS BEEN LAUNCH AND IS NOT YET DOING ANYTHING.
+  INIT_GAME = 2;                                // CREATE GAME HAS BEEN CALLED, AND THE HOST IS AWAITING PLAYERS.
+  IN_GAME = 3;                                  // IN A SINGLE OR MULTIPLAYER GAME.
+  IN_REPLAY = 4;                                // IN A REPLAY.
+  ENDED = 5;                                    // GAME HAS ENDED, CAN STILL REQUEST GAME INFO, BUT READY FOR A NEW GAME.
+  QUIT = 6;                                     // APPLICATION IS SHUTTING DOWN.
+  UNKNOWN = 99;                                 // SHOULD NOT HAPPEN, BUT INDICATES AN ERROR IF IT OCCURS.
 }
 
 //-----------------------------------------------------------------------------
@@ -191,14 +192,15 @@ message LocalMap {
 
 message ResponseCreateGame {
   enum Error {
-    MissingMap = 1;
-    InvalidMapPath = 2;
-    InvalidMapData = 3;
-    InvalidMapName = 4;
-    InvalidMapHandle = 5;
-    MissingPlayerSetup = 6;
-    InvalidPlayerSetup = 7;
-    MultiplayerUnsupported = 8;                     // Multiplayer is not supported in the current build.
+    ENUM_RESPONSE_CREATE_GAME_ERROR_UNSET = 0; // PROTO3 COMPAT
+    MISSING_MAP = 1;
+    INVALID_MAP_PATH = 2;
+    INVALID_MAP_DATA = 3;
+    INVALID_MAP_NAME = 4;
+    INVALID_MAP_HANDLE = 5;
+    MISSING_PLAYER_SETUP = 6;
+    INVALID_PLAYER_SETUP = 7;
+    MULTIPLAYER_UNSUPPORTED = 8;                     // MULTIPLAYER IS NOT SUPPORTED IN THE CURRENT BUILD.
   }
   optional Error error = 1;
   optional string error_details = 2;
@@ -231,21 +233,22 @@ message ResponseJoinGame {
   optional uint32 player_id = 1;
 
   enum Error {
-    MissingParticipation = 1;
-    InvalidObservedPlayerId = 2;
-    MissingOptions = 3;
-    MissingPorts = 4;
-    GameFull = 5;
-    LaunchError = 6;
-
-    // Multiplayer specific.
-    FeatureUnsupported = 7;                 // Multiplayer is not supported in the current build for the requested features.
-    NoSpaceForUser = 8;
-    MapDoesNotExist = 9;
-    CannotOpenMap = 10;
-    ChecksumError = 11;
-    NetworkError = 12;
-    OtherError = 13;
+    ENUM_RESPONSE_JOIN_GAME_ERROR_UNSET = 0; // PROTO3 COMPAT
+    MISSING_PARTICIPATION = 1;
+    INVALID_OBSERVED_PLAYER_ID = 2;
+    MISSING_OPTIONS = 3;
+    MISSING_PORTS = 4;
+    GAME_FULL = 5;
+    LAUNCH_ERROR = 6;
+
+    // MULTIPLAYER SPECIFIC.
+    FEATURE_UNSUPPORTED = 7;                 // MULTIPLAYER IS NOT SUPPORTED IN THE CURRENT BUILD FOR THE REQUESTED FEATURES.
+    NO_SPACE_FOR_USER = 8;
+    MAP_DOES_NOT_EXIST = 9;
+    CANNOT_OPEN_MAP = 10;
+    CHECKSUM_ERROR = 11;
+    NETWORK_ERROR = 12;
+    OTHER_ERROR = 13;
   }
   optional Error error = 2;
   optional string error_details = 3;
@@ -258,7 +261,8 @@ message RequestRestartGame {
 // The defaultRestartGameLoops is specified to be (1<<18) by default
 message ResponseRestartGame {
   enum Error {
-    LaunchError = 1;
+    ENUM_RESPONSE_RESTART_GAME_ERROR_UNSET = 0; // PROTO3 COMPAT
+    LAUNCH_ERROR = 1;
   }
   optional Error error = 1;
   optional string error_details = 2;
@@ -282,13 +286,14 @@ message RequestStartReplay {
 
 message ResponseStartReplay {
   enum Error {
-    MissingReplay = 1;
-    InvalidReplayPath = 2;
-    InvalidReplayData = 3;
-    InvalidMapData = 4;
-    InvalidObservedPlayerId = 5;
-    MissingOptions = 6;
-    LaunchError = 7;
+    ENUM_RESPONSE_START_REPLAY_ERROR_UNSET = 0; // PROTO3 COMPAT
+    MISSING_REPLAY = 1;
+    INVALID_REPLAY_PATH = 2;
+    INVALID_REPLAY_DATA = 3;
+    INVALID_MAP_DATA = 4;
+    INVALID_OBSERVED_PLAYER_ID = 5;
+    MISSING_OPTIONS = 6;
+    LAUNCH_ERROR = 7;
   }
   optional Error error = 1;
   optional string error_details = 2;
@@ -301,7 +306,8 @@ message RequestMapCommand {
 
 message ResponseMapCommand {
   enum Error {
-    NoTriggerError = 1;
+    ENUM_RESPONSE_MAP_COMMAND_ERROR_UNSET = 0; // PROTO3 COMPAT
+    NO_TRIGGER_ERROR = 1;
   }
   optional Error error = 1;
   optional string error_details = 2;
@@ -343,11 +349,11 @@ message RequestGameInfo {
 
 message ResponseGameInfo {
   optional string map_name = 1;
-  repeated string mod_names = 6;
   optional string local_map_path = 2;
   repeated PlayerInfo player_info = 3;
   optional StartRaw start_raw = 4;               // Populated if Raw interface is enabled.
   optional InterfaceOptions options = 5;
+  repeated string mod_names = 6;
 }
 
 //-----------------------------------------------------------------------------
@@ -453,11 +459,12 @@ message ResponseReplayInfo {
   optional uint32 base_build = 8;
 
   enum Error {
-    MissingReplay = 1;
-    InvalidReplayPath = 2;
-    InvalidReplayData = 3;
-    ParsingError = 4;
-    DownloadError = 5;
+    ENUM_RESPONSE_REPLAY_INFO_ERROR_UNSET = 0; // PROTO3 COMPAT
+    MISSING_REPLAY = 1;
+    INVALID_REPLAY_PATH = 2;
+    INVALID_REPLAY_DATA = 3;
+    PARSING_ERROR = 4;
+    DOWNLOAD_ERROR = 5;
   }
   optional Error error = 9;
   optional string error_details = 10;
@@ -484,7 +491,8 @@ message RequestSaveMap {
 
 message ResponseSaveMap {
   enum Error {
-    InvalidMapData = 1;
+    ENUM_RESPONSE_SAVE_MAP_ERROR_UNSET = 0; // PROTO3 COMPAT
+    INVALID_MAP_DATA = 1;
   }
   optional Error error = 1;
 }
@@ -514,31 +522,34 @@ message ResponseDebug {
 //
 
 enum Difficulty {
-  VeryEasy = 1;
-  Easy = 2;
-  Medium = 3;
-  MediumHard = 4;
-  Hard = 5;
-  Harder = 6;
-  VeryHard = 7;
-  CheatVision = 8;
-  CheatMoney = 9;
-  CheatInsane = 10;
+  ENUM_DIFFICULTY_UNSET = 0; // PROTO3 COMPAT
+  VERY_EASY = 1;
+  EASY = 2;
+  MEDIUM = 3;
+  MEDIUM_HARD = 4;
+  HARD = 5;
+  HARDER = 6;
+  VERY_HARD = 7;
+  CHEAT_VISION = 8;
+  CHEAT_MONEY = 9;
+  CHEAT_INSANE = 10;
 }
 
 enum PlayerType {
-  Participant = 1;
-  Computer = 2;
-  Observer = 3;
+  ENUM_PLAYER_TYPE_UNSET = 0; // PROTO3 COMPAT
+  PARTICIPANT = 1;
+  COMPUTER = 2;
+  OBSERVER = 3;
 }
 
 enum AIBuild {
-  RandomBuild = 1;
-  Rush = 2;
-  Timing = 3;
-  Power = 4;
-  Macro = 5;
-  Air = 6;
+  ENUM_AI_BUILD_UNSET = 0; // PROTO3 COMPAT
+  RANDOM_BUILD = 1;
+  RUSH = 2;
+  TIMING = 3;
+  POWER = 4;
+  MACRO = 5;
+  AIR = 6;
 }
 
 message PlayerSetup {
@@ -638,8 +649,9 @@ message Action {
 
 message ActionChat {
   enum Channel {
-    Broadcast = 1;
-    Team = 2;
+    ENUM_CHANNEL_UNSET = 0; // PROTO3 COMPAT
+    BROADCAST = 1;
+    TEAM = 2;
   }
   optional Channel channel = 1;
   optional string message = 2;
@@ -681,35 +693,37 @@ message ActionObserverCameraFollowUnits {
 }
 
 enum Alert {
-  AlertError = 3;
-  AddOnComplete = 4;
-  BuildingComplete = 5;
-  BuildingUnderAttack = 6;
-  LarvaHatched = 7;
-  MergeComplete = 8;
-  MineralsExhausted = 9;
-  MorphComplete = 10;
-  MothershipComplete = 11;
-  MULEExpired = 12;
-  NuclearLaunchDetected = 1;
-  NukeComplete = 13;
-  NydusWormDetected = 2;
-  ResearchComplete = 14;
-  TrainError = 15;
-  TrainUnitComplete = 16;
-  TrainWorkerComplete = 17;
-  TransformationComplete = 18;
-  UnitUnderAttack = 19;
-  UpgradeComplete = 20;
-  VespeneExhausted = 21;
-  WarpInComplete = 22;
+  ENUM_ALERT_UNSET = 0; // PROTO3 COMPAT
+  ALERT_ERROR = 3;
+  ADD_ON_COMPLETE = 4;
+  BUILDING_COMPLETE = 5;
+  BUILDING_UNDER_ATTACK = 6;
+  LARVA_HATCHED = 7;
+  MERGE_COMPLETE = 8;
+  MINERALS_EXHAUSTED = 9;
+  MORPH_COMPLETE = 10;
+  MOTHERSHIP_COMPLETE = 11;
+  MULE_EXPIRED = 12;
+  NUCLEAR_LAUNCH_DETECTED = 1;
+  NUKE_COMPLETE = 13;
+  NYDUS_WORM_DETECTED = 2;
+  RESEARCH_COMPLETE = 14;
+  TRAIN_ERROR = 15;
+  TRAIN_UNIT_COMPLETE = 16;
+  TRAIN_WORKER_COMPLETE = 17;
+  TRANSFORMATION_COMPLETE = 18;
+  UNIT_UNDER_ATTACK = 19;
+  UPGRADE_COMPLETE = 20;
+  VESPENE_EXHAUSTED = 21;
+  WARP_IN_COMPLETE = 22;
 }
 
 enum Result {
-  Victory = 1;
-  Defeat = 2;
-  Tie = 3;
-  Undecided = 4;
+  ENUM_RESULT_UNSET = 0; // PROTO3 COMPAT
+  VICTORY = 1;
+  DEFEAT = 2;
+  TIE = 3;
+  UNDECIDED = 4;
 }
 
 message PlayerResult {

data/lib/templates/new/api/score.proto

@@ -1,12 +1,13 @@
 
-syntax = "proto2";
+syntax = "proto3";
 
 package Api;
 
 message Score {
   enum ScoreType {
-    Curriculum = 1;                // map generated score (from curriculum maps with special scoring)
-    Melee = 2;                     // summation of in-progress and current units/buildings value + minerals + vespene
+    ENUM_SCORE_TYPE_UNSET = 0; // PROTO3 COMPAT
+    CURRICULUM = 1;                // MAP GENERATED SCORE (FROM CURRICULUM MAPS WITH SPECIAL SCORING)
+    MELEE = 2;                     // SUMMATION OF IN_PROGRESS AND CURRENT UNITS/BUILDINGS VALUE + MINERALS + VESPENE
   }
 
   optional ScoreType score_type = 6;

data/lib/templates/new/api/spatial.proto

@@ -1,5 +1,5 @@
 
-syntax = "proto2";
+syntax = "proto3";
 
 package Api;
 
@@ -101,10 +101,11 @@ message ActionSpatialCameraMove {
 message ActionSpatialUnitSelectionPoint {
   optional PointI selection_screen_coord = 1;
   enum Type {
-    Select = 1;         // Equivalent to normal click. Changes selection to unit.
-    Toggle = 2;         // Equivalent to shift+click. Toggle selection of unit.
-    AllType = 3;        // Equivalent to control+click. Selects all units of a given type.
-    AddAllType = 4;     // Equivalent to shift+control+click. Selects all units of a given type.
+    ENUM_ACTION_SPATIAL_UNIT_SELECTION_POINT_TYPE_UNSET = 0; // PROTO3 COMPAT
+    SELECT = 1;         // EQUIVALENT TO NORMAL CLICK. CHANGES SELECTION TO UNIT.
+    TOGGLE = 2;         // EQUIVALENT TO SHIFT+CLICK. TOGGLE SELECTION OF UNIT.
+    ALL_TYPE = 3;        // EQUIVALENT TO CONTROL+CLICK. SELECTS ALL UNITS OF A GIVEN TYPE.
+    ADD_ALL_TYPE = 4;     // EQUIVALENT TO SHIFT+CONTROL+CLICK. SELECTS ALL UNITS OF A GIVEN TYPE.
   }
   optional Type type = 2;
 }

data/lib/templates/new/api/ui.proto

@@ -1,5 +1,5 @@
 
-syntax = "proto2";
+syntax = "proto3";
 
 package Api;
 
@@ -90,11 +90,12 @@ message ActionUI {
 
 message ActionControlGroup {
   enum ControlGroupAction {
-    Recall = 1;             // Equivalent to number hotkey. Replaces current selection with control group.
-    Set = 2;                // Equivalent to Control + number hotkey. Sets control group to current selection.
-    Append = 3;             // Equivalent to Shift + number hotkey. Adds current selection into control group.
-    SetAndSteal = 4;        // Equivalent to Control + Alt + number hotkey. Sets control group to current selection. Units are removed from other control groups.
-    AppendAndSteal = 5;     // Equivalent to Shift + Alt + number hotkey. Adds current selection into control group. Units are removed from other control groups.
+    ENUM_CONTROL_GROUP_ACTION_UNSET = 0; // PROTO3 COMPAT
+    RECALL = 1;             // EQUIVALENT TO NUMBER HOTKEY. REPLACES CURRENT SELECTION WITH CONTROL GROUP.
+    SET = 2;                // EQUIVALENT TO CONTROL + NUMBER HOTKEY. SETS CONTROL GROUP TO CURRENT SELECTION.
+    APPEND = 3;             // EQUIVALENT TO SHIFT + NUMBER HOTKEY. ADDS CURRENT SELECTION INTO CONTROL GROUP.
+    SET_AND_STEAL = 4;        // EQUIVALENT TO CONTROL + ALT + NUMBER HOTKEY. SETS CONTROL GROUP TO CURRENT SELECTION. UNITS ARE REMOVED FROM OTHER CONTROL GROUPS.
+    APPEND_AND_STEAL = 5;     // EQUIVALENT TO SHIFT + ALT + NUMBER HOTKEY. ADDS CURRENT SELECTION INTO CONTROL GROUP. UNITS ARE REMOVED FROM OTHER CONTROL GROUPS.
   }
   optional ControlGroupAction action = 1;
   optional uint32 control_group_index = 2;
@@ -113,20 +114,22 @@ message ActionSelectLarva {
 
 message ActionSelectIdleWorker {
   enum Type {
-    Set = 1;        // Equivalent to click with no modifiers. Replaces selection with single idle worker.
-    Add = 2;        // Equivalent to shift+click. Adds single idle worker to current selection.
-    All = 3;        // Equivalent to control+click. Selects all idle workers.
-    AddAll = 4;     // Equivalent to shift+control+click. Adds all idle workers to current selection.
+    ENUM_ACTION_SELECT_IDLE_WORKER_TYPE_UNSET = 0; // PROTO3 COMPAT
+    SET = 1;        // EQUIVALENT TO CLICK WITH NO MODIFIERS. REPLACES SELECTION WITH SINGLE IDLE WORKER.
+    ADD = 2;        // EQUIVALENT TO SHIFT+CLICK. ADDS SINGLE IDLE WORKER TO CURRENT SELECTION.
+    ALL = 3;        // EQUIVALENT TO CONTROL+CLICK. SELECTS ALL IDLE WORKERS.
+    ADD_ALL = 4;     // EQUIVALENT TO SHIFT+CONTROL+CLICK. ADDS ALL IDLE WORKERS TO CURRENT SELECTION.
   }
   optional Type type = 1;
 }
 
 message ActionMultiPanel {
   enum Type {
-    SingleSelect = 1;         // Click on icon
-    DeselectUnit = 2;         // Shift Click on icon
-    SelectAllOfType = 3;      // Control Click on icon.
-    DeselectAllOfType = 4;    // Control+Shift Click on icon.
+    ENUM_ACTION_MULTI_PANEL_TYPE_UNSET = 0; // PROTO3 COMPAT
+    SINGLE_SELECT = 1;         // CLICK ON ICON
+    DESELECT_UNIT = 2;         // SHIFT CLICK ON ICON
+    SELECT_ALL_OF_TYPE = 3;      // CONTROL CLICK ON ICON.
+    DESELECT_ALL_OF_TYPE = 4;    // CONTROL+SHIFT CLICK ON ICON.
   }
   optional Type type = 1;
   optional int32 unit_index = 2;

data/lib/templates/new/boot.rb.tt

@@ -3,4 +3,4 @@
 # as $bot is created correctly. if not, your ladder bot will break.
 
 require_relative "<%= @bot_file %>"
-$bot = <%= @classname %>.new(name: "<%= @botname %>", race: Api::Race::<%= @race %>)
+$bot = <%= @classname %>.new(name: "<%= @botname %>", race: Api::Race::<%= @race.upcase %>)

data/lib/templates/new/my_bot.rb.tt

@@ -5,7 +5,7 @@ class <%= @classname %> < Sc2::Player::Bot
   def configure
     @realtime = false # Step-mode vs Bot, Realtime vs Humans
     @step_count = 2 # 2s/22.4 = ~89.29ms step cycle time allowance
-    @enable_feature_layer = false; # Enables ui_ and spatial_ actions. Advanced, and has performance cost.
+    @enable_feature_layer = false # Enables ui_ and spatial_ actions. Advanced, and has performance cost.
   end
 
   def on_step
@@ -15,7 +15,7 @@ class <%= @classname %> < Sc2::Player::Bot
 
     # If your attack fails, "good game" and exit
     if units.workers.size.zero?
-      action_chat("gg", channel: Api::ActionChat::Channel::Broadcast)
+      action_chat("gg", channel: Api::ActionChat::Channel::BROADCAST)
       leave_game
     end
   end

data/lib/templates/new/run_example_match.rb.tt

@@ -2,13 +2,13 @@
 require "./boot.rb"
 
 # Or simply, create by hand
-#my_bot = MyBot.new(name: "Botname", race: Api::Race::Random)
+#my_bot = MyBot.new(name: "Botname", race: Api::Race::RANDOM)
 
 # Start a match
 Sc2::Match.new(
   players: [
     $bot,
-    Sc2::Player::Computer.new(race: Api::Race::Random, difficulty: Api::Difficulty::VeryEasy)
+    Sc2::Player::Computer.new(race: Api::Race::RANDOM, difficulty: Api::Difficulty::VERY_EASY)
   ],
   map: "GoldenAura513AIE" # Or any of the downloaded map names
 ).run