sc2ai 0.0.0.pre → 0.0.3

data/lib/sc2ai/local_play/match.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+require_relative "../connection/status_listener"
+
+module Sc2
+  # Runs a match using a map and player configuration
+  class Match
+    include Sc2::Connection::StatusListener
+
+    # Callback when game status changes
+    def on_status_change(status)
+      Sc2.logger.debug { "Status from Match: #{status}" }
+
+      # if status == :ended
+      #   # Go through each player, looking for result if we don't have one.
+      #   api_players.each do |player|
+      #     Sc2.logger.debug { "TODO: Get results for players" }
+      #     # result = player.result
+      #     Sc2.logger.debug { "Leaving Game and Disconnecting players" }
+      #     player.leave_game
+      #     player.disconnect
+      #   end
+      # end
+    end
+
+    # TODO: DEFINE REALTIME AS A PARAM
+
+    # @!attribute players Sets the Player(s) for the match
+    #   @return [Array<Sc2::Player>] an array of assigned players (ai,bots,humans,observers)
+    attr_accessor :players
+
+    # @!attribute map Sets the Map for the match
+    #   @return [Sc2::MapFile] the Map for the match
+    attr_reader :map
+
+    # @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)
+      @players = players || []
+      @map = if map.is_a?(String)
+        MapFile.new(map.to_s)
+      else
+        map
+      end
+    end
+
+    # Validates a runnable match and raises an error if invalid
+    # @return [void]
+    # @raise [Sc2:Error]
+    def validate
+      @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?
+    end
+
+    # Connects players to instances, creates a game and joins everyone to play!
+    # @return [void]
+    def run
+      validate
+      Sc2.logger.debug { "Connecting players to client..." }
+
+      # Holds the game process and finishes when a status triggers it to end
+      Async do |run_task|
+        connect_players
+        setup_player_hooks
+
+        player_host.create_game(map:, players: @players)
+
+        api_players.each_with_index do |player, player_index|
+          run_task.async do
+            player.join_game(
+              server_host: ClientManager.get(player_index).host,
+              port_config:
+            )
+
+            result = player.play
+            Sc2.logger.debug { "Player(#{player_index}) Result: #{result}" }
+            autosave_replay(player)
+          ensure
+            Sc2.logger.debug { "Game over, disconnect players." }
+            # Suppress interrupt errors #$stderr.reopen File.new(File::NULL, "w")
+            player.disconnect
+            ClientManager.stop(player_index) # unless keep_clients_alive
+          end
+        end
+      rescue
+        # no op - clean exit from game may cause ws disconnection error
+      end.wait
+
+      nil
+    end
+
+    private
+
+    # Saves the replay from the player's perspective.
+    # Requires active client and connection.
+    def autosave_replay(player)
+      safe_player_name = player.name.gsub(/\s*[^A-Za-z0-9.-]\s*/, "_").downcase
+
+      response = player.api.save_replay
+      path = Pathname(Paths.bot_data_replay_dir).join("autosave-#{safe_player_name}.SC2Replay")
+      f = File.new(path, "wb:ASCII-8BIT")
+      f.write(response.data)
+      f.close
+    end
+
+    # Gets a PortConfig
+    # @return [Sc2::PortConfig] port configuration based on players
+    def port_config
+      # Sc2.logger.debug { "Get port config..." }
+      # Detect open ports
+      @port_config = Ports.port_config_auto(num_players: api_players.length)
+    rescue
+      # Fall back to increment method
+      @port_config = Ports.port_config_basic(start_port: 5000, num_players: api_players.length)
+    end
+
+    # def prepare_clients
+    #   Async do |task|
+    #     api_players.each_with_index do |player, i|
+    #       Sc2.logger.debug { "Obtain client for player #{i}: #{player.class}, #{player.name}"
+    #       ClientManager.obtain(i)
+    #     end
+    #   end
+    # end
+
+    # Gets a Sc2 client from Sc2::ClientManager and connects them
+    def connect_players
+      # Depending on number of players, api has different ready states
+      ready_statuses = (api_players.size > 1) ? [:launched] : %i[launched ready]
+
+      # For each player, attempt to connect and retry once after closing Sc2 in worst-case
+      api_players.each_with_index do |player, i|
+        1.upto(max_retires = 2) do |attempt|
+          Sc2.logger.debug { "Player(#{i}) Obtain client for: #{player.class}, #{player.name}" }
+          client = ClientManager.obtain(i)
+          sleep(8) if ENV["SC2PF"] == Paths::PF_WINDOWS
+          Sc2.logger.debug { "Player(#{i}) Connect to client: #{client.host}:#{client.port}" }
+          player.connect(host: client.host, port: client.port)
+          Sc2.logger.debug { "Player(#{i}) Connected." }
+          Sc2.logger.debug { "Player(#{i}) Status is: #{player.status}" }
+          break if ready_statuses.include?(player.status)
+
+          Sc2.logger.debug { "Player(#{i}) Attempt to leave game..." }
+          player.leave_game
+          break if ready_statuses.include?(player.status)
+
+          raise Error, "Player(#{i}) Unable to get client" unless attempt < max_retires
+
+          Sc2.logger.debug { "Player(#{i}) Leave failed. Retry by stopping client..." }
+          player.disconnect
+          ClientManager.stop(i)
+          next
+        end
+      end
+    end
+
+    # Configure hooks
+    def setup_player_hooks
+      api_players.each do |player|
+        # Clean surrender locally. Lapizistik taught me bad things.
+        def player.leave_game
+          debug_end_game(end_result: :Surrender)
+        end
+      end
+    end
+
+    # Returns a list of players which requires an Sc2 instance
+    # @return [Array<Sc2::Player>] players which requires_client?
+    def api_players
+      players.select(&:requires_client?)
+    end
+
+    # Returns the first player which requires an Api connection as the host
+    # @return [Sc2::Player] host
+    def player_host
+      raise Sc2::Error, "No host player found. API players are empty." if api_players.nil? || api_players.empty?
+      # noinspection RubyMismatchedReturnType
+      api_players.first
+    end
+  end
+end

data/lib/sc2ai/overrides/array.rb

@@ -0,0 +1,14 @@
+# Array extensions
+class Array
+  # Turns an Array of Api::Unit into a Sc2::UnitGroup
+  # @return [Sc2::UnitGroup] array converted to a unit group
+  def to_unit_group
+    Sc2::UnitGroup.new(self)
+  end
+
+  # Creates a Point2D from 0,1 as x,y
+  # @return [Api::Point2D]
+  def to_p2d
+    Api::Point2D.new(x: at(0), y: at(1))
+  end
+end

data/lib/sc2ai/overrides/async/process/child.rb

@@ -0,0 +1,31 @@
+# Overrides process spawn for windows pgroup
+
+require "async/process"
+
+module Async
+  module Process
+    class Child
+      def initialize(*args, **options)
+        # Setup a cross-thread notification pipe - nio4r can't monitor pids unfortunately:
+        pipe = ::IO.pipe
+        @input = Async::IO::Generic.new(pipe.first)
+        @output = pipe.last
+
+        @exit_status = nil
+
+        if Gem.win_platform?
+          options[:new_pgroup] = true
+        else
+          options[:pgroup] = true
+        end
+
+        @pid = ::Process.spawn(*args, **options)
+
+        @thread = Thread.new do
+          _, @exit_status = ::Process.wait2(@pid)
+          @output.close
+        end
+      end
+    end
+  end
+end

data/lib/sc2ai/overrides/kernel.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# @private
+# Patched from: rails/activesupport/lib/active_support/core_ext/kernel/reporting.rb
+# https://github.com/rails/rails/blob/04972d9b9ef60796dc8f0917817b5392d61fcf09/activesupport/lib/active_support/core_ext/kernel/reporting.rb#L26
+
+# Kernel extensions
+module Kernel
+  module_function
+
+  # Sets $VERBOSE to +nil+ for the duration of the block and back to its original
+  # value afterwards.
+  #
+  #   silence_warnings do
+  #     value = noisy_call # no warning voiced
+  #   end
+  #
+  #   noisy_call # warning voiced
+  def silence_warnings(&)
+    with_warnings(nil, &)
+  end
+
+  # Sets $VERBOSE for the duration of the block and back to its original
+  # value afterwards.
+  # noinspection RubyGlobalVariableNamingConvention
+  def with_warnings(flag)
+    old_verbose = $VERBOSE
+    $VERBOSE = flag
+    yield
+  ensure
+    $VERBOSE = old_verbose
+  end
+end

data/lib/sc2ai/paths.rb

@@ -0,0 +1,294 @@
+# frozen_string_literal: true
+
+require "tmpdir"
+require "pathname"
+
+module Sc2
+  # Helps determine common paths to sc2 install dir, executable and maps.
+  # It maintains some semblance of compatibility with python-sc2 config
+  #
+  # ENV['SC2PATH'] can be set manually to Starcraft 2 base directory for Linux
+  # ENV['SC2PF'] can and should be manually set to "WineLinux" when running Wine
+  # Credit to Hannes, Sean and Burny for setting the standard
+  class Paths
+    # Platform name for Windows
+    PF_WINDOWS = "Windows"
+    # Platform name for WSL1
+    PF_WSL1 = "WSL1"
+    # Platform name for WSL2
+    PF_WSL2 = "WSL2"
+    # Platform name macOS
+    PF_DARWIN = "Darwin"
+    # Platform name Linux
+    PF_LINUX = "Linux"
+    # Platform name for Wine
+    PF_WINE = "WineLinux"
+
+    # Where within user directory to locate ExecuteInfo.txt
+    BASE_DIR = {
+      PF_WINDOWS => "C:/Program Files (x86)/StarCraft II",
+      PF_WSL1 => "/mnt/c/Program Files (x86)/StarCraft II",
+      PF_WSL2 => "/mnt/c/Program Files (x86)/StarCraft II",
+      PF_DARWIN => "/Applications/StarCraft II",
+      PF_LINUX => "~/StarCraftII",
+      PF_WINE => "~/.wine/drive_c/Program Files (x86)/StarCraft II"
+    }.freeze
+
+    # Where within user directory to locate ExecuteInfo.txt
+    EXEC_INFO_PATH = {
+      PF_WINDOWS => "Documents/StarCraft II/ExecuteInfo.txt",
+      PF_WSL1 => "Documents/StarCraft II/ExecuteInfo.txt",
+      PF_WSL2 => "Documents/StarCraft II/ExecuteInfo.txt",
+      PF_DARWIN => "Library/Application Support/Blizzard/StarCraft II/ExecuteInfo.txt",
+      PF_LINUX => nil,
+      PF_WINE => nil
+    }.freeze
+
+    # Path helper for finding executable
+    BIN_PATH = {
+      PF_WINDOWS => "SC2_x64.exe",
+      PF_WSL1 => "SC2_x64.exe",
+      PF_WSL2 => "SC2_x64.exe",
+      PF_DARWIN => "SC2.app/Contents/MacOS/SC2",
+      PF_LINUX => "SC2_x64",
+      PF_WINE => "SC2_x64.exe"
+    }.freeze
+
+    # Working directory sub-folder per platform.
+    # Used when spawning client process on some platforms.
+    WORKING_DIR = {
+      PF_WINDOWS => "Support64",
+      PF_WSL1 => "Support64",
+      PF_WSL2 => "Support64",
+      PF_DARWIN => nil,
+      PF_LINUX => nil,
+      PF_WINE => "Support64"
+    }.freeze
+
+    class << self
+      # An array of available platforms
+      # @return [Array<String>] an array of valid platforms
+      def platforms
+        [PF_WINDOWS, PF_WSL1, PF_WSL2, PF_DARWIN, PF_LINUX, PF_WINE]
+      end
+
+      # Bucketed platform names follows convention
+      # Uses ENV['SC2PF'] if configured. This is the only way to set "WineLinux"
+      # @return ["Windows","WSL1","WSL2","Darwin","Linux","WineLinux"] string platform name
+      def platform
+        return ENV.fetch("SC2PF", nil) unless ENV["SC2PF"].to_s.strip.empty?
+
+        if Gem.win_platform?
+          ENV["SC2PF"] = PF_WINDOWS
+        elsif Gem::Platform.local.os == "darwin"
+          ENV["SC2PF"] = PF_DARWIN
+        elsif Gem::Platform.local.os == "linux"
+          ENV["SC2PF"] = PF_LINUX
+          if wsl?
+            ENV["SC2PF"] = wsl2? ? PF_WSL2 : PF_WSL1
+          end
+        end
+
+        unless ENV.fetch("SC2PF", false)
+          Sc2.logger.warn "unknown platform detected #{Gem::Platform.local.os}. manually set ENV['SC2PF']"
+        end
+        ENV.fetch("SC2PF", nil)
+      end
+
+      # Attempts to auto-detect the user's install directory via ExecuteInfo.txt
+      #   SC2PATH is required on WineLinux and Linux
+      # @return [String] path
+      def install_dir
+        if ENV.fetch("SC2PATH", false)
+          # Use if set via environment
+          path = ENV.fetch("SC2PATH")
+        else
+          # Otherwise try read from ExecuteInfo.txt
+          path = read_exec_info
+          if path.to_s.strip.empty?
+            # If not present in ExecuteInfo, try use sensible default
+            path = BASE_DIR[platform]
+          end
+        end
+        path = File.expand_path(path) if platform != PF_WINDOWS
+
+        ENV["SC2PATH"] = path
+      end
+
+      # Replays directory based on install_dir
+      # @return [String] replays directory
+      def replay_dir
+        Pathname(install_dir).join("Replays").to_s
+      end
+
+      # Maps directory based on install_dir
+      # @return [String] maps directory
+      def maps_dir
+        # Use Maps if exists, or as fallback if alternative not found
+        dir = Pathname(install_dir).join("Maps")
+        return dir.to_s if dir.exist?
+
+        # Use lowercase "maps" only if it exists
+        dir_alt = Pathname(install_dir).join("maps")
+        dir = dir_alt if dir_alt.exist?
+
+        dir.to_s
+      end
+
+      # Working directory if required by platform
+      # Some platforms the correct working directory for launch to find linked libraries
+      # @return [String,nil] string path or nil if not required
+      def exec_working_dir
+        cwd = WORKING_DIR[platform]
+        return nil if cwd.nil?
+
+        Pathname(install_dir).join(cwd).to_s
+      end
+
+      # Gets a path to latest Sc2 executable, or specific build's executable if defined
+      # @param base_build [Integer, nil] version to use if installed
+      # @return [String, nil] path to executable
+      # noinspection RubyMismatchedReturnType
+      def executable(base_build: nil)
+        # Use base_build if supplied
+        unless base_build.nil?
+          path = Pathname.new(version_dir).join("Base#{base_build}")
+          return path.join(BIN_PATH[platform]).to_s if path.exist?
+        end
+        # Get highest build number for folders /^Base\d$/
+        pattern = /Base(\d+)$/
+        path = Pathname.new(version_dir).glob("Base*")
+          .max { |a, b| a.to_s.match(pattern)[1] <=> b.to_s.match(pattern)[1] }
+        return path.join(BIN_PATH[platform]).to_s if path&.exist?
+
+        nil
+      end
+
+      # Returns project root directory
+      # @return [String] path because bundler does.
+      def project_root_dir
+        return Bundler.root.to_s if defined?(Bundler)
+
+        Dir.pwd
+      end
+
+      # For local and ladder play, your files modified at runtime should live in ./data
+      # @return [String] path to ./data
+      def bot_data_dir
+        dir = Pathname("./data")
+        dir.mkdir unless dir.exist?
+        dir.to_s
+      end
+
+      # Returns the local replay folder
+      # For local play, your replay filse are saved to ./replays
+      # @return [String] path to ./replays
+      def bot_data_replay_dir
+        dir = Pathname("./replays")
+        dir.mkdir unless dir.exist?
+        dir.to_s
+      end
+
+      # @private
+      # Root directory of gem itself for other bundled files
+      # @return [Pathname] path to gem folder which contains lib/,data/,etc.
+      def gem_root
+        Pathname.new(__dir__.to_s).parent.parent.expand_path
+      end
+
+      # @private
+      # Directory of template folders
+      # @return [Pathname] path to where template directories live, i.e. "new" and "ladder"
+      def template_root
+        Pathname.new(__dir__.to_s).parent.join("templates").expand_path
+      end
+
+      # @private
+      # Path to shipped versions.json
+      # @return [Pathname] path
+      def gem_data_versions_path
+        Pathname.new(gem_root).join("data", "versions.json")
+      end
+
+      # Gets system temp directory and creates /sc2ai
+      # @return [String] temporary directory for use with -tempDir
+      def generate_temp_dir
+        temp_dir = Pathname(Dir.tmpdir).join("sc2ai").mkpath
+        temp_dir.to_s
+      end
+
+      # Checks if running WSL
+      # @return [Boolean]
+      def wsl?
+        Gem::Platform.local.os == "linux" && (ENV.fetch("IS_WSL", false) || ENV.fetch("WSL_DISTRO_NAME", false))
+      end
+
+      # Checks if running WSL2 specifically on top of wsl? being true
+      # @return [Boolean]
+      def wsl2?
+        wsl? && ENV.fetch("WSL_INTEROP", false)
+      end
+
+      # Convert a path like "C:\\path\\To a\\Location" to "/mnt/c/path/To a/Location"
+      # @param path [String]
+      # @return [String] path converted
+      def win_to_wsl(path:)
+        "/mnt/" + path.sub(/\A([A-Z])(:)/) { ::Regexp.last_match(1).to_s.downcase }.tr("\\", "/")
+      end
+
+      # Convert a path like "/mnt/c/path/To a/Location" to "C:\\path\\To a\\Location"
+      # @param path [String]
+      # @return [String] path converted
+      def wsl_to_win(path:)
+        path.sub(%r{\A/mnt/([a-z])}) { "#{::Regexp.last_match(1).to_s.upcase}:" }.tr("/", "\\")
+      end
+
+      private
+
+      # Versions directory based on install_dir
+      # @return [String] install_dir + "/Versions"
+      def version_dir
+        Pathname(install_dir).join("Versions").to_s
+      end
+
+      # Loads version data
+      # @return [JSON] versions.json
+      def version_json
+        JSON.load_file(Pathname(__dir__.to_s).join("../data/versions.json"))
+      end
+
+      # Reads contents for ExecuteInfo.txt
+      # @return [String] contents of exec_info or empty string
+      def read_exec_info
+        return "" unless EXEC_INFO_PATH[platform]
+
+        # Read path ExecuteInfo.txt
+        exec_info_path = File.join(Dir.home, EXEC_INFO_PATH[platform])
+        content = File.read(exec_info_path)
+        dir = content.match(/ = (.*)Versions/)[1].to_s
+
+        # Platform-specific patches
+        if platform == PF_WSL1 || platform == PF_WSL2
+          dir = win_to_wsl(path: dir)
+          raise Pathname(dir).inspect
+        elsif PF_WINDOWS
+          dir = dir.tr("\\", "/")
+        end
+
+        dir = dir.chomp("\\").chomp("/")
+        return dir if File.exist?(dir)
+      rescue
+        ""
+      else
+        ""
+      end
+
+      # # Access singleton via Paths.instance
+      # private
+      #
+      # def instance
+      #   @_instance ||= new(self.platform)
+      # end
+    end
+  end
+end