# frozen_string_literal: true require "forwardable" require "numo/narray" require_relative "api/data" require_relative "connection/connection_listener" require_relative "connection/status_listener" require_relative "player/game_state" require_relative "player/units" require_relative "player/previous_state" require_relative "player/geo" require_relative "player/actions" require_relative "player/debug" module Sc2 # Allows defining Ai, Bot, BotProcess (external), Human or Observer for a Match class Player include GameState # include Sc2::Connection::ConnectionListener extend Forwardable def_delegators :@api, :add_listener # Known races for detecting race on Api::Race::Random or nil # @!attribute IDENTIFIED_RACES # @return [Array] IDENTIFIED_RACES = [Api::Race::Protoss, Api::Race::Terran, Api::Race::Zerg].freeze # @!attribute api # Manages connection to client and performs Requests # @see Sc2::Connection and Sc2::Connection::Requests specifically # @return [Sc2::Connection] attr_accessor :api # @!attribute realtime # Realtime mode does not require stepping. When you observe the current step is returned. # @return [Boolean] whether realtime is enabled (otherwise step-mode) attr_accessor :realtime # @!attribute step_count # @return [Integer] number of frames to step in step-mode, default 1 attr_accessor :step_count # @!attribute enable_feature_layer # Enables the feature layer at 1x1 pixels. Adds additional actions (UI and Spatial) at the cost of overall performance. # Must be configured before #join_game # @return [Boolean] attr_accessor :enable_feature_layer # @see #join_game for options # @return [Hash] attr_accessor :interface_options # @return [Integer] Api::Race enum attr_accessor :race # @return [String] in-game name attr_accessor :name # @return [Api::PlayerType::Participant, Api::PlayerType::Computer, Api::PlayerType::Observer] PlayerType attr_accessor :type # if @type is Api::PlayerType::Computer, set one of Api::Difficulty scale 1 to 10 # @see Api::Difficulty for options # @return [Api::Difficulty::VeryEasy] if easiest, int 1 # @return [Api::Difficulty::CheatInsane] if toughest, int 10 attr_accessor :difficulty # @see Api::AIBuild proto for options attr_accessor :ai_build # @return [String] ladder matches will set an opponent id attr_accessor :opponent_id # @param race [Integer] see {Api::Race} # @param name [String] # @param type [Integer] see {Api::PlayerType} # @param difficulty [Integer] see {Api::Difficulty} # @param ai_build [Integer] see {Api::AIBuild} def initialize(race:, name:, type: nil, difficulty: nil, ai_build: nil) # Be forgiving to symbols race = Api::Race.resolve(race) if race.is_a?(Symbol) type = Api::PlayerType.resolve(type) if type.is_a?(Symbol) difficulty = Api::Difficulty.resolve(difficulty) if difficulty.is_a?(Symbol) ai_build = Api::AIBuild.resolve(ai_build) if ai_build.is_a?(Symbol) # Yet strict on required fields raise ArgumentError, "unknown race: '#{race}'" if race.nil? || Api::Race.lookup(race).nil? raise ArgumentError, "unknown type: '#{type}'" if type.nil? || Api::PlayerType.lookup(type).nil? @race = race @name = name @type = type @difficulty = difficulty @ai_build = ai_build @realtime = false @step_count = 2 @enable_feature_layer = false @interface_options = {} end # Connection -------------------- # @!group Connection # Returns whether or not the player requires a sc2 instance # @return [Boolean] Sc2 client needed or not def requires_client? true end # Creates a new connection to Sc2 client # @param host [String] # @param port [Integer] # @see Sc2::Connection#initialize # @return [Sc2::Connection] def connect(host:, port:) @api&.close @api = Sc2::Connection.new(host:, port:) # @api.add_listener(self, klass: Connection::ConnectionListener) @api.add_listener(self, klass: Connection::StatusListener) @api.connect @api end # Terminates connection to Sc2 client # @return [void] def disconnect @api&.close end # @!endgroup Connection # API -------------------- # @!group Api # @param map [Sc2::MapFile] # @param players [Array] # @param realtime [Boolean] whether realtime mode (no manual Steps) def create_game(map:, players:, realtime: false) Sc2.logger.debug { "Creating game..." } @api.create_game(map:, players:, realtime:) end # @param server_host [String] ip address # @param port_config [Sc2::PortConfig] def join_game(server_host:, port_config:) Sc2.logger.debug { "Player \"#{@name}\" joining game..." } response = @api.join_game(name: @name, race: @race, server_host:, port_config:, enable_feature_layer: @enable_feature_layer, interface_options: @interface_options) if response.error != :EnumResponseJoinGameErrorUnset && response.error != :MissingParticipation raise Sc2::Error, "Player \"#{@name}\" join_game failed: #{response.error}" end add_listener(self, klass: Connection::StatusListener) response end # Multiplayer only. Disconnects from a multiplayer game, equivalent to surrender. Keeps client alive. def leave_game @api.leave_game end # @!endgroup Api # PLAYERS -------------------- # @private # Bot # race != None # name='' # type: Api::PlayerType::Participant # An object which interacts with an SC2 client and is game-aware. class Bot < Player include Units include Actions include Debug # @!attribute enemy # @return [Sc2::Player::Enemy] attr_accessor :enemy # @!attribute previous # @return [Sc2::Player::PreviousState] the previous state of the game attr_accessor :previous # @!attribute geo # @return [Sc2::Player::Geo] geo and map helper functions attr_accessor :geo def initialize(race:, name:) super(race:, name:, type: Api::PlayerType::Participant, difficulty: nil, ai_build: nil) @previous = Sc2::Player::PreviousState.new @geo = Sc2::Player::Geo.new(self) configure end # Override to customize initialization # Alias of before_join # You can enable_feature_layer=true, set step_count, define # @example # def configure # step_count = 4 # Update less frequently # enable_feature_layer = true # # end def configure end alias_method :before_join, :configure # TODO: If this suffices for Bot and Observer, they should share this code. # Initializes and refreshes game data and runs the game loop # @return [Api::Result::Victory, Api::Result::Defeat, Api::Result::Tie, Api::Result::Undecided] result def play # Step 0 prepare_start refresh_state started # Callback before first step is taken on_start # Callback for step 0 on_step puts "" # Step 1 to n loop do r = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC) perform_actions perform_debug_commands unless Sc2.ladder? step_forward print "\e[2K#{game_loop - @previous.game_loop} Steps Took (ms): #{(::Process.clock_gettime(::Process::CLOCK_MONOTONIC) - r) * 1000}\n\e[1A\r" return @result unless @result.nil? break if @status != :in_game end end # Override to perform steps before first on_step gets called. # Current game_loop is 0 and @api is available def on_start # Sc2.logger.debug { "#{self.class} on_start" } end # Override to implement your own game logic. # Gets called whenever the game moves forward. def on_step return unless is_a? Bot raise NotImplementedError, "You are required to override #{__method__} in your Bot with: def #{__method__}" # Sc2.logger.debug { "#{self.class}.#{__method__}" } # Sc2.logger.debug "on_step" end # Callbacks --- # Override to handle game result (:Victory/:Loss/:Tie) # Called when game has ended with a result, i.e. result = ::Victory # @param result [Symbol] Api::Result::Victory or Api::Result::Victory::Defeat or Api::Result::Victory::Undecided # @example # def on_finish(result) # if result == :Victory # puts "Yay!" # else # puts "Lets try again!" # end # end def on_finish(result) # Sc2.logger.debug { "#{self.class} on_finish" } end # Called when Random race is first detected. # Override to handle race identification of random enemy. # @param race [Integer] Api::Race::* excl *::Random def on_random_race_detected(race) end # Called on step if errors are present. Equivalent of UI red text errors. # Override to read action errors. # @param errors [Array] def on_action_errors(errors) # Sc2.logger.debug errors end # Actions this player performed since the last Observation. # Override to read actions successfully performed # @param actions [Array] a list of actions which were performed def on_actions_performed(actions) # Sc2.logger.debug actions end # Callback when observation.alerts is populated # @see enum Alert in sc2api.proto for options # Override to use alerts or read Player.observation.alerts # @example # alerts.each do |alert| # case alert # when :NuclearLaunchDetected # pp "TAKE COVER!" # when :NydusWormDetected # pp "FIND THE WORM!" # end # end # @param alerts [Array] array of Api::Alert::* def on_alerts(alerts) end # Callback when upgrades are completed, multiple might finish on the same observation. # @param upgrade_ids [Array] Api::UpgradeId::* def on_upgrades_completed(upgrade_ids) end # @private # Callback when effects occur. i.e. Scan, Storm, Corrosive Bile, Lurker Spike, etc. # @see Api::EffectId # @param effects [Array] Api::EffectId::* # def on_effects(effects); end # Callback, on observation parse when iterating over every unit # Can be useful for decorating additional properties on a unit before on_step # A Sc2::Player should override this to decorate additional properties def on_parse_observation_unit(unit) end # Callback for unit destroyed. Tags might be found in `previous.all_units` # This excludes unknown objects, like projectiles and only shows things the API has "seen" as a unit # Override to use in your bot class or use Player. # @param unit [Api::Unit] # @see Sc2::Player::Units#units_destroyed def on_unit_destroyed(unit) end # Callback for unit created. # Override to use in your bot class. # @param unit [Api::Unit] def on_unit_created(unit) end # Callback for unit type changing. # To detect certain unit creations, you should use this method to watch morphs. # Override to use in your bot class or use Player. # @param unit [Api::Unit] # @param previous_unit_type_id [Integer] Api::UnitTypeId::* def on_unit_type_changed(unit, previous_unit_type_id) end # Callback for structure building began # Override to use in your bot class. # @param unit [Api::Unit] def on_structure_started(unit) end # Callback for structure building is completed # Override to use in your bot class or use Player. # @param unit [Api::Unit] def on_structure_completed(unit) end # Callback for unit (Unit/Structure) taking damage # Override to use in your bot class or use Player. # @param unit [Api::Unit] # @param amount [Integer] of damage def on_unit_damaged(unit, amount) end # TODO: On enemy unit entered vision. enemy units+structures.tags - previous.units+structures.tags # def on_enemy_enters_vision(unit) # end # TODO: On enemy unit left vision. Potentially subtract units killed to prevent interference # def on_enemy_exits_vision(unit) # end private # Writes the current observation as json to data/debug_observation.json # Slows step to a crawl, so don't leave this on in the ladder. def debug_json_observation File.write("#{Paths.bot_data_dir}/debug_observation.json", observation.to_json) end end # A specialized type of player instance which each player has one of # This should never be initialized by hand class Enemy < Player include Units # Initializes your enemy form proto class << self # Creates an Enemy object after game has started using Api::GameInfo's Api::PlayerInfo # @param player_info [Api::PlayerInfo] # @return [Sc2::Player::Enemy] your opposing player def from_proto(player_info: nil) Sc2::Player::Enemy.new(race: player_info.race_requested, name: player_info.player_name, type: player_info.type, difficulty: player_info.difficulty, ai_build: player_info.ai_build) end end # Will attempt to loop over player units and set its race if it can detect. # Generally only used for enemy # @return [false,Integer] Api::Race if race detected, false otherwise def detect_race_from_units return false unless race_unknown? return false if units.nil? unit_race = Api::Race.resolve(units.first.unit_data.race) if Sc2::Player::IDENTIFIED_RACES.include?(unit_race) self.race = unit_race end end end # @private # Launches an external bot, such as a python practice partner by triggering an exteral executable. # Allows using CLI launch options hash or "laddorconfig.json"-complient launcher. class BotProcess < Player def initialize(race:, name:) super(race:, name:, type: Api::PlayerType::Participant) raise "not implemented" end end # A Computer opponent using the game's built-in AI for a Match class Computer < Player # @param race [Integer] (see Api::Race) # @param difficulty [Integer] see Api::Difficulty::VeryEasy,Api::Difficulty::VeryHard,etc.) # @param ai_build [Api::AIBuild::RandomBuild] (see Api::AIBuild) # @param name [String] # @return [Sc2::Computer] def initialize(race:, difficulty: Api::Difficulty::VeryEasy, ai_build: Api::AIBuild::RandomBuild, name: "Computer") difficulty = Api::Difficulty::VeryEasy if difficulty.nil? ai_build = Api::AIBuild::RandomBuild if ai_build.nil? raise Error, "unknown difficulty: '#{difficulty}'" if Api::Difficulty.lookup(difficulty).nil? raise Error, "unknown difficulty: '#{ai_build}'" if Api::AIBuild.lookup(ai_build).nil? super(race:, name:, type: Api::PlayerType::Computer, difficulty:, ai_build:) end # Returns whether or not the player requires a sc2 instance # @return [Boolean] false always for Player::Computer def requires_client? false end # @private def connect(host:, port:) raise Error, "Computer type can not connect to api" end end # A human player for a Match class Human < Player def initialize(race:, name:) super(race:, name:, type: Api::PlayerType::Participant) end end # A spectator for a Match class Observer < Player def initialize(name: nil) super(race: Api::Race::NoRace, name:, type: Api::PlayerType::Observer) end end # Data Parsing ------------------------ # Checks whether the Player#race is known. This is false on start for Random until scouted. # @return [Boolean] true if the race is Terran, Protoss or Zerg, or false unknown def race_unknown? !IDENTIFIED_RACES.include?(race) end private # Initialize data on step 0 before stepping and before on_start is called def prepare_start @data = Sc2::Data.new(@api.data) clear_action_queue clear_debug_command_queue end # Initialize step 0 after data has been gathered 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 # @return [Api::Observation] observation of the game state def step_forward # Sc2.logger.debug "#{self.class} step_forward" unless @realtime @api.step(@step_count) end refresh_state on_step if @result.nil? end # Refreshes game state for current loop. # Will update GameState#observation and GameState#game_info # @return [void] # TODO: After cleaning up all the comments, review whether this is too heavy or not. #perf #clean def refresh_state # Process.clock_gettime(Process::CLOCK_MONOTONIC) step_to_loop = @realtime ? game_loop + @step_count : nil response_observation = @api.observation(game_loop: step_to_loop) # Check if match has a result and callback on_player_result(response_observation.player_result) unless response_observation.player_result.empty? # Halt further processing if match is over return unless @result.nil? # Save previous frame before continuing @previous.reset(self) # Reset self.observation = response_observation.observation self.game_loop = observation.game_loop self.chats_received = response_observation.chat self.spent_minerals = 0 self.spent_vespene = 0 self.spent_supply = 0 # Geometric/map if observation.raw_data.map_state.visibility != previous.observation&.raw_data&.map_state&.visibility @parsed_visibility_grid = nil end # Only grab game_info if unset (loop 0 or first realtime loop). It's lazily loaded otherwise as needed # This is heavy processing, because it contains image data if game_info.nil? refresh_game_info set_enemy set_race_for_random if race == Api::Race::Random end parse_observation_units(response_observation.observation) # Having loaded all the necessities for the current state... # If we're on the first frame of the game, say previous state and current are the same # This is better than having a bunch of random zero and nil values @previous.reset(self) if @previous.all_units.nil? # Actions performed and errors (only if implemented) on_actions_performed(response_observation.actions) unless response_observation.actions.empty? on_action_errors(response_observation.action_errors) unless response_observation.action_errors.empty? on_alerts(observation.alerts) unless observation.alerts.empty? # Diff previous observation upgrades to see if anything new completed new_upgrades = observation.raw_data.player.upgrade_ids - @previous.observation.raw_data.player.upgrade_ids on_upgrades_completed(new_upgrades) unless new_upgrades.empty? # Dead units raw_dead_unit_tags = observation.raw_data&.event&.dead_units @event_units_destroyed = UnitGroup.new raw_dead_unit_tags&.each do |dog_tag| dead_unit = previous.all_units[dog_tag] unless dead_unit.nil? @event_units_destroyed.add(dead_unit) on_unit_destroyed(dead_unit) end end # If enemy is not known, try detect every couple of frames based on units if enemy.race_unknown? && enemy.units.size > 0 detected_race = enemy.detect_race_from_units on_random_race_detected(detected_race) if detected_race end end # @private # Refreshes bot#game_info ignoring all caches # @return [void] public def refresh_game_info self.game_info = @api.game_info end # Enemy ----------------------- # If you're random, best to set #race to match after launched def set_race_for_random player_info = game_info.player_info.find { |pi| pi.player_id == observation.player_common.player_id } self.race = player_info.race_actual end # Sets enemy once #game_info becomes available on start def set_enemy enemy_player_info = game_info.player_info.find { |pi| pi.player_id != observation.player_common.player_id } self.enemy = Sc2::Player::Enemy.from_proto(player_info: enemy_player_info) if enemy.nil? self.enemy = Sc2::Player::Enemy.new(name: "Unknown", race: Api::Race::Random) end if enemy.race_unknown? detected_race = enemy.detect_race_from_units on_random_race_detected(detected_race) if detected_race end end private # @private # Parses player result and neatly calls back to on_finish # If overriding this, it must manually do callback to player on_finish # @return [Symbol,nil] Api::Result::** def on_player_result(player_results) player_results.each do |player_result| if player_result.player_id == common.player_id @result = player_result.result on_finish(player_result.result) end end nil end end end