sc2ai 0.1.0 → 0.3.0

data/lib/sc2ai/unit_group/action_ext.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "sc2ai/unit_group"
-
 module Sc2
   # A set of action related tasks for unit groups
   class UnitGroup

data/lib/sc2ai/unit_group/filter_ext.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "sc2ai/unit_group"
 require "kdtree"
 
 module Sc2
@@ -118,7 +117,7 @@ module Sc2
     #   structures.not.creep_tumors #=> all structures
     #   structures.not.pylons #=>
     #   units.not.workers # equivalent of units.army, but works too
-    # @return [Sc2::UnitGroupNotSelector]
+    # @return [Sc2::UnitGroup::UnitGroupNotSelector]
     def not
       UnitGroupNotSelector.new(self)
     end
@@ -128,6 +127,8 @@ module Sc2
     class UnitGroupNotSelector < UnitGroup
       attr_accessor :parent
 
+      # @param unit_group [Sc2::UnitGroup]
+      # @return [UnitGroupNotSelector]
       def initialize(unit_group)
         @parent = unit_group
         super
@@ -150,10 +151,10 @@ module Sc2
     # Multiple values work as an "AND" filter
     # @example
     #   # Single
-    #   ug.select_attribute(Api::Attribute::Structure) #=> <UnitGroup: ...>
+    #   ug.select_attribute(Api::Attribute::STRUCTURE) #=> <UnitGroup: ...>
     #   ug.select_attribute(:Structure) #=> <UnitGroup: ...>
     #   # Multiple - select mechanical flying units
-    #   ug.select_attribute([:Mechanical, :Flying]) #=> <UnitGroup: ...>
+    #   ug.select_attribute([:MECHANICAL, :FLYING]) #=> <UnitGroup: ...>
     # @param attributes [Integer, Array<Integer>] one or an array of unit Api::UnitTypeId
     # @return [UnitGroup]
     def select_attribute(attributes)
@@ -170,7 +171,7 @@ module Sc2
     # Multiple values work as an "AND" filter
     # @example
     #   # Single
-    #   ug.reject_attribute(Api::Attribute::Structure) #=> <UnitGroup: ...>
+    #   ug.reject_attribute(Api::Attribute::STRUCTURE) #=> <UnitGroup: ...>
     #   ug.reject_attribute(:Structure) #=> <UnitGroup: ...>
     #   # Multiple - reject mechanical flying units
     #   ug.reject_attribute(:Mechanical, :Flying) #=> <UnitGroup: ...>
@@ -188,6 +189,15 @@ module Sc2
 
     # GENERICS ---
 
+    # Selects units you own
+    # i.e. @bot.all_units.owned # => Units you own
+    # @return [Sc2::UnitGroup] workers
+    def owned
+      cached("#{__method__}:SELF") do
+        select { |unit| unit.alliance == :SELF }
+      end
+    end
+
     # Selects worker units
     # @return [Sc2::UnitGroup] workers
     def workers
@@ -207,7 +217,7 @@ module Sc2
     # Selects units with attribute Structure
     # @return [Sc2::UnitGroup] structures
     def structures
-      select_attribute(Api::Attribute::Structure)
+      select_attribute(Api::Attribute::STRUCTURE)
     end
 
     # Contains an array non-army types
@@ -261,7 +271,7 @@ module Sc2
       select(&:is_idle?)
     end
 
-    # Selects units which have this ability available\
+    # Selects units which have this ability available
     # Queries API if necessary
     # @param [Integer] ability_id
     # @return [UnitGroup] units which have the ability available
@@ -269,6 +279,12 @@ module Sc2
       select { |unit| unit.ability_available?(ability_id) }
     end
 
+    # Checks whether any unit's first order matches these abilities
+    # @param ability_ids [Integer, Array<Integer>] accepts one or an array of Api::AbilityId
+    def is_performing_ability?(ability_ids)
+      any? { |unit| unit.is_performing_ability?(ability_ids) }
+    end
+
     # NEUTRAL ------------------------------------------
 
     # Selects mineral fields
@@ -390,7 +406,7 @@ module Sc2
     attr_accessor :use_kdtree
 
     # Builds a kdtree if not already built and returns it
-    # @return [Kdtree]
+    # @return [::Kdtree]
     def kdtree
       return @kdtree unless @kdtree.nil?
       @kdtree = Kdtree.new(@units.values.each_with_index.map { |unit, index| [unit.pos.x, unit.pos.y, index] })

data/lib/sc2ai/unit_group/geo_ext.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "sc2ai/unit_group"
-
 module Sc2
   # A set geometric/map/math methods for unit group
   class UnitGroup

data/lib/sc2ai/unit_group.rb

@@ -18,7 +18,7 @@ module Sc2
     def initialize(units = nil)
       @units = {}
       case units
-      when Array, Google::Protobuf::RepeatedField
+      when Array
         units.each do |unit|
           @units[unit.tag] = unit
         end

data/lib/sc2ai/version.rb

@@ -1,6 +1,5 @@
-# frozen_string_literal: true
-
 module Sc2
   # gem version
-  VERSION = "0.1.0"
+  # @return [String]
+  VERSION = "0.3.0"
 end

data/lib/sc2ai.rb

@@ -38,20 +38,16 @@ Dir.glob(File.join(__dir__, "sc2ai", "overrides", "**", "*.rb")).each do |file|
   require(file)
 end
 
-# Protobuf internals don't allow sharing enums in the same package,
-#  so Blizzard under_scored some names. This throws errors when defining constants
-#  during packing/unpacking, because they dont start capitalized, so we silence temporarily.
-silence_warnings do
-  require "rumale"
-  require_relative "sc2ai/protocol/sc2api_pb"
-end
+require "rumale"
+
 # noinspection RubyMismatchedArgumentType
-Dir[File.join(__dir__, "sc2ai", "*.rb")].each { |file| require(file) }
-# The upper include can probably preload everything it needs
+Dir[File.join(__dir__, "sc2ai", "protocol", "*.rb")].sort.each { |file| require(file) }
 # noinspection RubyMismatchedArgumentType
-Dir[File.join(__dir__, "sc2ai", "protocol", "extensions", "**", "*.rb")].each { |file| require(file) }
+Dir[File.join(__dir__, "sc2ai", "protocol", "extensions", "*.rb")].sort.each { |file| require(file) }
 # noinspection RubyMismatchedArgumentType
-Dir[File.join(__dir__, "sc2ai", "local_play", "**", "*.rb")].each { |file| require(file) }
+Dir[File.join(__dir__, "sc2ai", "*.rb")].sort.each { |file| require(file) }
+# noinspection RubyMismatchedArgumentType
+Dir[File.join(__dir__, "sc2ai", "local_play", "**", "*.rb")].sort.each { |file| require(file) }
 
 # Facilitates StarCraft 2 AI
 module Sc2
@@ -61,6 +57,7 @@ module Sc2
   class << self
     # Instantiate the Configuration singleton or return it.
     # Remember that the instance has attribute readers so that we can access the configured values
+    # @return [Sc2::Configuration]
     def config
       @config ||= Configuration.new
       yield @config if block_given?
@@ -81,6 +78,8 @@ module Sc2
 
       @logger = Logger.new($stdout)
       @logger.level = :debug
+      @logger.datetime_format = "%H:%M:%S.%6N"
+
       @logger
     end
 

data/lib/templates/ladderzip/bin/ladder.tt

@@ -15,9 +15,6 @@ export RUBY_GC_HEAP_INIT_SIZE_160_SLOTS=18000
 export RUBY_GC_HEAP_INIT_SIZE_320_SLOTS=2000
 export RUBY_GC_HEAP_INIT_SIZE_640_SLOTS=1000
 
-# Maxime <3
-export RUBY_YJIT_ENABLE=true
-
 export AIARENA=true
 sc2ai ladderconfig
 exec sc2ai laddermatch "$@" 1>&2

data/lib/templates/new/.ladderignore

@@ -5,16 +5,26 @@
 *.proto
 *.zip
 
-
 # Gem-specific ignores
 .build/
 data/debug_observation.json
+run_example_match.rb
 
-# Other
-.idea/
-vendor/bundle
+# Generic ruby gitignores
+*.gem
+*.rbc
+.config
+coverage/
+pkg/
 spec/
 test/
+tmp/
+.byebug_history
+.bundle/
+vendor/bundle
+lib/bundler/man/
 
-# My ignores
+# Other
+.idea/
+.vscode/
 

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

@@ -1,5 +1,5 @@
 
-syntax = "proto2";
+syntax = "proto3";
 
 package Api;
 
@@ -49,11 +49,11 @@ message Size2DI {
 }
 
 enum Race {
-  NoRace = 0;
-  Terran = 1;
-  Zerg = 2;
-  Protoss = 3;
-  Random = 4;
+  NO_RACE = 0;
+  TERRAN = 1;
+  ZERG = 2;
+  PROTOSS = 3;
+  RANDOM = 4;
 }
 
 

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

@@ -1,5 +1,5 @@
 
-syntax = "proto2";
+syntax = "proto3";
 
 package Api;
 
@@ -19,11 +19,12 @@ message AbilityData {
   optional uint32 remaps_to_ability_id = 7;                       // This ability id may be represented by the given more generic id.
 
   enum Target {
-    None = 1;                                                     // Does not require a target.
-    Point = 2;                                                    // Requires a target position.
-    Unit = 3;                                                     // Requires a unit to target. Given by position using feature layers.
-    PointOrUnit = 4;                                              // Requires either a target point or target unit.
-    PointOrNone = 5;                                              // Requires either a target point or no target. (eg. building add-ons)
+    ENUM_TARGET_UNSET = 0; // PROTO3 COMPAT
+    NONE = 1;                                                     // DOES NOT REQUIRE A TARGET.
+    POINT = 2;                                                    // REQUIRES A TARGET POSITION.
+    UNIT = 3;                                                     // REQUIRES A UNIT TO TARGET. GIVEN BY POSITION USING FEATURE LAYERS.
+    POINT_OR_UNIT = 4;                                              // REQUIRES EITHER A TARGET POINT OR TARGET UNIT.
+    POINT_OR_NONE = 5;                                              // REQUIRES EITHER A TARGET POINT OR NO TARGET. (EG. BUILDING ADD_ONS)
   }
 
   optional bool available = 8;                                    // If true, the ability may be used by this set of mods/map.
@@ -37,17 +38,18 @@ message AbilityData {
 }
 
 enum Attribute {
-  Light = 1;
-  Armored = 2;
-  Biological = 3;
-  Mechanical = 4;
-  Robotic = 5;
-  Psionic = 6;
-  Massive = 7;
-  Structure = 8;
-  Hover = 9;
-  Heroic = 10;
-  Summoned = 11;
+  ENUM_ATTRIBUTE_UNSET = 0; // PROTO3 COMPAT
+  LIGHT = 1;
+  ARMORED = 2;
+  BIOLOGICAL = 3;
+  MECHANICAL = 4;
+  ROBOTIC = 5;
+  PSIONIC = 6;
+  MASSIVE = 7;
+  STRUCTURE = 8;
+  HOVER = 9;
+  HEROIC = 10;
+  SUMMONED = 11;
 }
 
 message DamageBonus {
@@ -57,9 +59,10 @@ message DamageBonus {
 
 message Weapon {
   enum TargetType {
-    Ground = 1;
-    Air = 2;
-    Any = 3;
+    ENUM_TARGET_TYPE_UNSET = 0; // PROTO3 COMPAT
+    GROUND = 1;
+    AIR = 2;
+    ANY = 3;
   }
   optional TargetType type = 1;
   optional float damage = 2;

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

@@ -1,5 +1,5 @@
 
-syntax = "proto2";
+syntax = "proto3";
 
 package Api;
 
@@ -67,18 +67,19 @@ message DebugSphere {
 }
 
 enum DebugGameState {
-  show_map = 1;
-  control_enemy = 2;
-  food = 3;
-  free = 4;
-  all_resources = 5;
-  god = 6;
-  minerals = 7;
-  gas = 8;
-  cooldown = 9;
-  tech_tree = 10;
-  upgrade = 11;
-  fast_build = 12;
+  ENUM_DEBUG_GAME_STATE_UNSET = 0; // PROTO3 COMPAT
+  SHOW_MAP = 1;
+  CONTROL_ENEMY = 2;
+  FOOD = 3;
+  FREE = 4;
+  ALL_RESOURCES = 5;
+  GOD = 6;
+  MINERALS = 7;
+  GAS = 8;
+  COOLDOWNS = 9;
+  TECH_TREE = 10;
+  UPGRADE = 11;
+  FAST_BUILD = 12;
 }
 
 message DebugCreateUnit {
@@ -94,9 +95,10 @@ message DebugKillUnit {
 
 message DebugTestProcess {
   enum Test {
-    hang = 1;
-    crash = 2;
-    exit = 3;
+    ENUM_TEST_UNSET = 0; // PROTO3 COMPAT
+    HANG = 1;
+    CRASH = 2;
+    EXIT = 3;
   }
   optional Test test = 1;
   optional int32 delay_ms = 2;
@@ -108,17 +110,19 @@ message DebugSetScore {
 
 message DebugEndGame {
   enum EndResult {
-    Surrender = 1;                  // Default if nothing is set. The current player admits defeat.
-    DeclareVictory = 2;
+    ENUM_END_RESULT_UNSET = 0; // PROTO3 COMPAT
+    SURRENDER = 1;             // DEFAULT IF NOTHING IS SET. THE CURRENT PLAYER ADMITS DEFEAT.
+    DECLARE_VICTORY = 2;
   }
   optional EndResult end_result = 1;
 }
 
 message DebugSetUnitValue {
   enum UnitValue {
-    Energy = 1;
-    Life = 2;
-    Shields = 3;
+    ENUM_UNIT_VALUE_UNSET = 0; // PROTO3 COMPAT
+    ENERGY = 1;
+    LIFE = 2;
+    SHIELDS = 3;
   }
   optional UnitValue unit_value = 1;
   optional float value = 2;