sc2ai 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 482ef8f55c73a181336c147067712ddb0c6ef1212f9ac22d3dd319d250c817e8
-  data.tar.gz: a980d4bf7f21f5d6aec59bde8f6ef2bd8911d76ba3e4a77c40983265e1f8db26
+  metadata.gz: 7feb936b57c5b3e4c5cae670ea743f43ccb36a5111bf39abb88ad6e63702ffc5
+  data.tar.gz: 3b25e577bae3d33255f4e648fa69a8005e67af47e207cffdb7d0e2c790b86961
 SHA512:
-  metadata.gz: 80abb4253b9144a1a333d6859c8dc6b2e1bd0e47cda83a0d55256f40ba6d0129c62335cd4efdd67d139de9b533ce7ad406fc6beb60bb11e6833615504159b835
-  data.tar.gz: 0b733c21417ea8cf023aa94cb0cffc0e5a6482e3ba5cdb2b27cc2cd173dc0afea48acce70f73e4bce5b3f5713f73e52a5f4f19dc715c0fc3355e43f8ac441333
+  metadata.gz: 3c0d3dac4646702e85531561eb94d11ce8c5a5da53a255832a18803f34daad07f42958be0309f2b043a003581cdb5a9ac198b1326f13a93cd7a6f92211f75fa0
+  data.tar.gz: 43baa9be2700f945f0f9aed19c81b9bd77ee21df9fa43a151caa2b7d09646de17f2fe69814d8cfd0384e1644106123d01d96b2e34a413563411da41d5f67b0c1

data/data/sc2ai/protocol/raw.proto

@@ -46,7 +46,7 @@ message PowerSource {
 message PlayerRaw {
   repeated PowerSource power_sources = 1;
   optional Point camera = 2;
-  repeated uint32 upgrade_ids = 3;          // TODO: Add to UI observation?
+  repeated uint32 upgrade_ids = 3;
 }
 
 message UnitOrder {

data/data/sc2ai/protocol/ui.proto

@@ -52,7 +52,7 @@ message MultiPanel {
 message CargoPanel {
   optional UnitInfo unit = 1;
   repeated UnitInfo passengers = 2;
-  optional int32 slots_available = 3;       // TODO: Change to cargo size
+  optional int32 slots_available = 3;
 }
 
 message BuildItem {

data/lib/docker_build/Dockerfile.ruby

@@ -4,7 +4,7 @@ LABEL service="bot-ruby-local"
 USER root
 WORKDIR /root/ruby-builder
 
-ARG RUBY_VERSION=3.3.4
+ARG RUBY_VERSION=3.3.5
 ARG DEBIAN_DISABLE_RUBYGEMS_INTEGRATION=true
 
 # Deps - Ruby build

data/lib/sc2ai/cli/cli.rb

@@ -26,7 +26,7 @@ module Sc2
       say "Press any key to continue..."
       ask ""
 
-      say "You must accept the Blizzard® Starcraft® II AI and Machine Learning License at"
+      say "You must accept the Blizzard® StarCraft® II AI and Machine Learning License at"
       say "https://blzdistsc2-a.akamaihd.net/AI_AND_MACHINE_LEARNING_LICENSE.html"
       say "It is PERMISSIVE and grants you freedoms over the standard EULA."
       say "We do not record this action, but depend on software goverend by that license to continue."

data/lib/sc2ai/connection.rb

@@ -78,6 +78,7 @@ module Sc2
     # Add a listener of specific callback type
     # @param listener [Object]
     # @param klass [Module<Sc2::Connection::ConnectionListener>,Module<Sc2::Connection::StatusListener>]
+    # @return [void]
     def add_listener(listener, klass:)
       @listeners[klass.to_s] ||= []
       @listeners[klass.to_s].push(listener)

data/lib/sc2ai/local_play/client_manager.rb

@@ -53,6 +53,8 @@ module Sc2
       @clients[player_index] = nil
     end
 
+    # Stops all clients
+    # @return [void]
     def stop_all
       @clients.compact.each do |client|
         client.stop

data/lib/sc2ai/local_play/match.rb

@@ -10,17 +10,6 @@ module Sc2
     # Callback when game status changes
     def on_status_change(status)
       Sc2.logger.debug { "Status from Match: #{status}" }
-
-      # if status == :ended
-      #   # Go through each player, looking for result if we don't have one.
-      #   api_players.each do |player|
-      #     Sc2.logger.debug { "TODO: Get results for players" }
-      #     # result = player.result
-      #     Sc2.logger.debug { "Leaving Game and Disconnecting players" }
-      #     player.leave_game
-      #     player.disconnect
-      #   end
-      # end
     end
 
     # @!attribute players Sets the Player(s) for the match

data/lib/sc2ai/paths.rb

@@ -7,7 +7,7 @@ module Sc2
   # Helps determine common paths to sc2 install dir, executable and maps.
   # It maintains some semblance of compatibility with python-sc2 config
   #
-  # ENV['SC2PATH'] can be set manually to Starcraft 2 base directory for Linux
+  # ENV['SC2PATH'] can be set manually to StarCraft 2 base directory for Linux
   # ENV['SC2PF'] can and should be manually set to "WineLinux" when running Wine
   # Credit to Hannes, Sean and Burny for setting the standard
   class Paths

data/lib/sc2ai/player/{geometry.rb → geo.rb}

@@ -6,7 +6,7 @@ require "rumale/pairwise_metric"
 module Sc2
   class Player
     # Holds map and geography helper functions
-    class Geometry
+    class Geo
       # @!attribute bot
       #   @return [Sc2::Player] player with active connection
       attr_accessor :bot
@@ -98,7 +98,7 @@ module Sc2
         expo_placement_grid[y.to_i, x.to_i] == 1
       end
 
-      # Returns a grid where ony the expo locations are marked
+      # Returns a grid where only the expo locations are marked
       # @return [Numo::Bit]
       def expo_placement_grid
         if @expo_placement_grid.nil?
@@ -121,6 +121,42 @@ module Sc2
         @expo_placement_grid
       end
 
+      # Returns a grid where only placement obstructions are marked
+      # includes Tumors and lowered Supply Depots
+      # @return [Numo::Bit]
+      private def placement_obstruction_grid
+        # Get obstructing structures
+        obstructure_types = [Api::UnitTypeId::SUPPLYDEPOTLOWERED, Api::UnitTypeId::CREEPTUMORQUEEN, Api::UnitTypeId::CREEPTUMOR, Api::UnitTypeId::CREEPTUMORBURROWED]
+        obstructures = bot.structures.select_type(obstructure_types) + bot.enemy.structures.select_type(obstructure_types)
+        cache_key = obstructures.tags.sort.hash
+
+        # Return cache if obstructing structures haven't changed
+        if !@placement_obstruction_grid.nil? && @placement_obstruction_grid[1] == cache_key
+          return @placement_obstruction_grid[0]
+        end
+        map = Numo::Bit.zeros(map_height, map_width)
+
+        # Cache empty, if no obstructing structures
+        if obstructures.size.zero?
+          @placement_obstruction_grid = [map, cache_key]
+          return map
+        end
+
+        # For each obstructing structure, mark it's tiles with 1's
+        obstructures.each do |structure|
+          x = structure.pos.x.floor
+          y = structure.pos.y.floor
+
+          if structure.unit_type == Api::UnitTypeId::SUPPLYDEPOTLOWERED
+            map[(y - 1)..(y), (x - 1)..(x)] = 1
+          else
+            map[y, x] = 1
+          end
+        end
+        @placement_obstruction_grid = [map, cache_key]
+        map
+      end
+
       # Returns a grid where powered locations are marked true
       # @return [Numo::Bit]
       def parsed_power_grid
@@ -680,7 +716,7 @@ module Sc2
         return @_build_coordinates[cache_key] if !@_build_coordinates[cache_key].nil? && !bot.game_info_stale?
 
         result = []
-        input_grid = parsed_pathing_grid & parsed_placement_grid & ~expo_placement_grid
+        input_grid = parsed_pathing_grid & parsed_placement_grid & ~expo_placement_grid & ~placement_obstruction_grid
         input_grid = if on_creep
           parsed_creep & input_grid
         else

data/lib/sc2ai/player/units.rb

@@ -41,6 +41,12 @@ module Sc2
       #   @return [Array<Integer>] a group of neutral units
       def upgrades_completed = observation&.raw_data&.player&.upgrade_ids.to_a || [] # not a unit
 
+      # Returns true if this upgrade has finished researching
+      # @return [Boolean]
+      def upgrade_completed?(upgrade_id)
+        upgrades_completed.include?(upgrade_id)
+      end
+
       # Returns the upgrade ids which are researching or queued
       # Not set for enemy.
       # @return [Array<Integer>]
@@ -69,7 +75,7 @@ module Sc2
         result - upgrades_completed
       end
 
-      # Returns the upgrade ids which are researching or queued
+      # Returns true if the upgrade is busy researching
       # @return [Boolean]
       def upgrade_in_progress?(upgrade_id)
         structure_unit_type_id = Api::TechTree.upgrade_researched_from(upgrade_id: upgrade_id)
@@ -141,31 +147,6 @@ module Sc2
 
       # Event-driven unit groups ---
 
-      # @!attribute event_units_created
-      # Units created since last frame (visible only, units not structures)
-      # Read this on_step. Alternative to callback on_unit_created
-      # @note Morphed units should watch #event_units_type_changed
-      #   @return [Sc2::UnitGroup] group of created units
-      attr_accessor :event_units_created
-
-      # Units which had their type changed since last frame
-      # Read this on_step. Alternative to callback on_unit_type_changed
-      # @!attribute event_units_type_changed
-      #   @return [Sc2::UnitGroup] group effected
-      attr_accessor :event_units_type_changed
-
-      # Structures seen since last frame with building not completed (< 1.0)
-      # Read this on_step. Alternative to callback on_structure_started
-      # @!attribute event_structures_started
-      #   @return [Sc2::UnitGroup] a group of structures started
-      attr_accessor :event_structures_started
-
-      # Structures which had their building completed (==1.0) since last frame
-      # Read this on_step. Alternative to callback on_structure_completed
-      # @!attribute event_structures_completed
-      #   @return [Sc2::UnitGroup] a group of structures started
-      attr_accessor :event_structures_completed
-
       # Units and Structures which had their health/shields reduced since last frame
       # Read this on_step. Alternative to callback on_unit_damaged
       # @!attribute event_units_damaged
@@ -330,10 +311,6 @@ module Sc2
         @_all_seen_unit_tags ||= Set.new(@units.tags)
 
         # Event-driven unit groups as callback alternatives
-        @event_units_created = UnitGroup.new
-        @event_structures_started = UnitGroup.new
-        @event_structures_completed = UnitGroup.new
-        @event_units_type_changed = UnitGroup.new
         @event_units_damaged = UnitGroup.new
         # @event_units_buffed = UnitGroup.new
 
@@ -428,14 +405,11 @@ module Sc2
 
         if unit.is_structure?
           if unit.build_progress < 1
-            @event_structures_started.add(unit)
             on_structure_started(unit)
           else
-            @event_structures_completed.add(unit)
             on_structure_completed(unit)
           end
         else
-          @event_units_created.add(unit)
           on_unit_created(unit)
         end
         @_all_seen_unit_tags.add(unit.tag)
@@ -446,7 +420,6 @@ module Sc2
       def issue_existing_unit_callbacks(unit, previous_unit)
         # Check if a unit type has changed
         if unit.unit_type != previous_unit.unit_type
-          @event_units_type_changed.add(unit)
           on_unit_type_changed(unit, previous_unit.unit_type)
         end
 
@@ -459,7 +432,6 @@ module Sc2
 
         if unit.is_structure?
           if previous_unit.build_progress < 1 && unit.build_progress == 1
-            @event_structures_completed.add(unit)
             on_structure_completed(unit)
           end
         end

data/lib/sc2ai/player.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
+require "forwardable"
+require "numo/narray"
 require_relative "api/data"
 require_relative "connection/connection_listener"
 require_relative "connection/status_listener"
 require_relative "player/game_state"
 require_relative "player/units"
 require_relative "player/previous_state"
-require_relative "player/geometry"
+require_relative "player/geo"
 require_relative "player/actions"
 require_relative "player/debug"
-require "numo/narray"
 
 module Sc2
   # Allows defining Ai, Bot, BotProcess (external), Human or Observer for a Match
@@ -188,13 +189,13 @@ module Sc2
       attr_accessor :previous
 
       # @!attribute geo
-      #   @return [Sc2::Player::Geometry] geo and map helper functions
+      #   @return [Sc2::Player::Geo] geo and map helper functions
       attr_accessor :geo
 
       def initialize(race:, name:)
         super(race:, name:, type: Api::PlayerType::Participant, difficulty: nil, ai_build: nil)
         @previous = Sc2::Player::PreviousState.new
-        @geo = Sc2::Player::Geometry.new(self)
+        @geo = Sc2::Player::Geo.new(self)
 
         configure
       end
@@ -231,7 +232,7 @@ module Sc2
         loop do
           r = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
           perform_actions
-          perform_debug_commands # TODO: Detect IS_LADDER? -> unless IS_LADDER?
+          perform_debug_commands unless Sc2.ladder?
           step_forward
           print "\e[2K#{game_loop - @previous.game_loop} Steps Took (ms): #{(::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - r) * 1000}\n\e[1A\r"
           return @result unless @result.nil?
@@ -329,7 +330,7 @@ module Sc2
 
       # Callback for unit destroyed. Tags might be found in `previous.all_units`
       # This excludes unknown objects, like projectiles and only shows things the API has "seen" as a unit
-      # Override to use in your bot class or use Player.event_units_destroyed
+      # Override to use in your bot class or use Player.
       # @param unit [Api::Unit]
       # @see Sc2::Player::Units#units_destroyed
       def on_unit_destroyed(unit)
@@ -343,7 +344,7 @@ module Sc2
 
       # Callback for unit type changing.
       # To detect certain unit creations, you should use this method to watch morphs.
-      # Override to use in your bot class or use Player.event_structures_started
+      # Override to use in your bot class or use Player.
       # @param unit [Api::Unit]
       # @param previous_unit_type_id [Integer] Api::UnitTypeId::*
       def on_unit_type_changed(unit, previous_unit_type_id)
@@ -356,13 +357,13 @@ module Sc2
       end
 
       # Callback for structure building is completed
-      # Override to use in your bot class or use Player.event_structures_completed
+      # Override to use in your bot class or use Player.
       # @param unit [Api::Unit]
       def on_structure_completed(unit)
       end
 
       # Callback for unit (Unit/Structure) taking damage
-      # Override to use in your bot class or use Player.event_units_damaged
+      # Override to use in your bot class or use Player.
       # @param unit [Api::Unit]
       # @param amount [Integer] of damage
       def on_unit_damaged(unit, amount)
@@ -551,7 +552,6 @@ module Sc2
       # This is better than having a bunch of random zero and nil values
       @previous.reset(self) if @previous.all_units.nil?
 
-      # TODO: remove @events attributes if we don't use them for performance gains
       # Actions performed and errors (only if implemented)
       on_actions_performed(response_observation.actions) unless response_observation.actions.empty?
       on_action_errors(response_observation.action_errors) unless response_observation.action_errors.empty?
@@ -608,41 +608,6 @@ module Sc2
       end
     end
 
-    # Misc -------------------------------
-    # ##TODO: perfect loop implementation
-    # observation has an optional param game_loop and will only return once that step is reached (blocking).
-    # without it, it returns things as they are.
-    # broadly, i think this is what it should be doing, with step_count being minimum of 1, so no zero-steps occur.
-    # @example
-    # desired_game_loop = current_game_loop + step_count
-    # response = client.observation(game_loop: desired_game_loop)
-    #
-    #   if response.game_loop > desired_game_loop {
-    #
-    #     # our requested point-in-time has passed. bot too slow or unlucky timing.
-    #     # so, just re-query things as they stand right now:
-    #     missed_response = response
-    #     # note no game_loop argument supplied this time
-    #     response = client.observation()
-    #
-    #     # Combine observations so you didn't miss anything
-    #     # Merges
-    #     response.actions.merge(missed_response.actions)
-    #     response.action_errors.merge(missed_response.action_errors)
-    #     response.chat.merge(missed_response.chat)
-    #
-    #     # Overrides
-    #     if missed_response.player_result && response.player_result.empty?
-    #       response.player_result = player_result
-    #     end
-    #
-    #       # Note we don't touch reponse.observation and keep the latest
-    #   end
-    #   current_game_loop = response.game_loop
-    #   return response # or dispatch events with it
-    # def perfect_loop
-    # end
-
     private
 
     # @private

data/lib/sc2ai/protocol/extensions/color.rb

@@ -2,7 +2,7 @@ module Api
   # Adds additional functionality and fixes quirks with color specifically pertaining to debug commands
   module ColorExtension
     # For lines: r & b are swapped.
-    def initialize(r:, g:, b:)
+    def initialize(r: 0, g: 0, b: 0)
       super(r: b, g: g, b: r)
     end
 

data/lib/sc2ai/protocol/extensions/unit.rb

@@ -243,7 +243,7 @@ module Api
 
     # Builds target unit type, i.e. issuing a build command to worker.build(...Api::UnitTypeId::BARRACKS)
     # @param unit_type_id [Integer] Api::UnitTypeId the unit type you wish to build
-    # @param target [Api::Point2D, Integer, nil] is a unit tag or a Api::Point2D. Nil for addons/orbital
+    # @param target [Api::Point2D, Api::Unit, Integer, nil] is a unit tag or a Api::Point2D. Nil for addons/orbital
     # @param queue_command [Boolean] shift+command
     def build(unit_type_id:, target: nil, queue_command: false)
       @bot.build(units: self, unit_type_id:, target:, queue_command:)

data/lib/sc2ai/protocol/extensions/unit_type.rb

@@ -1,9 +1,9 @@
 module Api
   # Adds additional functionality to message object Api::Unit
   module UnitTypeExtension
-    def mood
-      "Crafty"
-    end
+    # def mood
+    #   "Crafty"
+    # end
   end
 end
 Api::UnitTypeData.prepend Api::UnitTypeExtension

data/lib/sc2ai/unit_group/action_ext.rb

@@ -6,7 +6,7 @@ module Sc2
   # A set of action related tasks for unit groups
   class UnitGroup
     # Our first unit's bot object.
-    # Returns nil if units are empty, so use safetly operator bot&.method(...)
+    # Returns nil if units are empty, so use safety operator bot&.method(...)
     # @return [Sc2::Player, nil] player with active connection
     def bot
       first&.bot
@@ -27,7 +27,7 @@ module Sc2
 
     # Builds target unit type, i.e. issuing a build command to worker.build(...Api::UnitTypeId::BARRACKS)
     # @param unit_type_id [Integer] Api::UnitTypeId the unit type you wish to build
-    # @param target [Api::Point2D, Integer, nil] is a unit tag or a Api::Point2D. Nil for addons/orbital
+    # @param target [Api::Point2D, Api::Unit, Integer, nil] is a unit tag or a Api::Point2D. Nil for addons/orbital
     # @param queue_command [Boolean] shift+command
     def build(unit_type_id:, target: nil, queue_command: false)
       return if size.zero?

data/lib/sc2ai/unit_group/filter_ext.rb

@@ -6,7 +6,11 @@ require "kdtree"
 module Sc2
   # Manage virtual control groups of units, similar to Hash or Array.
   class UnitGroup
+    # An array of all worker unit type ids
+    # @return [Array<Integer>]
     TYPE_WORKER = [Api::UnitTypeId::SCV, Api::UnitTypeId::MULE, Api::UnitTypeId::DRONE, Api::UnitTypeId::DRONEBURROWED, Api::UnitTypeId::PROBE].freeze
+    # An array of all gas structure unit type ids
+    # @return [Array<Integer>]
     TYPE_GAS_STRUCTURE = [
       Api::UnitTypeId::REFINERY,
       Api::UnitTypeId::REFINERYRICH,
@@ -15,6 +19,8 @@ module Sc2
       Api::UnitTypeId::EXTRACTOR,
       Api::UnitTypeId::EXTRACTORRICH
     ].freeze
+    # An array of all mineral unit type ids
+    # @return [Array<Integer>]
     TYPE_MINERAL = [
       Api::UnitTypeId::MINERALCRYSTAL,
       Api::UnitTypeId::RICHMINERALFIELD,
@@ -33,6 +39,8 @@ module Sc2
       Api::UnitTypeId::MINERALFIELDOPAQUE,
       Api::UnitTypeId::MINERALFIELDOPAQUE900
     ].freeze
+    # An array of all open geyser unit type ids
+    # @return [Array<Integer>]
     TYPE_GEYSER = [
       Api::UnitTypeId::VESPENEGEYSER,
       Api::UnitTypeId::SPACEPLATFORMGEYSER,
@@ -41,6 +49,8 @@ module Sc2
       Api::UnitTypeId::PURIFIERVESPENEGEYSER,
       Api::UnitTypeId::SHAKURASVESPENEGEYSER
     ].freeze
+    # An array of all debris unit type ids
+    # @return [Array<Integer>]
     TYPE_REJECT_DEBRIS = ((TYPE_MINERAL + TYPE_GEYSER) << Api::UnitTypeId::XELNAGATOWER).freeze
     TYPE_TECHLAB = [
       Api::UnitTypeId::TECHLAB,
@@ -48,12 +58,16 @@ module Sc2
       Api::UnitTypeId::FACTORYTECHLAB,
       Api::UnitTypeId::STARPORTTECHLAB
     ].freeze
+    # An array of all reactor structure unit type ids
+    # @return [Array<Integer>]
     TYPE_REACTOR = [
       Api::UnitTypeId::REACTOR,
       Api::UnitTypeId::BARRACKSREACTOR,
       Api::UnitTypeId::FACTORYREACTOR,
       Api::UnitTypeId::STARPORTREACTOR
     ].freeze
+    # An array of all base structures unit type ids
+    # @return [Array<Integer>]
     TYPE_BASES = [
       Api::UnitTypeId::COMMANDCENTER, Api::UnitTypeId::COMMANDCENTERFLYING,
       Api::UnitTypeId::ORBITALCOMMAND, Api::UnitTypeId::ORBITALCOMMANDFLYING,
@@ -301,6 +315,12 @@ module Sc2
     end
     alias_method :larvae, :larva
 
+    # Selects eggs. Eggs come from Larva and turn into Units.
+    # @return [Sc2::UnitGroup] eggs
+    def eggs
+      select_type(Api::UnitTypeId::EGG)
+    end
+
     # Selects queens
     # @return [Sc2::UnitGroup] queens
     def queens

data/lib/sc2ai/version.rb

@@ -2,5 +2,5 @@
 
 module Sc2
   # gem version
-  VERSION = "0.0.7"
+  VERSION = "0.1.0"
 end

data/lib/sc2ai.rb

@@ -1,12 +1,5 @@
 # frozen_string_literal: true
 
-# TODO: MOVE RUBY_GC_* to load into shell ENV, because they apparently can't be set at runtime.
-# Arbitrary very large numbers which should not be reached
-# RUBY_GC_MALLOC_LIMIT=128000000000;
-# RUBY_GC_OLDMALLOC_LIMIT=128000000000;
-# RUBY_GC_OLDMALLOC_LIMIT_MAX=128000000000;
-# RUBY_GC_HEAP_INIT_SLOTS=329375
-
 # In the event major runs, let it compact
 GC.auto_compact = true
 

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

@@ -46,7 +46,7 @@ message PowerSource {
 message PlayerRaw {
   repeated PowerSource power_sources = 1;
   optional Point camera = 2;
-  repeated uint32 upgrade_ids = 3;          // TODO: Add to UI observation?
+  repeated uint32 upgrade_ids = 3;
 }
 
 message UnitOrder {

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

@@ -52,7 +52,7 @@ message MultiPanel {
 message CargoPanel {
   optional UnitInfo unit = 1;
   repeated UnitInfo passengers = 2;
-  optional int32 slots_available = 3;       // TODO: Change to cargo size
+  optional int32 slots_available = 3;
 }
 
 message BuildItem {