sc2ai 0.0.2 → 0.0.4

data/lib/sc2ai/api/unit_type_id.rb

@@ -2012,11 +2012,63 @@ module Api
     MINERALFIELD450 = 1996
     MINERALFIELDOPAQUE = 1997
     MINERALFIELDOPAQUE900 = 1998
-    COLLAPSIBLEROCKTOWERDEBRISRAMPLEFTGREEN = 1999
-    COLLAPSIBLEROCKTOWERDEBRISRAMPRIGHTGREEN = 2000
-    COLLAPSIBLEROCKTOWERPUSHUNITRAMPLEFTGREEN = 2001
-    COLLAPSIBLEROCKTOWERPUSHUNITRAMPRIGHTGREEN = 2002
-    COLLAPSIBLEROCKTOWERRAMPLEFTGREEN = 2003
-    COLLAPSIBLEROCKTOWERRAMPRIGHTGREEN = 2004
+    MECHAZERGLINGACGLUESCREENDUMMY_2 = 1999
+    MECHABANELINGACGLUESCREENDUMMY_2 = 2000
+    MECHAHYDRALISKACGLUESCREENDUMMY_2 = 2001
+    MECHAINFESTORACGLUESCREENDUMMY_2 = 2002
+    MECHACORRUPTORACGLUESCREENDUMMY_2 = 2003
+    MECHAULTRALISKACGLUESCREENDUMMY_2 = 2004
+    MECHAOVERSEERACGLUESCREENDUMMY_2 = 2005
+    MECHALURKERACGLUESCREENDUMMY_2 = 2006
+    MECHABATTLECARRIERLORDACGLUESCREENDUMMY_2 = 2007
+    MECHASPINECRAWLERACGLUESCREENDUMMY_2 = 2008
+    MECHASPORECRAWLERACGLUESCREENDUMMY_2 = 2009
+    TROOPERMENGSKACGLUESCREENDUMMY_2 = 2010
+    MEDIVACMENGSKACGLUESCREENDUMMY_2 = 2011
+    BLIMPMENGSKACGLUESCREENDUMMY_2 = 2012
+    MARAUDERMENGSKACGLUESCREENDUMMY_2 = 2013
+    GHOSTMENGSKACGLUESCREENDUMMY_2 = 2014
+    SIEGETANKMENGSKACGLUESCREENDUMMY_2 = 2015
+    THORMENGSKACGLUESCREENDUMMY_2 = 2016
+    VIKINGMENGSKACGLUESCREENDUMMY_2 = 2017
+    BATTLECRUISERMENGSKACGLUESCREENDUMMY_2 = 2018
+    BUNKERDEPOTMENGSKACGLUESCREENDUMMY_2 = 2019
+    MISSILETURRETMENGSKACGLUESCREENDUMMY_2 = 2020
+    ARTILLERYMENGSKACGLUESCREENDUMMY_2 = 2021
+    LOADOUTSPRAY1_2 = 2022
+    LOADOUTSPRAY2_2 = 2023
+    LOADOUTSPRAY3_2 = 2024
+    LOADOUTSPRAY4_2 = 2025
+    LOADOUTSPRAY5_2 = 2026
+    LOADOUTSPRAY6_2 = 2027
+    LOADOUTSPRAY7_2 = 2028
+    LOADOUTSPRAY8_2 = 2029
+    LOADOUTSPRAY9_2 = 2030
+    LOADOUTSPRAY10_2 = 2031
+    LOADOUTSPRAY11_2 = 2032
+    LOADOUTSPRAY12_2 = 2033
+    LOADOUTSPRAY13_2 = 2034
+    LOADOUTSPRAY14_2 = 2035
+    COLLAPSIBLEROCKTOWERDEBRISRAMPLEFTGREEN = 2036
+    COLLAPSIBLEROCKTOWERDEBRISRAMPRIGHTGREEN = 2037
+    COLLAPSIBLEROCKTOWERPUSHUNITRAMPLEFTGREEN = 2038
+    COLLAPSIBLEROCKTOWERPUSHUNITRAMPRIGHTGREEN = 2039
+    COLLAPSIBLEROCKTOWERRAMPLEFTGREEN = 2040
+    COLLAPSIBLEROCKTOWERRAMPRIGHTGREEN = 2041
+    DUMMYUNIT000 = 2042
+    DUMMYUNIT001 = 2043
+    DUMMYUNIT002 = 2044
+    DUMMYUNIT003 = 2045
+    DUMMYUNIT004 = 2046
+    DUMMYUNIT005 = 2047
+    DUMMYUNIT006 = 2048
+    DUMMYUNIT007 = 2049
+    DUMMYUNIT008 = 2050
+    DUMMYUNIT009 = 2051
+    DUMMYUNIT010 = 2052
+    DUMMYUNIT011 = 2053
+    DUMMYUNIT012 = 2054
+    DUMMYUNIT013 = 2055
+    DUMMYUNIT014 = 2056
   end
 end

data/lib/sc2ai/api/upgrade_id.rb

@@ -306,5 +306,7 @@ module Api
     PSIONICAMPLIFIERS = 300
     SECRETEDCOATING = 301
     ENHANCEDSHOCKWAVES = 302
+    HURRICANETHRUSTERS = 303
+    INTERFERENCEMATRIX = 304
   end
 end

data/lib/sc2ai/cli/cli.rb

@@ -1,4 +1,5 @@
 require "thor"
+
 require "sc2ai/cli/new"
 require "sc2ai/cli/ladderzip"
 
@@ -20,36 +21,36 @@ module Sc2
     desc "setup410", "Downloads and install SC2 v4.10"
     # downloads and install SC2 v4.10
     def setup410
-      puts " "
-      puts "This script sets up SC2 at version 4.10, which we use competitively."
-      puts "Press any key to continue..."
-      puts " "
-      $stdin.getch
-
-      puts "You must accept the Blizzard® Starcraft® II AI and Machine Learning License at"
-      puts "https://blzdistsc2-a.akamaihd.net/AI_AND_MACHINE_LEARNING_LICENSE.html"
-      puts "It is PERMISSIVE and grants you freedoms over the standard EULA."
-      puts "We do not record this action, but depend on software goverend by that license to continue."
+      say " "
+      say "This script sets up SC2 at version 4.10, which we use competitively."
+      say "Press any key to continue..."
+      ask ""
+
+      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."
       puts 'If you accept, type "iagreetotheeula" (without quotes) and press ENTER to continue:'
 
       while $stdin.gets.chomp != "iagreetotheeula"
-        puts ""
+        say ""
         puts 'Type "iagreetotheeula" (without quotes) and press ENTER to continue:'
       end
-      puts ""
-      puts ""
-      puts "Great decision."
+      say ""
+      say ""
+      say "Great decision."
 
+      require "sc2ai"
       Async do
         Sc2.logger.level = :fatal
-        puts "SC2 will launch a blank window, be unresponsive, but download about 100mb in the background."
-        puts "Let it finish and close itself."
-        puts "Press ENTER if you understand."
-        $stdin.getch
+        say "SC2 will launch a blank window, be unresponsive, but download about 100mb in the background."
+        say "Let it finish and close itself."
+        say "Press ENTER if you understand."
+        ask ""
 
-        puts ""
-        puts ""
-        puts "This will only take a minute..."
+        say ""
+        say ""
+        say "This will only take a minute..."
 
         Sc2.config.version = nil
         client = Sc2::ClientManager.obtain(0)
@@ -68,22 +69,23 @@ module Sc2
         base_build = "75689"
         path = Sc2::Paths.executable(base_build: base_build)
         if path.include?(base_build) && Pathname(path).exist?
-          puts " "
-          puts "Success. Downloaded complete."
-          puts " "
+          say " "
+          say "Success. Download complete.", :green
+          say " "
         else
-          puts "Error. Slightly worrying, but no fear."
-          puts "To manually setup, grab the latest ladder maps and add them to your map folder."
-          puts "Grab the latest maps from https://aiarena.net/wiki/maps/"
-          puts "Detected map folder: #{Sc2::Paths.maps_dir}"
-          puts "Then, download any recent replay from https://aiarena.net/ and double click to launch"
+          say "Error. Slightly worrying, but no fear.", :red
+          say "To manually setup, grab the latest ladder maps and add them to your map folder."
+          say "Grab the latest maps from https://aiarena.net/wiki/maps/"
+          say "Detected map folder: #{Sc2::Paths.maps_dir}"
+          say "Then, download any recent replay from https://aiarena.net/ and double click to launch"
         end
 
+        observer.api.quit
         observer.disconnect
-        puts "Generating sc2ai.yml to always use 4.10..."
+        say "Generating sc2ai.yml to always use 4.10..."
         Sc2.config.config_file.write({"version" => "4.10"}.to_yaml.to_s)
-        puts ""
-        puts "Done. You're good to go."
+        say ""
+        say "Done. You're good to go.", :green
       ensure
         Sc2::ClientManager.stop(0)
       end
@@ -133,7 +135,7 @@ module Sc2
     option :RealTime, type: :boolean, default: false, desc: "Forces realtime flag"
     def laddermatch
       require "sc2ai"
-      
+
       unless Sc2.ladder?
         raise Sc2::Error, "This command is only for competing on aiarena.net"
       end

data/lib/sc2ai/cli/ladderzip.rb

@@ -18,11 +18,21 @@ module Sc2
       desc "Builds a ladder zip using docker (requires docker)"
 
       def docker_exists
-        if Kernel.system("docker --version")
+        if Kernel.system("docker --version", out: File::NULL, err: File::NULL)
           say_status("docker", "found", :green)
         else
           say_status("docker", "not found", :red)
           say("Please install 'docker' and/or ensure it's in your PATH to continue.")
+          raise SystemExit
+        end
+
+        if Kernel.system("docker info", out: File::NULL, err: File::NULL)
+          say_status("docker engine", "found", :green)
+        else
+          say("  ")
+          say_status("docker engine", "offline", :red)
+          say("Please start docker engine. If you have Docker Desktop installed, open it before retrying.")
+          raise SystemExit
         end
       end
 
@@ -64,7 +74,8 @@ module Sc2
 
       def create_executable
         template("ladderzip/bin/ladder", "./.build/bin/ladder")
-        create_link(".build/#{botname}", "./bin/ladder")
+        # This fails on Windows. creating by hand in #link_ladder function below.
+        # create_link("./.build/#{botname}", "./bin/ladder")
       end
 
       def start_container
@@ -86,9 +97,11 @@ module Sc2
         include_pattern.collect! { |pt| pt.delete_prefix("!") }
 
         files = Dir.glob("**/*")
+
         ignored_files = files
           .select { |f| ignore_pattern.any? { |p| File.fnmatch?(p, f) } }
-          .reject! { |f| include_pattern.any? { |p| File.fnmatch?(p, f) } }
+          .reject { |f| include_pattern.any? { |p| File.fnmatch?(p, f) } }
+
         files -= ignored_files unless ignored_files.nil?
 
         files.each do |file|
@@ -103,6 +116,12 @@ module Sc2
         Kernel.system(cmd)
       end
 
+      def link_ladder
+        say_status("docker", "linking executable...", :cyan)
+        cmd = "docker compose -f #{@compose_file} exec --workdir /root/ruby-builder bot ln -s ./bin/ladder ./#{botname}"
+        Kernel.system(cmd)
+      end
+
       def install_gems
         say_status("docker", "bundle install...", :cyan)
         cmd = "docker compose -f #{@compose_file} exec --workdir /root/ruby-builder bot bundle install"

data/lib/sc2ai/player/actions.rb

@@ -17,7 +17,7 @@ module Sc2
       # Queues a Api::ActionRaw. Perform ability on unit_tags optionally on target_world_space_pos/target_unit_tag
       # @param unit_tags [Array<Integer>]
       # @param ability_id [Integer]
-      # @param queue_command [Boolean] Shift+Click, default: false
+      # @param queue_command [Boolean] shift+command
       # @param target_world_space_pos [Api::Point2D]
       # @param target_unit_tag [Integer]
       def action_raw_unit_command(unit_tags:, ability_id:, queue_command: false, target_world_space_pos: nil, target_unit_tag: nil)
@@ -39,7 +39,7 @@ module Sc2
       # @param units [Array<Integer>,Integer,Api::Unit] can be an Api::Unit, array of Api::Unit#tag or single tag
       # @param ability_id [Integer]
       # @param target [Api::Unit, Integer, Api::Point2D] is a unit, unit tag or a Api::Point2D
-      # @param queue_command [Boolean] Shift+Click, default: false
+      # @param queue_command [Boolean] shift+command
       def action(units:, ability_id:, target: nil, queue_command: false)
         unit_tags = unit_tags_from_source(units)
 
@@ -79,6 +79,7 @@ module Sc2
       # Warps in unit type at target (location or pylon) with optional source units (warp gates)
       # When not specifying the specific warp gate(s), all warpgates will be used
       # @param unit_type_id [Integer] Api::UnitTypeId the unit type which will do the creation
+      # @param queue_command [Boolean] shift+command
       # @param target [Api::Point2D, Integer] is a unit tag or a Api::Point2D
       def warp(unit_type_id:, target:, queue_command:, units: nil)
         warp_ability = Api::TechTree.unit_type_creation_abilities(
@@ -128,7 +129,7 @@ module Sc2
       # @param ability_id [Api::AbilityId]
       # @param target_screen_coord [Api::Point2I]
       # @param target_minimap_coord [Api::Point2I]
-      # @param queue_command [Boolean] Shift+Click, default: false
+      # @param queue_command [Boolean] shift+command
       # @return [void]
       def action_spatial_unit_command(ability_id:, target_screen_coord: nil, target_minimap_coord: nil, queue_command: false)
         queue_action Api::Action.new(

data/lib/sc2ai/player/debug.rb

@@ -37,6 +37,52 @@ module Sc2
         )
       end
 
+      # Prints text on screen from top and left
+      # @param text [String] will respect newlines
+      # @param left_percent [Numeric] range 0..100. percent from left of screen
+      # @param top_percent [Numeric] range 0..100. percent from top of screen
+      # @param color [Api::Color] default white
+      # @param size [Size] of font, default 14px
+      # @return [void]
+      def debug_text_screen(text, left_percent: 1.0, top_percent: 1.0, color: nil, size: 14)
+        queue_debug_command Api::DebugCommand.new(
+          draw: Api::DebugDraw.new(
+            text: [
+              Api::DebugText.new(
+                text:,
+                virtual_pos: Api::Point.new(
+                  x: left_percent.to_f / 100,
+                  y: top_percent.to_f / 100
+                ),
+                color:,
+                size:
+              )
+            ]
+          )
+        )
+      end
+
+      # Prints text on screen at 3d world position
+      # @param text [String] will respect newlines
+      # @param point [Api::Point] point in the world, i.e. unit.pos
+      # @param color [Api::Color] default white
+      # @param size [Size] of font, default 14px
+      # @return [void]
+      def debug_text_world(text, point:, color: nil, size: 14)
+        queue_debug_command Api::DebugCommand.new(
+          draw: Api::DebugDraw.new(
+            text: [
+              Api::DebugText.new(
+                text:,
+                world_pos: point,
+                color:,
+                size:
+              )
+            ]
+          )
+        )
+      end
+
       # Draws a line between two Api::Point's for color
       # @param p0 [Api::Point] the first point
       # @param p1 [Api::Point] the second point
@@ -63,8 +109,8 @@ module Sc2
       #   # Draws a box on structure placement grid
       #   debug_draw_box(point: unit.pos, radius: unit.footprint_radius)
       #
-      # Note: Api::Color RGB is broken for this command. Will use min(r,b)
-      # Note: Z index is elevated 0.01 so the line is visible and doesn't clip through terrain
+      # @note Api::Color RGB is broken for this command. Will use min(r,b)
+      # @note Z index is elevated 0.02 so the line is visible and doesn't clip through terrain
       # @param point [Api::Point]
       # @param radius [Float] default one tile wide, 1.0
       # @param color [Api::Color] default white. min(r,b) is used for both r&b
@@ -74,8 +120,8 @@ module Sc2
           draw: Api::DebugDraw.new(
             boxes: [
               Api::DebugBox.new(
-                min: Api::Point.new(x: point.x - radius, y: point.y - radius, z: point.z + 0.01),
-                max: Api::Point.new(x: point.x + radius, y: point.y + radius, z: point.z + (radius * 2) + 0.01),
+                min: Api::Point.new(x: point.x - radius, y: point.y - radius, z: point.z + 0.02),
+                max: Api::Point.new(x: point.x + radius, y: point.y + radius, z: point.z + (radius * 2) + 0.02),
                 color:
               )
             ]

data/lib/sc2ai/player/geometry.rb

@@ -7,7 +7,7 @@ module Sc2
   class Player
     # Holds map and geography helper functions
     class Geometry
-      # @!attribute Holds the parent bot object
+      # @!attribute bot
       #   @return [Sc2::Player] player with active connection
       attr_accessor :bot
 
@@ -72,6 +72,7 @@ module Sc2
       # Each value in [row][column] holds a boolean value represented as an integer
       # It does not say whether a position is occupied by another building.
       # One pixel covers one whole block. Rounds fractionated positions down.
+      # @return [Numo::Bit]
       def parsed_placement_grid
         if @parsed_placement_grid.nil?
           image_data = bot.game_info.start_raw.placement_grid
@@ -83,6 +84,7 @@ module Sc2
       end
 
       # Returns a grid where ony the expo locations are marked
+      # @return [Numo::Bit]
       def expo_placement_grid
         if @expo_placement_grid.nil?
           @expo_placement_grid = Numo::Bit.zeros(map_height, map_width)
@@ -97,6 +99,7 @@ module Sc2
       end
 
       # Returns a grid where powered locations are marked true
+      # @return [Numo::Bit]
       def parsed_power_grid
         # Cache for based on power unit tags
         cache_key = bot.power_sources.map(&:tag).sort.hash
@@ -202,7 +205,7 @@ module Sc2
       # @param y [Float, Integer]
       # @return [Boolean] true if location is powered
       def powered?(x:, y:)
-        parsed_creep[y.to_i, x.to_i] != 0
+        parsed_power_grid[y.to_i, x.to_i] != 0
       end
 
       # Returns whether a x/y block is pathable as per minimap
@@ -399,12 +402,25 @@ module Sc2
         output_grid
       end
 
+      # Returns own 2d start position as set by initial camera
+      # This differs from position of first base structure
+      # @return [Api::Point2D]
+      def start_position
+        @start_position ||= bot.observation.raw_data.player.camera
+      end
+
+      # Returns the enemy 2d start position
+      # @return [Api::Point2D]
+      def enemy_start_position
+        bot.game_info.start_raw.start_locations.first
+      end
+
       # Gets expos and surrounding minerals
       # The index is a build location for an expo and the value is a UnitGroup, which has minerals and geysers
       # @example
-      #   random_expo = expansions.keys.sample #=> Point2D
+      #   random_expo = geo.expansions.keys.sample #=> Point2D
       #   expo_resources = geo.expansions[random_expo] #=> UnitGroup
-      #   alive_minerals = expo_resources.minerals - neutral.minerals
+      #   alive_minerals = expo_resources.minerals & neutral.minerals
       #   geysers = expo_resources.geysers
       # @return [Hash<Api::Point2D, UnitGroup>] Location => UnitGroup of resources (minerals+geysers)
       def expansions
@@ -503,24 +519,77 @@ module Sc2
       end
 
       # Returns a slice of #expansions where a base hasn't been built yet
+      # The has index is a build position and the value is a UnitGroup of resources for the base
       # @example
       #   # Lets find the nearest unoccupied expo
       #   expo_pos = expansions_unoccupied.keys.min { |p2d| p2d.distance_to(structures.hq.first) }
       #   # What minerals/geysers does it have?
       #   puts expansions_unoccupied[expo_pos].minerals # or expansions[expo_pos]... => UnitGroup
       #   puts expansions_unoccupied[expo_pos].geysers # or expansions[expo_pos]... => UnitGroup
-      # @return [Hash<Api::Point2D], UnitGroup] Location => UnitGroup of resources (minerals+geysers)
+      # @return [Hash<Api::Point2D, UnitGroup>] Location => UnitGroup of resources (minerals+geysers)
       def expansions_unoccupied
         taken_bases = bot.structures.hq.map { |hq| hq.pos.to_p2d } + bot.enemy.structures.hq.map { |hq| hq.pos.to_p2d }
         remaining_points = expansion_points - taken_bases
         expansions.slice(*remaining_points)
       end
 
+      # Gets minerals for a base or base position
+      # @param base [Api::Unit, Sc2::Position] base Unit or Position
+      # @return [Sc2::UnitGroup] UnitGroup of minerals for the base
+      def minerals_for_base(base)
+        # resources_for_base contains what we need, but slice neutral.minerals,
+        # so that only active patches remain
+        bot.neutral.minerals.slice(*resources_for_base(base).minerals.tags)
+      end
+
+      # Gets geysers for a base or base position
+      # @param base [Api::Unit, Sc2::Position] base Unit or Position
+      # @return [Sc2::UnitGroup] UnitGroup of geysers for the base
+      def geysers_for_base(base)
+        resources_for_base(base).geysers
+      end
+
+      # @private
+      # @param base [Api::Unit, Sc2::Position] base Unit or Position
+      # @return [Sc2::UnitGroup] UnitGroup of resources (minerals+geysers)
+      private def resources_for_base(base)
+        pos = base.is_a?(Api::Unit) ? base.pos : base
+
+        # If we have a base setup for this exact position, use it
+        if expansions.has_key?(pos)
+          return expansions[pos]
+        end
+
+        # Tolerance for misplaced base: Find the nearest base to this position
+        pos = expansion_points.min_by { |p| p.distance_to(pos) }
+
+        expansions[pos]
+      end
+
+      # Gets gasses for a base or base position
+      # @param base [Api::Unit, Sc2::Position] base Unit or Position
+      # @return [Sc2::UnitGroup] UnitGroup of geysers for the base
+      def gas_for_base(base)
+        # No gas structures at all yet, return nothing
+        return UnitGroup.new if bot.structures.gas.size.zero?
+
+        geysers = geysers_for_base(base)
+
+        # Mineral-only base, return nothing
+        return UnitGroup.new if geysers.size == 0
+
+        # Loop and collect gasses places exactly on-top of geysers
+        bot.structures.gas.select do |gas|
+          geysers.any? { |geyser| geyser.pos.to_p2d.eql?(gas.pos.to_p2d) }
+        end
+      end
+
       # Gets buildable point grid for squares of size, i.e. 3 = 3x3 placements
       # Uses pathing grid internally, to ignore taken positions
       # Does not query the api and is generally fast.
       # @param length [Integer] length of the building, 2 for depot/pylon, 3 for rax/gate
-      # @param on_creep [Boolean] whether this build locatin should be on creep
+      # @param on_creep [Boolean] whether this build location should be on creep
+      # @return [Array<Array<(Float, Float)>>] Array of [x,y] tuples
       def build_coordinates(length:, on_creep: false, in_power: false)
         length = 1 if length < 1
         @_build_coordinates ||= {}

data/lib/sc2ai/player/units.rb

@@ -47,10 +47,10 @@ 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
-      # @!attribute event_units_created
+      # @note Morphed units should watch #event_units_type_changed
       #   @return [Sc2::UnitGroup] group of created units
       attr_accessor :event_units_created
 

data/lib/sc2ai/player.rb

@@ -97,7 +97,7 @@ module Sc2
       @difficulty = difficulty
       @ai_build = ai_build
       @realtime = false
-      @step_count = 1
+      @step_count = 2
 
       @enable_feature_layer = false
       @interface_options = {}
@@ -201,7 +201,7 @@ module Sc2
 
       # Override to customize initialization
       # Alias of before_join
-      # You can enable_feature_layer=true, set step_size, define
+      # You can enable_feature_layer=true, set step_count, define
       # @example
       #   def configure
       #     step_count = 4 # Update less frequently
@@ -490,6 +490,8 @@ module Sc2
     def started
       # Calculate expansions
       geo.expansions
+      # Set our start position base on camera
+      geo.start_position
     end
 
     # Moves emulation ahead and calls back #on_step
@@ -498,9 +500,7 @@ module Sc2
       # Sc2.logger.debug "#{self.class} step_forward"
 
       unless @realtime
-        # ##TODO: Numsteps as config
-        num_steps = 1
-        @api.step(num_steps)
+        @api.step(@step_count)
       end
 
       refresh_state
@@ -610,9 +610,9 @@ module Sc2
     # ##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_size being minimum of 1, so no zero-steps occur.
+    # 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_size
+    # desired_game_loop = current_game_loop + step_count
     # response = client.observation(game_loop: desired_game_loop)
     #
     #   if response.game_loop > desired_game_loop {

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

@@ -1,6 +1,15 @@
 module Api
   # Adds additional functionality to message object Api::Point
   module PointExtension
+    # @private
+    def hash
+      [x, y, z].hash
+    end
+
+    def eql?(other)
+      self.class == other.class && hash == other.hash
+    end
+
     # Creates a Point2D using x and y
     # @return [Api::Point2D]
     def to_p2d
@@ -13,6 +22,9 @@ module Api
       # @example
       #   Api::Point[1,2,3] # Where x is 1.0, y is 2.0 and z is 3.0
       # @return [Api::Point]
+      # @param [Float] x
+      # @param [Float] y
+      # @param [Float] z
       def [](x, y, z)
         Api::Point.new(x: x, y: y, z: z)
       end
@@ -20,4 +32,4 @@ module Api
   end
 end
 Api::Point.include Api::PointExtension
-Api::Point.include Api::PointExtension::ClassMethods
+Api::Point.extend Api::PointExtension::ClassMethods