sc2ai 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3381af0733cb9b44a40246320a45ce09b3c7f0b0238b80cd5534865c0014b680
-  data.tar.gz: 913fee720f4f6103f7b64631f06d1c3248a49808a558bee0b9f95fab7b0ecd9f
+  metadata.gz: e4cc73bf9c7a184bba045eeda38fda3eef727073f587a2d10aaa73221a32e623
+  data.tar.gz: 0a369e3cc2541eca0c31c9a54ee5837d1ecc468dbbef6c44294ed5446fece302
 SHA512:
-  metadata.gz: 340af3f03ef5284e833b9edd4ede7eba36ea9abbae312e30b7417cceb674a5e0a4796e9e18cfad4bfab1affd448689a7616fabdba01451a150ea252db9036008
-  data.tar.gz: a747b1af3bfc97f20da16b094022f8f1d65ee722441e7c044497a29fc109c2e63f29096401d865ee7563c7da62f94d18b15786c9fe3e1c18bc75851c42e2959a
+  metadata.gz: 276537ab6bd87a3bccc61664af3cffc40dd1c1d5191d14bba5ee7c22e8d23795300ea7e968db4f46dff6847e3dac50e18a2232ec2a51bdae1b9341c6f8bc96e4
+  data.tar.gz: 6c58faf15c7eee339a9e24cbd7d945bd938cc82be86ee211bc9633127711f4b997b2b9619d83c0ce11e0b624facb4034bec83a46e9cb72e87b8f25039afc4baf

data/docker_build/Dockerfile.ruby

@@ -4,7 +4,7 @@ LABEL service="bot-ruby-local"
 USER root
 WORKDIR /root/ruby-builder
 
-ARG RUBY_VERSION=3.4.7
+ARG RUBY_VERSION=4.0.1
 ARG DEBIAN_DISABLE_RUBYGEMS_INTEGRATION=true
 
 # Deps - Ruby build
@@ -17,7 +17,7 @@ RUN tar -zxf yaml-0.2.5.tar.gz
 
 # Ruby
 RUN mkdir -p /root/ruby-builder/.ruby
-RUN curl https://cache.ruby-lang.org/pub/ruby/3.4/ruby-$RUBY_VERSION.tar.gz -o ruby-$RUBY_VERSION.tar.gz
+RUN curl https://cache.ruby-lang.org/pub/ruby/4.0/ruby-$RUBY_VERSION.tar.gz -o ruby-$RUBY_VERSION.tar.gz
 RUN tar -zxf ruby-$RUBY_VERSION.tar.gz
 RUN mkdir ruby-$RUBY_VERSION/build
 WORKDIR /root/ruby-builder/ruby-$RUBY_VERSION/build

data/lib/sc2ai/api/data.rb

@@ -110,6 +110,7 @@ module Sc2
       decorate_unit_type_placement_length
       decorate_missing_values
       decorate_weapon_helpers
+      correct_speed_times # NB: Run after decorate_missing_values, which adds weapons
     end
 
     # @private
@@ -252,6 +253,33 @@ module Sc2
       end
     end
 
+    # Fix time-related data for Weapon Cooldown and move-speed
+    # Also adds per-frame values for these corrected speeds
+    def correct_speed_times
+      units.transform_values! do |unit_data|
+        # i.e. distance traveled using in-game seconds:
+        # seconds = delta_frames / 22.4
+        # traveled = seconds * unit_data.movement_speed
+        unit_data.movement_speed *= 1.4
+
+        # i.e. distance traveled per frame time:
+        # traveled = delta_frames * unit_data.movement_speed_frame
+        unit_data.movement_speed_frame = unit_data.movement_speed / 22.4
+
+        unit_data.weapons.each do |weapon|
+          # example usage dps (in-game second at faster speed):
+          # w.damage * w.attacks / w.speed
+          weapon.speed *= 1.14
+
+          # example usage for damage dealt over X frames:
+          # w.damage * w.attacks / w.speed_frame * delta_frames
+          weapon.speed_frame = weapon.speed / 22.4
+        end
+
+        unit_data
+      end
+    end
+
     private
 
     # @private
@@ -279,7 +307,7 @@ module Sc2
           damage_bonus: [],
           attacks: 1,
           range: 6.0,
-          speed: 0.224
+          speed: 0.16 # <- normal speed as per API/liquipedia. this is corrected in the #speed method
         ),
         Api::Weapon.new(
           type: Api::Weapon::TargetType::AIR,
@@ -287,22 +315,33 @@ module Sc2
           damage_bonus: [],
           attacks: 1,
           range: 6.0,
-          speed: 0.224
+          speed: 0.16
         )
       ]
     end
 
+    # Returns first ground weapon for unit type, if it has one
+    # @return [Api::Weapon, nil]
+    def unit_ground_weapon(unit_type_id)
+      units[unit_type_id].weapons.find do |weapon|
+        weapon.type == :GROUND || weapon.type == :ANY
+      end
+    end
+
+    # Returns first air weapon for unit type, if it has one
+    # @return [Api::Weapon, nil]
+    def unit_air_weapon(unit_type_id)
+      units[unit_type_id].weapons.find do |weapon|
+        weapon.type == :AIR || weapon.type == :ANY
+      end
+    end
+
     # @private
     # Adds ground_damage, air_damage, ground_range, air_range, ground_dps and air_dps
     def decorate_weapon_helpers
       @units.each do |unit_type_id, unit_type_data|
-        ground_weapon = unit_type_data.weapons.find do |weapon|
-          weapon.type == :GROUND || weapon.type == :ANY
-        end
-
-        air_weapon = unit_type_data.weapons.find do |weapon|
-          weapon.type == :AIR || weapon.type == :ANY
-        end
+        ground_weapon = unit_ground_weapon(unit_type_id)
+        air_weapon = unit_air_weapon(unit_type_id)
 
         unit_type_data.ground_range = ground_weapon&.range || 0.0
         unit_type_data.air_range = air_weapon&.range || 0.0

data/lib/sc2ai/cli/versus_bot.rb

@@ -69,25 +69,6 @@ module Sc2
         ENV["SERVER_GAME_PORT"] = @port_config.server_port_set.game_port.to_s
         ENV["CLIENT_BASE_PORT"] = @port_config.client_port_sets.first.base_port.to_s
         ENV["CLIENT_GAME_PORT"] = @port_config.client_port_sets.first.game_port.to_s
-
-        # @port_config_env =
-        #   "-e SERVER_BASE_PORT=#{@port_config.server_port_set.base_port} " +
-        #     "-e SERVER_GAME_PORT=#{@port_config.server_port_set.game_port} " +
-        #     "-e CLIENT_BASE_PORT=#{@port_config.client_port_sets.first.base_port} " +
-        #     "-e CLIENT_GAME_PORT=#{@port_config.client_port_sets.first.game_port} "
-
-        # # Create a modified version of ports for docker bot
-        # @client_port_config = @port_config.dup
-        # # Adjust ports for docker
-        # @client_port_config.client_port_sets[0].base_port = 8453
-        # @client_port_config.client_port_sets[0].game_port = 2359
-        #
-        # # Get dynamic assigned ports for host
-        # real_client_base_port = `docker port versus_bot_container 8453/udp`.strip.split(":").last
-        # real_client_game_port = `docker port versus_bot_container 2359`.strip.split(":").last
-        # # Fix our client ports to forward to the docker bot
-        # @port_config.client_port_sets[0].base_port = real_client_base_port.to_i
-        # @port_config.client_port_sets[0].game_port = real_client_game_port.to_i
       end
 
       def set_compose_file
@@ -95,7 +76,7 @@ module Sc2
         @compose_file = Sc2::Paths.gem_root
           .join("docker_build", "docker-compose-versus-bot.yml")
           .expand_path.to_s
-        @compose_args = "-f #{@compose_file} #{@port_config_env}"
+        @compose_args = "-f #{@compose_file} "
         cmd = "docker compose #{@compose_args} build"
         Kernel.system(cmd)
       end

data/lib/sc2ai/connection/requests.rb

@@ -7,9 +7,18 @@ module Sc2
       # GAME MANAGEMENT ----
 
       # Send to host to initialize game
-      def create_game(map:, players:, realtime: false)
+      def create_game(map:, players:, realtime: false, disable_fog: false)
+        if map.is_a? MapFile
+          battlenet_map_name = nil
+          local_map = Api::LocalMap.new(map_path: map.path)
+        else
+          battlenet_map_name = map
+          local_map = nil
+        end
         send_request_for create_game: Api::RequestCreateGame.new(
-          local_map: Api::LocalMap.new(map_path: map.path),
+          battlenet_map_name: battlenet_map_name,
+          local_map: local_map,
+          disable_fog:,
           player_setup: players.map do |player|
             Api::PlayerSetup.new(
               type: player.type,

data/lib/sc2ai/local_play/client_manager.rb

@@ -38,7 +38,9 @@ module Sc2
       existing = @clients[player_index]
       stop(player_index) if !existing.nil? && existing.running?
 
-      client = Client.new(host: @host, port: @ports[player_index], **Sc2.config.to_h)
+      port = @ports[player_index] || (@ports[player_index] = Ports.random_available_port)
+
+      client = Client.new(host: @host, port: port, **Sc2.config.to_h)
       client.launch
       @clients[player_index] = client
       client

data/lib/sc2ai/local_play/match.rb

@@ -23,9 +23,11 @@ module Sc2
     # @param players [Array<Sc2::Player>]
     # @param map [String, Sc2::MapFile] String path or map name, or Map
     # @return [Sc2::Match]
-    def initialize(players:, map: nil)
+    def initialize(players:, map: nil, ladder_map: nil)
       @players = players || []
-      @map = if map.is_a?(String)
+      @map = if ladder_map
+        ladder_map
+      elsif map.is_a?(String)
         MapFile.new(map.to_s)
       else
         map
@@ -39,7 +41,9 @@ module Sc2
       @players.select! { |player| player.is_a?(Player) }
       raise Error, "player count greater than 1 expected" unless @players.length >= 2
 
-      raise Error, "invalid map" if !@map.is_a?(MapFile) || @map.path.empty?
+      if @map.nil? || (@map.is_a?(MapFile) && @map.path.empty?)
+        raise Error, "invalid map"
+      end
     end
 
     # Connects players to instances, creates a game and joins everyone to play!

data/lib/sc2ai/player/geo.rb

@@ -634,7 +634,7 @@ module Sc2
         minerals_by_pos = {}
         bot.neutral.minerals.reject_type(Api::UnitTypeId::MINERALFIELD450)
           .each do |mineral|
-          minerals_by_pos[mineral.pos.to_axy] = mineral
+            minerals_by_pos[mineral.pos.to_axy] = mineral
         end
         minerals_by_pos.each do |xy, mineral|
           x, y = xy

data/lib/sc2ai/player/units.rb

@@ -63,17 +63,17 @@ module Sc2
         structures
           .select_type(Api::TechTree.upgrade_structure_unit_type_ids)
           .each do |structure|
-          next unless structure.is_active? # Skip idle
-
-          # Check if any order at a structure contains an upgrade ability
-          structure.orders.each do |order|
-            Api::TechTree.upgrade_ability_data(structure.unit_type).each do |upgrade_id, update_info|
-              if update_info[:ability] == order.ability_id
-                # Save the upgrade_id
-                result << upgrade_id
+            next unless structure.is_active? # Skip idle
+
+            # Check if any order at a structure contains an upgrade ability
+            structure.orders.each do |order|
+              Api::TechTree.upgrade_ability_data(structure.unit_type).each do |upgrade_id, update_info|
+                if update_info[:ability] == order.ability_id
+                  # Save the upgrade_id
+                  result << upgrade_id
+                end
               end
             end
-          end
         end
 
         # If the API told use it's complete, but an order still lingers, trust the API

data/lib/sc2ai/player.rb

@@ -569,6 +569,7 @@ module Sc2
     # @return [Api::Observation] observation of the game state
     def step_forward
       # Sc2.logger.debug "#{self.class} step_forward"
+      @timer ||= StepTimer.new(self)
 
       unless @realtime
         @api.step(@step_count)

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

@@ -198,6 +198,12 @@ module Api
       energy == energy_max
     end
 
+    # @!attribute [r] is_worker?
+    #   @return [Boolean] is a worker unit. includes MULEs
+    def is_worker?
+      Sc2::UnitGroup::TYPE_WORKER.include?(unit_type)
+    end
+
     # Returns whether this is a melee (non-ranged) attacker
     # Archon isn't melee; 3 range
     # Hellbat is melee, but Hellion isn't melee; 5 range
@@ -508,10 +514,10 @@ module Api
     # @param ability_id [Integer] passing this will override weapon Api::AbilityId::*
     # @return [Boolean]
     # @example
-    #   queen.can_attack?(enemy, weapon_index: 0) # Air attack
-    #   queen.can_attack?(enemy, weapon_index: 1) # Ground attack
-    #   queen.can_attack?(enemy) # Auto detect (scans all weapons)
-    #   ghost.can_attack?(enemy, weapon_index: 0, ability_id: Api::AbilityId::SNIPE)
+    #   queen.can_attack?(unit: enemy, weapon_index: 0) # Air attack
+    #   queen.can_attack?(unit: enemy, weapon_index: 1) # Ground attack
+    #   queen.can_attack?(unit: enemy) # Auto detect (scans all weapons)
+    #   ghost.can_attack?(unit: enemy, ability_id: Api::AbilityId::SNIPE)
     def can_attack?(unit:, weapon_index: nil, ability_id: nil)
       return false if unit.nil?
       if ability_id
@@ -652,7 +658,7 @@ module Api
         Api::UnitTypeId::STARPORTREACTOR
       end
 
-      build(unit_type_id: unit_type_id, target:, queue_command:)
+      build(unit_type_id: unit_type_id, queue_command:)
     end
 
     # For Terran builds a tech lab add-on on the current structure
@@ -666,7 +672,7 @@ module Api
       when Api::UnitTypeId::STARPORT, Api::UnitTypeId::STARPORTFLYING
         Api::UnitTypeId::STARPORTTECHLAB
       end
-      build(unit_type_id: unit_type_id, target:, queue_command:)
+      build(unit_type_id: unit_type_id, queue_command:)
     end
 
     # PROTOSS Convenience functions ---

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

@@ -53,6 +53,13 @@ module Api
     #   Air weapon damage per second or 0.0
     #   @return [Float]
     attr_accessor :air_dps
+
+    # @!attribute movement_speed_frame
+    #   Movement speed per frame
+    #   @example
+    #     distance = delta_frawmes * unit_data.movement_speed_frame
+    #   @return [Float]
+    attr_accessor :movement_speed_frame
   end
 end
 Api::UnitTypeData.prepend Api::UnitTypeDataExtension

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

@@ -0,0 +1,13 @@
+module Api
+  # Adds additional functionality to message object Api::WeaponExtension
+  module WeaponExtension
+    # @!attribute speed_frame
+    #   Weapon cooldown speed per frame
+    #   @example
+    #     # For a given time delta, how much damage will it do
+    #     dmg_for_time = w.damage * w.attacks / w.speed_frame * delta_frames
+    #   @return [Float]
+    attr_accessor :speed_frame
+  end
+end
+Api::Weapon.prepend Api::WeaponExtension

data/lib/sc2ai/unit_group/filter_ext.rb

@@ -18,6 +18,7 @@ module Sc2
       Api::UnitTypeId::EXTRACTOR,
       Api::UnitTypeId::EXTRACTORRICH
     ].freeze
+
     # An array of all mineral unit type ids
     # @return [Array<Integer>]
     TYPE_MINERAL = [
@@ -38,6 +39,7 @@ module Sc2
       Api::UnitTypeId::MINERALFIELDOPAQUE,
       Api::UnitTypeId::MINERALFIELDOPAQUE900
     ].freeze
+
     # An array of all open geyser unit type ids
     # @return [Array<Integer>]
     TYPE_GEYSER = [
@@ -48,6 +50,7 @@ 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
@@ -57,6 +60,7 @@ module Sc2
       Api::UnitTypeId::FACTORYTECHLAB,
       Api::UnitTypeId::STARPORTTECHLAB
     ].freeze
+
     # An array of all reactor structure unit type ids
     # @return [Array<Integer>]
     TYPE_REACTOR = [
@@ -65,6 +69,7 @@ module Sc2
       Api::UnitTypeId::FACTORYREACTOR,
       Api::UnitTypeId::STARPORTREACTOR
     ].freeze
+
     # An array of all base structures unit type ids
     # @return [Array<Integer>]
     TYPE_BASES = [
@@ -236,6 +241,38 @@ module Sc2
       Api::UnitTypeId::SPORECRAWLERUPROOTED
     ].freeze
 
+    # An array of flying unit types
+    # Exceptions: Locusts are always ground units
+    # @return [Array<Integer>]
+    TYPE_FLYING = [
+      # Terran
+      Api::UnitTypeId::MEDIVAC,
+      Api::UnitTypeId::VIKINGFIGHTER,
+      Api::UnitTypeId::BANSHEE,
+      Api::UnitTypeId::RAVEN,
+      Api::UnitTypeId::BATTLECRUISER,
+      Api::UnitTypeId::POINTDEFENSEDRONE,
+      Api::UnitTypeId::LIBERATOR,
+
+      # Zerg
+      Api::UnitTypeId::OVERLORD, Api::UnitTypeId::OVERLORDCOCOON,
+      Api::UnitTypeId::OVERSEER, Api::UnitTypeId::OVERSEERSIEGEMODE,
+      Api::UnitTypeId::MUTALISK,
+      Api::UnitTypeId::CORRUPTOR,
+      Api::UnitTypeId::BROODLORD, Api::UnitTypeId::BROODLORDCOCOON,
+
+      # Protoss
+      Api::UnitTypeId::OBSERVER, Api::UnitTypeId::OBSERVERSIEGEMODE,
+      Api::UnitTypeId::WARPPRISM, Api::UnitTypeId::WARPPRISMPHASING,
+      Api::UnitTypeId::PHOENIX,
+      Api::UnitTypeId::VOIDRAY,
+      Api::UnitTypeId::CARRIER,
+      Api::UnitTypeId::INTERCEPTOR,
+      Api::UnitTypeId::MOTHERSHIP,
+      Api::UnitTypeId::ORACLE,
+      Api::UnitTypeId::TEMPEST
+    ].freeze
+
     # Returns a new UnitGroup containing all units matching unit type id(s)
     # Multiple values work as an "OR" filter
     # @example

data/lib/sc2ai/unit_group.rb

@@ -81,6 +81,7 @@ module Sc2
     def_delegator :@units, :to_a # Returns a new array of 2-element arrays; each nested array contains a key-value pair from #units
     def_delegator :@units, :to_h # Returns {UnitGroup#units}
     def_delegator :@units, :to_hash # Returns {UnitGroup#units}
+    def_delegator :@units, :hash # Returns {UnitGroup#units}
     def_delegator :@units, :to_proc # Returns a proc that maps a given key to its value.Returns a proc that maps a given key to its value.
 
     # Gets the Unit at an index

data/lib/sc2ai/version.rb

@@ -1,5 +1,5 @@
 module Sc2
   # gem version
   # @return [String]
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
 end

data/sig/sc2ai.rbs

@@ -2472,6 +2472,11 @@ module Sc2
     # Fixes mineral_cost_sum, vespene_cost_sum
     def correct_unit_type_sum: () -> untyped
 
+    # sord omit - no YARD return type given, using untyped
+    # Fix time-related data for Weapon Cooldown and move-speed
+    # Also adds per-frame values for these corrected speeds
+    def correct_speed_times: () -> untyped
+
     # sord omit - no YARD return type given, using untyped
     # Adds placement_length to units if applicable
     def decorate_unit_type_placement_length: () -> untyped
@@ -2480,6 +2485,14 @@ module Sc2
     # Adds values missing from the API
     def decorate_missing_values: () -> untyped
 
+    # sord omit - no YARD type given for "unit_type_id", using untyped
+    # Returns first ground weapon for unit type, if it has one
+    def unit_ground_weapon: (untyped unit_type_id) -> Api::Weapon?
+
+    # sord omit - no YARD type given for "unit_type_id", using untyped
+    # Returns first air weapon for unit type, if it has one
+    def unit_air_weapon: (untyped unit_type_id) -> Api::Weapon?
+
     # sord omit - no YARD return type given, using untyped
     # Adds ground_damage, air_damage, ground_range, air_range, ground_dps and air_dps
     def decorate_weapon_helpers: () -> untyped
@@ -2556,9 +2569,15 @@ module Sc2
     # sord omit - no YARD type given for "map:", using untyped
     # sord omit - no YARD type given for "players:", using untyped
     # sord omit - no YARD type given for "realtime:", using untyped
+    # sord omit - no YARD type given for "disable_fog:", using untyped
     # sord omit - no YARD return type given, using untyped
     # Send to host to initialize game
-    def create_game: (map: untyped, players: untyped, ?realtime: untyped) -> untyped
+    def create_game: (
+                       map: untyped,
+                       players: untyped,
+                       ?realtime: untyped,
+                       ?disable_fog: untyped
+                     ) -> untyped
 
     # sord omit - no YARD return type given, using untyped
     # Send to host and all clients for game to begin.
@@ -2843,9 +2862,15 @@ module Sc2
       # sord omit - no YARD type given for "map:", using untyped
       # sord omit - no YARD type given for "players:", using untyped
       # sord omit - no YARD type given for "realtime:", using untyped
+      # sord omit - no YARD type given for "disable_fog:", using untyped
       # sord omit - no YARD return type given, using untyped
       # Send to host to initialize game
-      def create_game: (map: untyped, players: untyped, ?realtime: untyped) -> untyped
+      def create_game: (
+                         map: untyped,
+                         players: untyped,
+                         ?realtime: untyped,
+                         ?disable_fog: untyped
+                       ) -> untyped
 
       # sord omit - no YARD return type given, using untyped
       # Send to host and all clients for game to begin.
@@ -3218,6 +3243,7 @@ module Sc2
     TYPE_TERRAN_VEHICLE: ::Array[Integer]
     TYPE_ZERG_MELEE: ::Array[Integer]
     TYPE_ZERG_MISSILE: ::Array[Integer]
+    TYPE_FLYING: ::Array[Integer]
 
     # _@param_ `units` — default to be added.
     # 
@@ -3333,6 +3359,12 @@ module Sc2
     # _@see_ `Hash#to_hash`
     def to_hash: () -> untyped
 
+    # sord omit - no YARD return type given, using untyped
+    # Forwards to hash of #units.
+    # 
+    # _@see_ `Hash#hash`
+    def hash: () -> untyped
+
     # sord omit - no YARD return type given, using untyped
     # Forwards to hash of #units.
     # 
@@ -3855,6 +3887,7 @@ module Sc2
       TYPE_TERRAN_VEHICLE: ::Array[Integer]
       TYPE_ZERG_MELEE: ::Array[Integer]
       TYPE_ZERG_MISSILE: ::Array[Integer]
+      TYPE_FLYING: ::Array[Integer]
 
       # _@param_ `unit_group`
       def initialize: (Sc2::UnitGroup unit_group) -> void
@@ -3943,10 +3976,11 @@ module Sc2
     # Callback when game status changes
     def on_status_change: (Symbol status) -> untyped
 
+    # sord omit - no YARD type given for "ladder_map:", using untyped
     # _@param_ `players`
     # 
     # _@param_ `map` — String path or map name, or Map
-    def initialize: (players: ::Array[Sc2::Player], ?map: (String | Sc2::MapFile)?) -> void
+    def initialize: (players: ::Array[Sc2::Player], ?map: (String | Sc2::MapFile)?, ?ladder_map: untyped) -> void
 
     # Validates a runnable match and raises an error if invalid
     def validate: () -> void
@@ -8064,10 +8098,10 @@ module Api
     # _@param_ `ability_id` — passing this will override weapon Api::AbilityId::*
     # 
     # ```ruby
-    # queen.can_attack?(enemy, weapon_index: 0) # Air attack
-    # queen.can_attack?(enemy, weapon_index: 1) # Ground attack
-    # queen.can_attack?(enemy) # Auto detect (scans all weapons)
-    # ghost.can_attack?(enemy, weapon_index: 0, ability_id: Api::AbilityId::SNIPE)
+    # queen.can_attack?(unit: enemy, weapon_index: 0) # Air attack
+    # queen.can_attack?(unit: enemy, weapon_index: 1) # Ground attack
+    # queen.can_attack?(unit: enemy) # Auto detect (scans all weapons)
+    # ghost.can_attack?(unit: enemy, ability_id: Api::AbilityId::SNIPE)
     # ```
     def can_attack?: (unit: Api::Unit, ?weapon_index: Integer?, ?ability_id: Integer?) -> bool
 
@@ -11067,6 +11101,8 @@ module Api
   end
 
   class Weapon
+    include Api::WeaponExtension
+
     # sord omit - no YARD type given for "buff", using untyped
     # sord omit - no YARD return type given, using untyped
     def self.decode: (untyped buff) -> untyped
@@ -20071,10 +20107,10 @@ module Api
     # _@param_ `ability_id` — passing this will override weapon Api::AbilityId::*
     # 
     # ```ruby
-    # queen.can_attack?(enemy, weapon_index: 0) # Air attack
-    # queen.can_attack?(enemy, weapon_index: 1) # Ground attack
-    # queen.can_attack?(enemy) # Auto detect (scans all weapons)
-    # ghost.can_attack?(enemy, weapon_index: 0, ability_id: Api::AbilityId::SNIPE)
+    # queen.can_attack?(unit: enemy, weapon_index: 0) # Air attack
+    # queen.can_attack?(unit: enemy, weapon_index: 1) # Ground attack
+    # queen.can_attack?(unit: enemy) # Auto detect (scans all weapons)
+    # ghost.can_attack?(unit: enemy, ability_id: Api::AbilityId::SNIPE)
     # ```
     def can_attack?: (unit: Api::Unit, ?weapon_index: Integer?, ?ability_id: Integer?) -> bool
 
@@ -20194,6 +20230,8 @@ module Api
 
     attr_reader full_energy?: bool
 
+    attr_reader is_worker?: bool
+
     # Returns whether this is a melee (non-ranged) attacker
     # Archon isn't melee; 3 range
     # Hellbat is melee, but Hellion isn't melee; 5 range
@@ -20292,6 +20330,17 @@ module Api
     def ability_id: () -> Integer?
   end
 
+  # Adds additional functionality to message object Api::WeaponExtension
+  module WeaponExtension
+    # Weapon cooldown speed per frame
+    # 
+    # ```ruby
+    # # For a given time delta, how much damage will it do
+    # dmg_for_time = w.damage * w.attacks / w.speed_frame * delta_frames
+    # ```
+    attr_accessor speed_frame: (Float | untyped)
+  end
+
   # Adds additional functionality to message object Api::Point2D
   module Point2DExtension
     # sord omit - no YARD return type given, using untyped
@@ -20545,6 +20594,13 @@ module Api
 
     # Air weapon damage per second or 0.0
     attr_accessor air_dps: (Float | untyped)
+
+    # Movement speed per frame
+    # 
+    # ```ruby
+    # distance = delta_frawmes * unit_data.movement_speed_frame
+    # ```
+    attr_accessor movement_speed_frame: (Float | untyped)
   end
 
   # This module make sure that a read from method ability_id always returns the proper source id

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sc2ai
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Dyson Returns
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.27'
+        version: '2.35'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.27'
+        version: '2.35'
 - !ruby/object:Gem::Dependency
   name: async-websocket
   requirement: !ruby/object:Gem::Requirement
@@ -57,14 +57,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -93,20 +93,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: fiddle
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: sc2ai-kdtree
   requirement: !ruby/object:Gem::Requirement
@@ -141,28 +127,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.37
+        version: 0.9.38
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.37
+        version: 0.9.38
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.14'
+        version: '7.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.14'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: webrick
   requirement: !ruby/object:Gem::Requirement
@@ -197,14 +183,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.50'
+        version: '1.53'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.50'
+        version: '1.53'
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
@@ -225,14 +211,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -354,6 +340,7 @@ files:
 - lib/sc2ai/protocol/extensions/power_source.rb
 - lib/sc2ai/protocol/extensions/unit.rb
 - lib/sc2ai/protocol/extensions/unit_type_data.rb
+- lib/sc2ai/protocol/extensions/weapon.rb
 - lib/sc2ai/protocol/query_pb.rb
 - lib/sc2ai/protocol/raw_pb.rb
 - lib/sc2ai/protocol/sc2api_pb.rb
@@ -393,14 +380,7 @@ metadata:
   source_code_uri: https://gitlab.com/dysonreturns/sc2ai
   changelog_uri: https://sc2ai.pages.dev/file.CHANGELOG
 post_install_message: "Don't bot alone! Join the StarCraft 2 AI Arena discord server
-  :) \nTutorials and help available: https://sc2ai.pages.dev/\n\n\e[31mBREAKING CHANGES\e[0m:
-  Version 0.8.0\n- StarCraft 2 v4.10 no longer works on MacOS 26+\nWe'll run on ladder's
-  patch-version going forward (currently v5.0.14).\n   \n\tTo install/update to the
-  latest ladder version run: \n\t\e[36msc2ai download_ladder_version\e[0m\n\n\tThen
-  update your config to new identifier \"ladder\": \n\t\e[32mSc2.config { |c| c.version
-  =  \"ladder\" }\e[0m\n\tor update sc2ai.yml version to \"ladder\":\n\t\e[32m---\e[0m\n\t\e[32mversion:
-  ladder\e[0m\n\nAbility ID changes:\n- FRENZY is now HYDRALISKFRENZY_HYDRALISKFRENZY
-  \   \n\n"
+  :) \nTutorials and help available: https://sc2ai.pages.dev/\n"
 rdoc_options: []
 require_paths:
 - lib
@@ -415,7 +395,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.2
 specification_version: 4
 summary: STARCRAFT® II AI API
 test_files: []