sc2ai 0.6.1 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddd8bd1e37b50ba6d4e89c24fb330d646589d869cc53cf96a69624eaa0e6133c
-  data.tar.gz: d88b2674f094621c11aa7de9a0c59ae82a6668aa6c882783a54236776ceb9f37
+  metadata.gz: 9da11456b2d9014945dc54f3a92dfc47cef7ecf40be7facaceb75bc8a04df9b1
+  data.tar.gz: e5926c8416141ef1a8677e8fb0832126414cdbed3729951f236ecab14274d336
 SHA512:
-  metadata.gz: 10c922d086149c4f2e4cac906607d7f5fb2c31fde1ace225186b0d83342efaea6720c48b799eb01e4d29fec5b295a4890d44b9cf803bb0c47e75e5830489c466
-  data.tar.gz: 7430bdcd6935e457b88b562838c0dc112f28ecdfbacd072293ddfdf358d065287dcdbc300bb7cc76b4efe0e671a82006f9d53766b79bd2d006496982061e3fc7
+  metadata.gz: 3ce8e35ea773557def35d44eff9dfc63a475b09c82ad573644cae647b222da83f65047a0a935d0465aad5919002144e6c28543792539f4783dad88700225f5ef
+  data.tar.gz: 5848c68e72fad356096f6b7bf2da049ee9f7f3a4c36676f682401d9e612f71d26d8950d94c733e4cda04887592a2be030faadc3f6e2d1b918528c2aa63e5eada

data/docker_build/Dockerfile.aiarenabot

@@ -0,0 +1,12 @@
+FROM aiarena/arenaclient-bot:latest AS build
+LABEL service="bot-ruby-sc2ai-local"
+
+USER root
+WORKDIR /bots/
+
+ARG DEBIAN_DISABLE_RUBYGEMS_INTEGRATION=true
+
+RUN apt-get update
+RUN apt-get install -y unzip
+
+ENTRYPOINT ["/bin/bash"]

data/docker_build/Dockerfile.ruby

@@ -4,12 +4,12 @@ LABEL service="bot-ruby-local"
 USER root
 WORKDIR /root/ruby-builder
 
-ARG RUBY_VERSION=3.4.2
+ARG RUBY_VERSION=3.4.3
 ARG DEBIAN_DISABLE_RUBYGEMS_INTEGRATION=true
 
 # Deps - Ruby build
 RUN apt-get update
-RUN apt install --assume-yes rustc curl build-essential libssl-dev zlib1g-dev libgmp-dev libffi-dev uuid-dev libopenblas0-serial
+RUN apt install --assume-yes rustc curl build-essential libssl-dev zlib1g-dev libgmp-dev libffi-dev uuid-dev
 
 # Deps - libyaml from source
 RUN curl https://pyyaml.org/download/libyaml/yaml-0.2.5.tar.gz -o yaml-0.2.5.tar.gz
@@ -33,20 +33,20 @@ RUN rm yaml-0.2.5.tar.gz
 
 # Package config
 # numo-linalg needs openblas, copy to ruby-prefix/lib/ dir.
-#RUN apt download libopenblas0-serial
-#RUN mkdir openblas
-#RUN dpkg-deb -x ./libopenblas*.deb openblas
-#RUN cp -d openblas/usr/lib/x86_64-linux-gnu/openblas-serial/* /root/ruby-builder/.ruby/lib/
-#RUN rm -rf ./openblas
-#RUN rm ./libopenblas0-serial*.deb
-
-#RUN apt download libgfortran5
-#RUN mkdir libgfortran5
-#RUN dpkg-deb -x ./libgfortran*.deb libgfortran5
-#RUN find libgfortran5
-#RUN cp libgfortran5/usr/lib/x86_64-linux-gnu/libgfortran.so.5 /root/ruby-builder/.ruby/lib/
-#RUN rm -rf ./libgfortran5
-#RUN rm ./libgfortran5*.deb
+RUN apt download libopenblas0-serial
+RUN mkdir openblas
+RUN dpkg-deb -x ./libopenblas*.deb openblas
+RUN cp -d openblas/usr/lib/x86_64-linux-gnu/openblas-serial/* /root/ruby-builder/.ruby/lib/
+RUN rm -rf ./openblas
+RUN rm ./libopenblas0-serial*.deb
+
+RUN apt download libgfortran5
+RUN mkdir libgfortran5
+RUN dpkg-deb -x ./libgfortran*.deb libgfortran5
+RUN find libgfortran5
+RUN cp libgfortran5/usr/lib/x86_64-linux-gnu/libgfortran.so.5 /root/ruby-builder/.ruby/lib/
+RUN rm -rf ./libgfortran5
+RUN rm ./libgfortran5*.deb
 
 RUN /root/ruby-builder/.ruby/bin/ruby --yjit -v
 
@@ -65,7 +65,7 @@ RUN /root/ruby-builder/.ruby/bin/bundle config set --global without test develop
 RUN apt-get update
 RUN apt-get purge $(aptitude search '~i!~M!~prequired!~pimportant!~R~prequired!~R~R~prequired!~R~pimportant!~R~R~pimportant!busybox!grub!initramfs-tools' | awk '{print $2}')  --assume-yes
 RUN apt-get purge aptitude  --assume-yes
-RUN apt-get install zip openssl build-essential libopenblas0-serial libffi-dev --assume-yes
+RUN apt-get install zip openssl build-essential libffi-dev --assume-yes
 RUN apt-get autoremove --assume-yes
 RUN apt-get clean --assume-yes
 

data/docker_build/docker-compose-base-image.yml

@@ -1,4 +1,3 @@
-version: "3.9"
 services:
   bot:
     image: dysonreturns/aiarena-ruby-builder:latest

data/docker_build/docker-compose-ladderzip.yml

@@ -1,4 +1,3 @@
-version: "3.9"
 services:
   bot:
     image: dysonreturns/aiarena-ruby-builder:latest

data/docker_build/docker-compose-versus-bot.yml

@@ -0,0 +1,15 @@
+services:
+  versus_bot:
+    container_name: versus_bot_container
+    image: dysonreturns/arenaclient-bot:local
+    environment:
+      - CPPFLAGS=-DPNG_ARM_NEON_OPT=0
+    platform: "linux/amd64"
+    tty: true
+    build:
+      dockerfile: ./Dockerfile.aiarenabot
+    ports:
+      - "${SERVER_BASE_PORT}:${SERVER_BASE_PORT}/udp"
+      - "${SERVER_GAME_PORT}:${SERVER_GAME_PORT}"
+      - "${CLIENT_BASE_PORT}:${CLIENT_BASE_PORT}/udp"
+      - "${CLIENT_GAME_PORT}:${CLIENT_GAME_PORT}"

data/lib/sc2ai/cli/cli.rb

@@ -2,6 +2,7 @@ require "thor"
 
 require "sc2ai/cli/new"
 require "sc2ai/cli/ladderzip"
+require "sc2ai/cli/versus_bot"
 
 module Sc2
   # Command line utilities
@@ -16,6 +17,7 @@ module Sc2
 
     register(Sc2::Cli::New, "new", "new BOTNAME RACE", "Creates botname folder with bot template")
     register(Sc2::Cli::Ladderzip, "ladderzip", "ladderzip BOTNAME", "Prepares a zip via docker for supplied aiarena bot name")
+    register(Sc2::Cli::VersusBot, "vsbot", "vsbot FILENAME", "Copies target zip to docker and starts a match")
 
     # TODO: Use thor's #ask and other methods helpers of raw $stdin and puts.
     desc "setup410", "Downloads and install SC2 v4.10"
@@ -70,7 +72,11 @@ module Sc2
         say "Generating sc2ai.yml to always use 4.10..."
         Sc2.config.config_file.write({"version" => "4.10"}.to_yaml.to_s)
         say ""
-        say "Done. You're good to go.", :green
+        say "Done. You're good to go."
+        say "To run an example match, execute:"
+        say ""
+        say "ruby run_example_match.rb", :green
+        say ""
       ensure
         Sc2::ClientManager.stop(0)
       end
@@ -95,23 +101,6 @@ module Sc2
       Sc2.logger.info "  interface_options: #{$bot.interface_options}"
     end
 
-    # desc "ladderzip", "Uses docker to cross-compile a compatible binary for the ladder"
-    # def ladderzip
-    # end
-
-    # desc "ladderquickzip", "Ladder zip, if you have no additional gems installed."
-    # long_desc <<-LONGDESC
-    #   `sc2ai ladderzip_basic` will download a portable ruby and gems, then copy your bot files into a zip file.
-    #
-    #   If you have added any gems which need compiling, this option is not for you.
-    #   Any gems built with native extensions will likely not be targeting the linux platform and be nonfunctional.
-    #
-    #   For a cross-platform build, use ladderzip instead. This will launch a Docker container to compile a zip for you.
-    # LONGDESC
-    # def ladderquickzip
-    #   raise Sc2::Error, "Not yet implemented."
-    # end
-
     desc "laddermatch", "Joins a ladder match as per aiarena spec"
     option :GamePort, required: true, desc: "SC2 port. Corresponds to SC2 launch option '-port'"
     option :LadderServer, required: true, desc: "SC2 server ip or hostname"
@@ -147,16 +136,6 @@ module Sc2
         $bot.play
       end.wait
     end
-
-    # desc "install APP_NAME", "install one of the available apps"   # [4]
-    # method_options :force => :boolean, :alias => :string           # [5]
-    # def install(name)
-    #   user_alias = options[:alias]
-    #   if options.force?
-    #     # do something
-    #   end
-    #   # other code
-    # end
   end
   # standard:enable Style/GlobalVars
 end

data/lib/sc2ai/cli/ladderzip.rb

@@ -78,6 +78,10 @@ module Sc2
         # create_link("./.build/#{botname}", "./bin/ladder")
       end
 
+      def create_ladderbots_json
+        template("ladderzip/ladderbots.json", "./.build/ladderbots.json")
+      end
+
       def start_container
         cmd = "docker compose -f #{@compose_file} up bot -d --force-recreate"
         Kernel.system(cmd)
@@ -95,6 +99,7 @@ module Sc2
         ignore_pattern -= include_pattern
 
         include_pattern.collect! { |pt| pt.delete_prefix("!") }
+        include_pattern.collect! { |pt| pt + "**/*" if pt.ends_with?("/") }
 
         files = Dir.glob("**/*")
 

data/lib/sc2ai/cli/versus_bot.rb

@@ -0,0 +1,305 @@
+module Sc2
+  # Command line utilities
+  class Cli < Thor
+    # Command line action allowing your bot to play vs a ladder bot via docker
+    class VersusBot < Thor::Group
+      # standard:disable Style/GlobalVars
+      include Thor::Actions
+
+      # Define arguments and options
+      argument :filename, desc: "Path to zip. Relative or absolute."
+      argument :map, desc: "Absolute path or shot name, i.e. 'ThunderbirdAIE', 'ThunderbirdAIE.SC2Map'.", default: "ThunderbirdAIE"
+      desc "Sends a bot zip to the ladder and makes it play against us"
+
+      def get_botname
+        @enemy_botname = File.basename(filename, ".zip")
+      end
+
+      def docker_exists
+        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
+
+      def bot_validation
+        if Pathname("./boot.rb").exist?
+          say_status("detected boot.rb", "found", :green)
+        else
+          say_status("detected boot.rb", "not found", :red)
+          raise Sc2::Error, "boot.rb not found. Bot started from wrong directory."
+        end
+
+        ENV.delete("AIARENA")
+        require "./boot"
+
+        if $bot.is_a? Sc2::Player
+          say_status("instance $bot", $bot.class, :green)
+        else
+          say_status("instance $bot", $bot.class, :red)
+          raise Sc2::Error, "$bot instance nil or not Sc2::Player. Review boot.rb to ensure it creates $bot."
+        end
+      end
+
+      def self.source_paths
+        [Pathname(".").expand_path.to_s]
+      end
+
+      def self.source_root
+        Paths.template_root.to_s
+      end
+
+      def port_configuration
+        # Start with basic port setup
+        @port_config = Sc2::Ports.port_config_auto(num_players: 2)
+        say_status("port config", "configured", :green)
+        ENV["SERVER_BASE_PORT"] = @port_config.server_port_set.base_port.to_s
+        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
+        say_status("docker", "build local play container", :cyan)
+        @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}"
+        cmd = "docker compose #{@compose_args} build"
+        Kernel.system(cmd)
+      end
+
+      def versus_bot_validation
+        if Pathname(filename).exist?
+          say_status("checking zip #{filename}", "found", :green)
+        else
+          say_status("checking zip #{filename}", "not found", :red)
+          raise Sc2::Error, "#{filename} not found. Try an absolute path if relative will not detect."
+        end
+      end
+
+      def contains_ladderbot_json
+        # Max size of the portion where zip filenames are stored
+        max_end_of_cd_size = (1 << 16) - 1 + 22 + 20
+        searching_for_file = "ladderbots.json" # what we want to find
+        found = File.open(Pathname(filename).realpath, "rb") do |f|
+          # Borrowed code, will search near the end of a zip
+          if f.size > max_end_of_cd_size
+            f.seek(-max_end_of_cd_size, IO::SEEK_END)
+          end
+          content = f.read
+          content.include?(searching_for_file)
+        end
+
+        if found
+          say_status("zip contains ladderbots.json", "found", :green)
+        else
+          say_status("zip contains ladderbots.json", "not found", :red)
+          puts "#{filename} should contain ladderbots.json. Add the file to the zip and try again."
+          raise SystemExit
+        end
+      end
+
+      def start_container
+        say_status("docker", "starting bot container", :cyan)
+        cmd = "docker compose #{@compose_args} up versus_bot -d" ## { rand(20) == 0 ?  "--force-recreate" : "" }
+        Kernel.system(cmd)
+      end
+
+      def copy_opponent_zip
+        say_status("docker", "copying opponent...", :cyan)
+        cmd = "docker compose #{@compose_args} cp #{Pathname(filename).realpath} versus_bot:/bots/"
+        Kernel.system(cmd)
+      end
+
+      def extract_opponent
+        say_status("docker", "extracting opponent...", :cyan)
+        cmd = "docker compose #{@compose_args} exec --workdir /bots versus_bot unzip -o #{Pathname(filename).basename} -d #{@enemy_botname}"
+        Kernel.system(cmd)
+      end
+
+      def pull_ladderbots_json
+        require "tempfile"
+
+        say_status("docker", "pulling enemy 'ladderbots.json'", :cyan)
+
+        @temp_path = Tempfile.new("enemy_ladderbots.json").path
+
+        cmd = "docker compose #{@compose_args} cp versus_bot:/bots/#{@enemy_botname}/ladderbots.json #{@temp_path}"
+        Kernel.system(cmd)
+        if File.exist?(@temp_path)
+          say_status("docker", "pulled 'ladderbots.json' ok", :green)
+        else
+          say_status("docker", "error pulling 'ladderbots.json'", :red)
+          exit
+        end
+      end
+
+      def parse_enemy_config
+        say_status("docker", "configuring enemy", :cyan)
+        json = JSON.parse(File.read(@temp_path))
+        bot_json = json["Bots"][@enemy_botname]
+        @enemy_runtime = bot_json["Type"].downcase # "BinaryCpp",
+        @enemy_race = bot_json["Race"].upcase.to_sym
+        @enemy_filename = bot_json["FileName"]
+        @command = case @enemy_runtime
+        when "cppwin32"
+          "wine #{@enemy_filename}.exe"
+        when "cpplinux", "binarycpp"
+          "/bots/#{@enemy_filename}/#{@enemy_filename}"
+        when "dotnetcore"
+          "dotnet #{@enemy_filename}.dll"
+        when "java"
+          "java -jar #{@enemy_filename}.jar"
+        when "nodejs"
+          "node #{@enemy_filename}.js"
+        when "python"
+          "python run.py"
+        else
+          @enemy_filename
+        end
+
+        # Make executable
+        if %w[cpplinux binarycpp].include?(@enemy_runtime)
+          cmd = "docker compose #{@compose_args} exec --workdir /bots/#{@enemy_botname} versus_bot chmod +x #{@command}"
+          Kernel.system(cmd)
+        end
+
+        # Make data dir
+        say_status("docker", "ensure data directory exists", :cyan)
+        cmd = "docker compose #{@compose_args} exec --workdir /bots/#{@enemy_botname} versus_bot sh -c \"mkdir data && chmod +w data\""
+        Kernel.system(cmd)
+      end
+
+      def run_match
+        Async do
+          Sc2.logger.level = :info
+
+          client = Sc2::ClientManager.obtain(0)
+          enemy_client = Sc2::ClientManager.obtain(1)
+
+          if Gem.win_platform?
+            sleep(10)
+          end
+
+          # Ladder specific overrides
+          $bot.realtime = false
+          $bot.opponent_id = @enemy_botname
+
+          say_status("host", "connecting...", :cyan)
+          $bot.connect(host: client.host, port: client.port)
+          say_status("host", "creating game...", :cyan)
+          $bot.create_game(map: MapFile.new(map.to_s), players: [
+            $bot,
+            Sc2::Player.new(race: @enemy_race, name: @enemy_botname, type: Api::PlayerType::PARTICIPANT)
+          ], realtime: false)
+
+          begin
+            Async do
+              say_status("host", "joining game...", :cyan)
+              $bot.join_game(
+                server_host: client.host,
+                port_config: @port_config
+              )
+              $bot.add_listener($bot, klass: Sc2::Connection::StatusListener)
+              $bot.play
+
+              begin
+                safe_player_name = $bot.name.gsub(/\s*[^A-Za-z0-9.-]\s*/, "_").downcase
+                response = $bot.api.save_replay
+                path = Pathname(Paths.bot_data_replay_dir).join("autosave-#{safe_player_name}-vs-#{@enemy_botname}.SC2Replay")
+                f = File.new(path, "wb:ASCII-8BIT")
+                f.write_nonblock(response.data)
+                f.close
+              rescue
+                # Replay save failed
+              end
+              $bot.disconnect
+            end
+
+            Async do
+              say_status("opponent", "joining game...", :cyan)
+
+              # 192... ip
+              # host_ladder_ip = `docker compose #{@compose_args} exec versus_bot sh -c "getent ahostsv4 host.docker.internal | grep STREAM"`.split(" ").first.strip
+              # Local ip
+              # host_ladder_ip = `docker inspect -f '{{range.NetworkSettings.Networks}}{{.Gateway}}{{end}}' versus_bot_container`.strip
+              enemy_command = [@command,
+                # "--LadderServer #{client.host}",
+                # "--RealTime 0"
+                "--LadderServer host.docker.internal",
+                "--GamePort #{enemy_client.port}",
+                "--StartPort #{@port_config.start_port}",
+                "--OpponentId 00000000-0000-0000-0000-000000000000"]
+                .join(" ")
+
+              # cmd = "docker compose #{@compose_args} exec --workdir /bots/#{@enemy_botname} versus_bot bash -c '#{enemy_command}'"
+              cmd = "docker compose #{@compose_args} exec --workdir /bots/#{@enemy_botname} versus_bot bash -c '#{enemy_command}'"
+
+              puts cmd
+              process_options = {}
+              if Gem.win_platform?
+                process_options[:new_pgroup] = true
+              else
+                process_options[:pgroup] = true
+              end
+              # ::Async::Process.spawn(cmd, **process_options)
+              unless Kernel.system(cmd)
+                say_status("opponent", "exited with bad status", :red)
+                raise SystemExit
+              end
+            end
+          rescue => e
+            say_status("error", e.message, :red)
+            raise SystemExit
+            # Replay save failed
+          end
+        end.wait
+      ensure
+        ClientManager.stop_all
+      end
+
+      def stop_container
+        cmd = "docker stop versus_bot_container"
+        Kernel.system(cmd)
+      end
+
+      def bye
+        say "Game over."
+      end
+    end
+
+    # standard:enable Style/GlobalVars
+  end
+end

data/lib/sc2ai/local_play/client_manager.rb

@@ -10,7 +10,7 @@ module Sc2
 
     class << self
       extend Forwardable
-      def_delegators :instance, :obtain, :get, :start, :stop, :stop_all
+      def_delegators :instance, :obtain, :get, :start, :stop, :stop_all, :host
     end
 
     # Gets client for player X or starts an instance
@@ -63,6 +63,8 @@ module Sc2
       end
     end
 
+    attr_accessor :host
+
     private
 
     attr_accessor :clients, :ports

data/lib/sc2ai/player/game_state.rb

@@ -27,15 +27,10 @@ module Sc2
       # Access useful game information. Used in parsed pathing grid, terrain height, placement grid.
       # Holds Api::ResponseGameInfo::#start_locations.
       # @return [Api::ResponseGameInfo]
-      def game_info
-        if @game_info_task&.running?
-          @game_info_task&.wait
-          @game_info_task = nil
-        end
-        @game_info
-      end
+      attr_reader :game_info
 
       def game_info=(new_info)
+        @game_info_loop = game_loop || 0
         @game_info = new_info
       end
 

data/lib/sc2ai/player/geo.rb

@@ -81,6 +81,16 @@ module Sc2
         0..(map_height - 1)
       end
 
+      # Ensures a Sc2::Position's x/y stays in map tile range
+      # Prevents out of bound exceptions when working with minimap
+      # @param position [Sc2::Position, Api::Point2D]
+      # @return [Sc2::Position, Api::Point2D]
+      def clamp_to_grid(position)
+        position.y = position.y.clamp(map_tile_range_y)
+        position.x = position.x.clamp(map_tile_range_x)
+        position
+      end
+
       # Map Parsing functions -----
 
       # Returns whether a x/y (integer) is placeable as per minimap image data.
@@ -300,6 +310,13 @@ module Sc2
           # Fix endian for Numo bit parser
           data = image_data.data.unpack("b*").pack("B*")
           @parsed_pathing_grid = Numo::Bit.from_binary(data, [image_data.size.y, image_data.size.x])
+
+          # Remove erroneous mineral blockers as pathable
+          bot.neutral.select_type(Api::UnitTypeId::MINERALFIELD450).each do |mineral|
+            @parsed_pathing_grid[mineral.pos.y.to_i, mineral.pos.x] = 0
+            @parsed_pathing_grid[mineral.pos.y.to_i, mineral.pos.x - 1] = 0
+          end
+
         end
         @parsed_pathing_grid
       end
@@ -455,7 +472,7 @@ module Sc2
             while inner_y < length
               inner_x = 0
               while inner_x < length
-                if (input_grid[y + inner_y, x + inner_x]).zero?
+                if input_grid[y + inner_y, x + inner_x].zero?
                   output_grid[y / length, x / length] = 0
                   inner_y = length
                   break
@@ -507,7 +524,7 @@ module Sc2
         end
 
         # Split resources by Z axis
-        resources = bot.neutral.minerals + bot.neutral.geysers
+        resources = bot.neutral.minerals.reject_type(Api::UnitTypeId::MINERALFIELD450) + bot.neutral.geysers
         resource_group_z = resources.group_by do |resource|
           resource.pos.z.round # 32 units of Y, most maps will have use 3. round to nearest.
         end

data/lib/sc2ai/player/units.rb

@@ -304,6 +304,25 @@ module Sc2
         true
       end
 
+      # Checks whether you have met the tech requirements for building a specific unit type
+      # @param [Integer] unit_type_id
+      # @return [Boolean]
+      def tech_requirement_met?(unit_type_id)
+        created_from_unit_type = Api::TechTree.unit_created_from(unit_type_id: unit_type_id)
+        required_building = Api::TechTree.unit_type_creation_abilities(
+          source: created_from_unit_type.first,
+          target: unit_type_id
+        )[:required_building]
+
+        # Ensure we have required building, if there's such a requirement
+        if required_building
+          return false unless all_units.owned.select_type(required_building).completed.size > 0
+        end
+
+        # Ensure we have a completed source which it's created from
+        all_units.owned.select_type(created_from_unit_type).completed.size > 0
+      end
+
       # Micro/Unit-Specific ------
 
       # Returns whether Query Available Ability is true for unit and tag

data/lib/sc2ai/player.rb

@@ -529,8 +529,6 @@ module Sc2
       !IDENTIFIED_RACES.include?(race)
     end
 
-    private
-
     # @private
     CALLBACK_METHODS = %i[on_finish
       on_random_race_detected
@@ -545,6 +543,7 @@ module Sc2
       on_structure_started
       on_structure_completed
       on_unit_damaged]
+    private_constant :CALLBACK_METHODS
 
     # @private
     # @return [Array<Symbol>] callbacks implemented on player class
@@ -599,6 +598,7 @@ module Sc2
       # Process.clock_gettime(Process::CLOCK_MONOTONIC)
       step_to_loop = @realtime ? game_loop + @step_count : nil
       response_observation = @api.observation(game_loop: step_to_loop)
+      return if response_observation.nil?
 
       # Check if match has a result and callback
       on_player_result(response_observation.player_result) unless response_observation.player_result.empty?
@@ -671,10 +671,7 @@ module Sc2
     # Refreshes bot#game_info ignoring all caches
     # @return [void]
     public def refresh_game_info
-      @game_info_task = Async do
-        self.game_info = @api.game_info
-        @game_info_task = nil
-      end
+      self.game_info = @api.game_info
     end
 
     # Enemy -----------------------

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

@@ -58,75 +58,74 @@ module Api
     # @return [Boolean] whether unit has attribute
     # @example
     #   unit.has_attribute?(Api::Attribute::MECHANICAL)
-    #   unit.has_attribute?(:MECHANICAL)
     def has_attribute?(attribute)
       attributes.include? attribute
     end
 
     # Checks if unit is light
-    # @return [Boolean] whether unit has attribute :Light
+    # @return [Boolean] whether unit has attribute :LIGHT
     def is_light?
-      has_attribute?(:LIGHT)
+      has_attribute?(Api::Attribute::LIGHT)
     end
 
     # Checks if unit is armored
-    # @return [Boolean] whether unit has attribute :Armored
+    # @return [Boolean] whether unit has attribute :ARMORED
     def is_armored?
-      has_attribute?(:ARMORED)
+      has_attribute?(Api::Attribute::ARMORED)
     end
 
     # Checks if unit is biological
-    # @return [Boolean] whether unit has attribute :Biological
+    # @return [Boolean] whether unit has attribute :BIOLOGICAL
     def is_biological?
-      has_attribute?(:BIOLOGICAL)
+      has_attribute?(Api::Attribute::BIOLOGICAL)
     end
 
     # Checks if unit is mechanical
-    # @return [Boolean] whether unit has attribute :Mechanical
+    # @return [Boolean] whether unit has attribute :MECHANICAL
     def is_mechanical?
-      has_attribute?(:MECHANICAL)
+      has_attribute?(Api::Attribute::MECHANICAL)
     end
 
     # Checks if unit is robotic
-    # @return [Boolean] whether unit has attribute :Robotic
+    # @return [Boolean] whether unit has attribute :ROBOTIC
     def is_robotic?
-      has_attribute?(:ROBOTIC)
+      has_attribute?(Api::Attribute::ROBOTIC)
     end
 
     # Checks if unit is psionic
-    # @return [Boolean] whether unit has attribute :Psionic
+    # @return [Boolean] whether unit has attribute :PSIONIC
     def is_psionic?
-      has_attribute?(:PSIONIC)
+      has_attribute?(Api::Attribute::PSIONIC)
     end
 
     # Checks if unit is massive
-    # @return [Boolean] whether unit has attribute :Massive
+    # @return [Boolean] whether unit has attribute :MASSIVE
     def is_massive?
-      has_attribute?(:MASSIVE)
+      has_attribute?(Api::Attribute::MASSIVE)
     end
 
     # Checks if unit is structure
-    # @return [Boolean] whether unit has attribute :Structure
+    # @return [Boolean] whether unit has attribute :STRUCTURE
     def is_structure?
-      has_attribute?(:STRUCTURE)
+      has_attribute?(Api::Attribute::STRUCTURE)
     end
 
     # Checks if unit is hovering
-    # @return [Boolean] whether unit has attribute :Hover
+    # @return [Boolean] whether unit has attribute :HOVER
     def is_hover?
-      has_attribute?(:HOVER)
+      has_attribute?(Api::Attribute::HOVER)
     end
 
     # Checks if unit is heroic
-    # @return [Boolean] whether unit has attribute :Heroic
+    # @return [Boolean] whether unit has attribute :HEROIC
     def is_heroic?
-      has_attribute?(:HEROIC)
+      has_attribute?(Api::Attribute::HEROIC)
     end
 
     # Checks if unit is summoned
-    # @return [Boolean] whether unit has attribute :Summoned
+    # @return [Boolean] whether unit has attribute :SUMMONED
     def is_summoned?
-      has_attribute?(:SUMMONED)
+      has_attribute?(Api::Attribute::SUMMONED)
     end
 
     # @!group Virtual properties

data/lib/sc2ai/unit_group/filter_ext.rb

@@ -86,6 +86,17 @@ module Sc2
       Api::UnitTypeId::SPORECRAWLER
     ].freeze
 
+    # Protoss: An array of unit types warped from Warp Gate.
+    # @return [Array<Integer>]
+    TYPE_WARPGATE_UNIT = [
+      Api::UnitTypeId::ZEALOT,
+      Api::UnitTypeId::STALKER,
+      Api::UnitTypeId::HIGHTEMPLAR,
+      Api::UnitTypeId::DARKTEMPLAR,
+      Api::UnitTypeId::SENTRY,
+      Api::UnitTypeId::ADEPT
+    ].freeze
+
     # Returns a new UnitGroup containing all units matching unit type id(s)
     # Multiple values work as an "OR" filter
     # @example
@@ -172,7 +183,7 @@ module Sc2
     def select_attribute(attributes)
       cached("#{__method__}:#{attributes.hash}") do
         attributes = [attributes] unless attributes.is_a? Array
-        attributes = attributes.map { |a| a.is_a?(Symbol) ? a : Api::Attribute.lookup(a) }
+        attributes = attributes.map { |a| a.is_a?(Symbol) ? Api::Attribute.lookup(a) : a }
         select do |unit|
           attributes & unit.attributes == attributes
         end
@@ -192,7 +203,7 @@ module Sc2
     def reject_attribute(attributes)
       cached("#{__method__}:#{attributes.hash}") do
         attributes = [attributes] unless attributes.is_a? Array
-        attributes = attributes.map { |a| a.is_a?(Symbol) ? a : Api::Attribute.lookup(a) }
+        attributes = attributes.map { |a| a.is_a?(Symbol) ? Api::Attribute.lookup(a) : a }
         reject do |unit|
           unit.attributes & attributes == attributes
         end

data/lib/sc2ai/version.rb

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

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

@@ -8,13 +8,7 @@ ruby_dir=$base_dir/.ruby
 export PATH=$ruby_dir/bin:$PATH
 export LD_LIBRARY_PATH=$(ruby -e 'puts RbConfig::CONFIG["libdir"]')
 
-# Conservative heap sizes are based on 2x a tested medium-sized game
-export RUBY_GC_HEAP_INIT_SIZE_40_SLOTS=340000
-export RUBY_GC_HEAP_INIT_SIZE_80_SLOTS=50000
-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
-
+export RUBY_YJIT_ENABLE=1
 export AIARENA=true
 sc2ai ladderconfig
 exec sc2ai laddermatch "$@" 1>&2

data/lib/templates/ladderzip/ladderbots.json.tt

@@ -0,0 +1,11 @@
+{
+	"Bots": {
+		"<%= botname %>": {
+			"Race": "<%= Api::Race.lookup($bot.race).to_s.capitalize %>",
+			"Type": "BinaryCpp",
+			"RootPath": "./",
+			"FileName": "<%= botname %>",
+			"Debug": false
+		}
+	}
+}

data/lib/templates/new/.ladderignore

@@ -21,7 +21,7 @@ test/
 tmp/
 .byebug_history
 .bundle/
-vendor/bundle
+vendor/bundle/
 lib/bundler/man/
 
 # Other

data/sig/sc2ai.rbs

@@ -1012,6 +1012,11 @@ module Sc2
       # Checks whether you have the resources to
       def can_afford_upgrade?: (untyped upgrade_id) -> bool
 
+      # Checks whether you have met the tech requirements for building a specific unit type
+      # 
+      # _@param_ `unit_type_id`
+      def tech_requirement_met?: (Integer unit_type_id) -> bool
+
       # Returns whether Query Available Ability is true for unit and tag
       # Queries API if necessary. Uses batching in the background.
       # 
@@ -1142,6 +1147,11 @@ module Sc2
       # Checks whether you have the resources to
       def can_afford_upgrade?: (untyped upgrade_id) -> bool
 
+      # Checks whether you have met the tech requirements for building a specific unit type
+      # 
+      # _@param_ `unit_type_id`
+      def tech_requirement_met?: (Integer unit_type_id) -> bool
+
       # Returns whether Query Available Ability is true for unit and tag
       # Queries API if necessary. Uses batching in the background.
       # 
@@ -1268,6 +1278,12 @@ module Sc2
       # Returns zero to map_height-1 as range
       def map_tile_range_y: () -> ::Range[untyped]
 
+      # Ensures a Sc2::Position's x/y stays in map tile range
+      # Prevents out of bound exceptions when working with minimap
+      # 
+      # _@param_ `position`
+      def clamp_to_grid: ((Sc2::Position | Api::Point2D) position) -> (Sc2::Position | Api::Point2D)
+
       # Returns whether a x/y (integer) is placeable as per minimap image data.
       # It does not say whether a position is occupied by another building.
       # One pixel covers one whole block. Corrects floats on your behalf
@@ -1860,6 +1876,11 @@ module Sc2
       # Checks whether you have the resources to
       def can_afford_upgrade?: (untyped upgrade_id) -> bool
 
+      # Checks whether you have met the tech requirements for building a specific unit type
+      # 
+      # _@param_ `unit_type_id`
+      def tech_requirement_met?: (Integer unit_type_id) -> bool
+
       # Returns whether Query Available Ability is true for unit and tag
       # Queries API if necessary. Uses batching in the background.
       # 
@@ -2321,6 +2342,11 @@ module Sc2
       # Checks whether you have the resources to
       def can_afford_upgrade?: (untyped upgrade_id) -> bool
 
+      # Checks whether you have met the tech requirements for building a specific unit type
+      # 
+      # _@param_ `unit_type_id`
+      def tech_requirement_met?: (Integer unit_type_id) -> bool
+
       # Returns whether Query Available Ability is true for unit and tag
       # Queries API if necessary. Uses batching in the background.
       # 
@@ -3097,6 +3123,7 @@ module Sc2
     TYPE_REACTOR: ::Array[Integer]
     TYPE_BASES: ::Array[Integer]
     TYPE_DETECTORS: ::Array[Integer]
+    TYPE_WARPGATE_UNIT: ::Array[Integer]
 
     # _@param_ `units` — default to be added.
     # 
@@ -3727,6 +3754,7 @@ module Sc2
       TYPE_REACTOR: ::Array[Integer]
       TYPE_BASES: ::Array[Integer]
       TYPE_DETECTORS: ::Array[Integer]
+      TYPE_WARPGATE_UNIT: ::Array[Integer]
 
       # _@param_ `unit_group`
       def initialize: (Sc2::UnitGroup unit_group) -> void
@@ -4068,6 +4096,9 @@ module Sc2
 
     def initialize: () -> void
 
+    # Returns the value of attribute host.
+    attr_accessor host: untyped
+
     # Returns the value of attribute clients.
     attr_accessor clients: untyped
 
@@ -8475,63 +8506,62 @@ module Api
     # 
     # ```ruby
     # unit.has_attribute?(Api::Attribute::MECHANICAL)
-    # unit.has_attribute?(:MECHANICAL)
     # ```
     def has_attribute?: (untyped attribute) -> bool
 
     # Checks if unit is light
     # 
-    # _@return_ — whether unit has attribute :Light
+    # _@return_ — whether unit has attribute :LIGHT
     def is_light?: () -> bool
 
     # Checks if unit is armored
     # 
-    # _@return_ — whether unit has attribute :Armored
+    # _@return_ — whether unit has attribute :ARMORED
     def is_armored?: () -> bool
 
     # Checks if unit is biological
     # 
-    # _@return_ — whether unit has attribute :Biological
+    # _@return_ — whether unit has attribute :BIOLOGICAL
     def is_biological?: () -> bool
 
     # Checks if unit is mechanical
     # 
-    # _@return_ — whether unit has attribute :Mechanical
+    # _@return_ — whether unit has attribute :MECHANICAL
     def is_mechanical?: () -> bool
 
     # Checks if unit is robotic
     # 
-    # _@return_ — whether unit has attribute :Robotic
+    # _@return_ — whether unit has attribute :ROBOTIC
     def is_robotic?: () -> bool
 
     # Checks if unit is psionic
     # 
-    # _@return_ — whether unit has attribute :Psionic
+    # _@return_ — whether unit has attribute :PSIONIC
     def is_psionic?: () -> bool
 
     # Checks if unit is massive
     # 
-    # _@return_ — whether unit has attribute :Massive
+    # _@return_ — whether unit has attribute :MASSIVE
     def is_massive?: () -> bool
 
     # Checks if unit is structure
     # 
-    # _@return_ — whether unit has attribute :Structure
+    # _@return_ — whether unit has attribute :STRUCTURE
     def is_structure?: () -> bool
 
     # Checks if unit is hovering
     # 
-    # _@return_ — whether unit has attribute :Hover
+    # _@return_ — whether unit has attribute :HOVER
     def is_hover?: () -> bool
 
     # Checks if unit is heroic
     # 
-    # _@return_ — whether unit has attribute :Heroic
+    # _@return_ — whether unit has attribute :HEROIC
     def is_heroic?: () -> bool
 
     # Checks if unit is summoned
     # 
-    # _@return_ — whether unit has attribute :Summoned
+    # _@return_ — whether unit has attribute :SUMMONED
     def is_summoned?: () -> bool
 
     # Returns whether the unit is cloaked. Revealed cloak units also return true.
@@ -20424,63 +20454,62 @@ module Api
     # 
     # ```ruby
     # unit.has_attribute?(Api::Attribute::MECHANICAL)
-    # unit.has_attribute?(:MECHANICAL)
     # ```
     def has_attribute?: (untyped attribute) -> bool
 
     # Checks if unit is light
     # 
-    # _@return_ — whether unit has attribute :Light
+    # _@return_ — whether unit has attribute :LIGHT
     def is_light?: () -> bool
 
     # Checks if unit is armored
     # 
-    # _@return_ — whether unit has attribute :Armored
+    # _@return_ — whether unit has attribute :ARMORED
     def is_armored?: () -> bool
 
     # Checks if unit is biological
     # 
-    # _@return_ — whether unit has attribute :Biological
+    # _@return_ — whether unit has attribute :BIOLOGICAL
     def is_biological?: () -> bool
 
     # Checks if unit is mechanical
     # 
-    # _@return_ — whether unit has attribute :Mechanical
+    # _@return_ — whether unit has attribute :MECHANICAL
     def is_mechanical?: () -> bool
 
     # Checks if unit is robotic
     # 
-    # _@return_ — whether unit has attribute :Robotic
+    # _@return_ — whether unit has attribute :ROBOTIC
     def is_robotic?: () -> bool
 
     # Checks if unit is psionic
     # 
-    # _@return_ — whether unit has attribute :Psionic
+    # _@return_ — whether unit has attribute :PSIONIC
     def is_psionic?: () -> bool
 
     # Checks if unit is massive
     # 
-    # _@return_ — whether unit has attribute :Massive
+    # _@return_ — whether unit has attribute :MASSIVE
     def is_massive?: () -> bool
 
     # Checks if unit is structure
     # 
-    # _@return_ — whether unit has attribute :Structure
+    # _@return_ — whether unit has attribute :STRUCTURE
     def is_structure?: () -> bool
 
     # Checks if unit is hovering
     # 
-    # _@return_ — whether unit has attribute :Hover
+    # _@return_ — whether unit has attribute :HOVER
     def is_hover?: () -> bool
 
     # Checks if unit is heroic
     # 
-    # _@return_ — whether unit has attribute :Heroic
+    # _@return_ — whether unit has attribute :HEROIC
     def is_heroic?: () -> bool
 
     # Checks if unit is summoned
     # 
-    # _@return_ — whether unit has attribute :Summoned
+    # _@return_ — whether unit has attribute :SUMMONED
     def is_summoned?: () -> bool
 
     # Returns whether the unit is cloaked. Revealed cloak units also return true.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sc2ai
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.5
 platform: ruby
 authors:
 - Dyson Returns
 bindir: exe
 cert_chain: []
-date: 2025-02-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -65,6 +65,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: numo-narray
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +122,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: logger
+  name: fiddle
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,7 +136,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fiddle
+  name: cgi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,7 +150,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: reline
+  name: irb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -354,9 +368,11 @@ files:
 - data/setup/setup.SC2Replay
 - data/stableid.json
 - data/versions.json
+- docker_build/Dockerfile.aiarenabot
 - docker_build/Dockerfile.ruby
 - docker_build/docker-compose-base-image.yml
 - docker_build/docker-compose-ladderzip.yml
+- docker_build/docker-compose-versus-bot.yml
 - exe/sc2ai
 - lib/sc2ai.rb
 - lib/sc2ai/api/ability_id.rb
@@ -370,6 +386,7 @@ files:
 - lib/sc2ai/cli/cli.rb
 - lib/sc2ai/cli/ladderzip.rb
 - lib/sc2ai/cli/new.rb
+- lib/sc2ai/cli/versus_bot.rb
 - lib/sc2ai/configuration.rb
 - lib/sc2ai/connection.rb
 - lib/sc2ai/connection/connection_listener.rb
@@ -419,6 +436,7 @@ files:
 - lib/sc2ai/unit_group/geo_ext.rb
 - lib/sc2ai/version.rb
 - lib/templates/ladderzip/bin/ladder.tt
+- lib/templates/ladderzip/ladderbots.json.tt
 - lib/templates/new/.ladderignore
 - lib/templates/new/Gemfile.tt
 - lib/templates/new/api/common.proto
@@ -454,14 +472,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.3.7
+      version: 3.3.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.6.8
 specification_version: 4
 summary: STARCRAFT® II AI API
 test_files: []