sc2ai 0.0.0.pre → 0.0.2

data/lib/templates/new/api/score.proto

@@ -0,0 +1,108 @@
+
+syntax = "proto2";
+
+package Api;
+
+message Score {
+  enum ScoreType {
+    Curriculum = 1;                // map generated score (from curriculum maps with special scoring)
+    Melee = 2;                     // summation of in-progress and current units/buildings value + minerals + vespene
+  }
+
+  optional ScoreType score_type = 6;
+  optional int32 score = 7;                 // Note: check score_type to know whether this is a melee score or curriculum score
+  optional ScoreDetails score_details = 8;
+}
+
+message CategoryScoreDetails {
+  optional float none = 1; // Used when no other category is configured in game data
+  optional float army = 2;
+  optional float economy = 3;
+  optional float technology = 4;
+  optional float upgrade = 5;
+}
+
+message VitalScoreDetails {
+  optional float life = 1;
+  optional float shields = 2;
+  optional float energy = 3;
+}
+
+message ScoreDetails {
+  // Sum of time any available structure able to produce a unit is not. The time stacks, as in, three idle barracks will increase idle_production_time three times quicker than just one.
+  optional float idle_production_time = 1;
+  // Sum of time any worker is not mining. Note a worker building is not idle and three idle workers will increase this value three times quicker than just one.
+  optional float idle_worker_time = 2;
+
+  // Sum of minerals and vespene spent on completed units.
+  optional float total_value_units = 3;
+  // Sum of minerals and vespene spent on completed structures.
+  optional float total_value_structures = 4;
+
+  // Sum of minerals and vespene of units, belonging to the opponent, that the player has destroyed.
+  optional float killed_value_units = 5;
+  // Sum of minerals and vespene of structures, belonging to the opponent, that the player has destroyed.
+  optional float killed_value_structures = 6;
+
+  // Sum of minerals collected by the player.
+  optional float collected_minerals = 7;
+  // Sum of vespene collected by the player.
+  optional float collected_vespene = 8;
+
+  // Estimated income of minerals over the next minute based on the players current income. The unit is minerals per minute.
+  optional float collection_rate_minerals = 9;
+  // Estimated income of vespene over the next minute based on the players current income. The unit is vespene per minute.
+  optional float collection_rate_vespene = 10;
+
+  // Sum of spent minerals at the moment it is spent. For example, this number is incremented by 50 the moment an scv is queued in a command center.  It is decremented by 50 if that unit is canceled.
+  optional float spent_minerals = 11;
+  // Sum of spent vespene at the moment it is spent. For example, this number is incremented by 50 when a reaper is queued but decremented by 50 if it is canceled.
+  optional float spent_vespene = 12;
+
+  // The following entries contains floating point values for the following catgories:
+  //   none - There is no category defined in game data.
+  //   army - This category includes all military units but not workers.
+  //   economy - This category contains town halls, supply structures, vespene buildings and workers.
+  //   technology - This category is any structure that produces units or upgrades, Barracks and Engineering Bays both fall in this category, for example.
+  //   upgrade - This category is upgrades such as warp gate or weapons upgrades.
+
+  // Sum of food, or supply, utilized in the categories above.
+  optional CategoryScoreDetails food_used = 13;
+
+  // Sum of enemies catagories destroyed in minerals.
+  optional CategoryScoreDetails killed_minerals = 14;
+  // Sum of enemies catagories destroyed in vespene.
+  optional CategoryScoreDetails killed_vespene = 15;
+
+  //  Sum of lost minerals for the player in each category.
+  optional CategoryScoreDetails lost_minerals = 16;
+  // Sum of lost vespene for the player in each category.
+  optional CategoryScoreDetails lost_vespene = 17;
+
+  // Sum of the lost minerals via destroying the players own units/buildings.
+  optional CategoryScoreDetails friendly_fire_minerals = 18;
+  // Sum of the lost vespene via destroying the players own units/buildings.
+  optional CategoryScoreDetails friendly_fire_vespene = 19;
+
+  // Sum of used minerals for the player in each category for each existing unit or upgrade. Therefore if a unit died worth 50 mierals this number will be decremented by 50.
+  optional CategoryScoreDetails used_minerals = 20;
+  // Sum of used vespene for the player in each category. Therefore if a unit died worth 50 vespene this number will be decremented by 50.
+  optional CategoryScoreDetails used_vespene = 21;
+
+  // Sum of used minerals throughout the entire game for each category. Unliked used_minerals, this value is never decremented.
+  optional CategoryScoreDetails total_used_minerals = 22;
+  // Sum of used vespene throughout the entire game for each category. Unliked used_vespene, this value is never decremented.
+  optional CategoryScoreDetails total_used_vespene = 23;
+
+  // Sum of damage dealt to the player's opponent for each category.
+  optional VitalScoreDetails total_damage_dealt = 24;
+  // Sum of damage taken by the player for each category.
+  optional VitalScoreDetails total_damage_taken = 25;
+  // Sum of health healed by the player. Note that technology can be healed (by queens) or repaired (by scvs).
+  optional VitalScoreDetails total_healed = 26;
+
+  // Recent raw APM.
+  optional float current_apm = 27;
+  // Recent effective APM.
+  optional float current_effective_apm = 28;
+}

data/lib/templates/new/api/spatial.proto

@@ -0,0 +1,115 @@
+
+syntax = "proto2";
+
+package Api;
+
+import "common.proto";
+
+//
+// Observation - Feature Layer
+//
+
+message ObservationFeatureLayer {
+  optional FeatureLayers renders = 1;
+  optional FeatureLayersMinimap minimap_renders = 2;
+}
+
+message FeatureLayers {
+  optional ImageData height_map = 1;                // uint8. Terrain height. World space units of [-200, 200] encoded into [0, 255].
+  optional ImageData visibility_map = 2;            // uint8. 0=Hidden, 1=Fogged, 2=Visible, 3=FullHidden
+  optional ImageData creep = 3;                     // 1-bit. Zerg creep.
+  optional ImageData power = 4;                     // 1-bit. Protoss power.
+  optional ImageData player_id = 5;                 // uint8. Participants: [1, 15] Neutral: 16
+  optional ImageData unit_type = 6;                 // int32. Unique identifier for type of unit.
+  optional ImageData selected = 7;                  // 1-bit. Selected units.
+  optional ImageData unit_hit_points = 8;           // int32.
+  optional ImageData unit_hit_points_ratio = 17;    // uint8. Ratio of current health to max health. [0%, 100%] encoded into [0, 255].
+  optional ImageData unit_energy = 9;               // int32.
+  optional ImageData unit_energy_ratio = 18;        // uint8. Ratio of current energy to max energy. [0%, 100%] encoded into [0, 255].
+  optional ImageData unit_shields = 10;             // int32.
+  optional ImageData unit_shields_ratio = 19;       // uint8. Ratio of current shields to max shields. [0%, 100%] encoded into [0, 255].
+  optional ImageData player_relative = 11;          // uint8. See "Alliance" enum in raw.proto. Range: [1, 4] 
+  optional ImageData unit_density_aa = 14;          // uint8. Density of units overlapping a pixel, anti-aliased. [0.0, 16.0f] encoded into [0, 255].
+  optional ImageData unit_density = 15;             // uint8. Count of units overlapping a pixel.
+  optional ImageData effects = 20;                  // uint8. Visuals of persistent abilities. (eg. Psistorm)
+  optional ImageData hallucinations = 21;           // 1-bit. Whether the unit here is a hallucination.
+  optional ImageData cloaked = 22;                  // 1-bit. Whether the unit here is cloaked. Hidden units will show up too, but with less details in other layers.
+  optional ImageData blip = 23;                     // 1-bit. Whether the unit here is a blip.
+  optional ImageData buffs = 24;                    // int32. One of the buffs applied to this unit. Extras are ignored.
+  optional ImageData buff_duration = 26;            // uint8. Ratio of buff remaining. [0%, 100%] encoded into [0, 255].
+  optional ImageData active = 25;                   // 1-bit. Whether the unit here is active.
+  optional ImageData build_progress = 27;           // uint8. How far along the building is building something. [0%, 100%] encoded into [0, 255].
+  optional ImageData buildable = 28;                // 1-bit. Whether a building can be built here.
+  optional ImageData pathable = 29;                 // 1-bit. Whether a unit can walk here.
+  optional ImageData placeholder = 30;              // 1-bit. Whether the unit here is a placeholder building to be constructed.
+}
+
+message FeatureLayersMinimap {
+  optional ImageData height_map = 1;                // uint8. Terrain height. World space units of [-200, 200] encoded into [0, 255].
+  optional ImageData visibility_map = 2;            // uint8. 0=Hidden, 1=Fogged, 2=Visible, 3=FullHidden
+  optional ImageData creep = 3;                     // 1-bit. Zerg creep.
+  optional ImageData camera = 4;                    // 1-bit. Area covered by the camera.
+  optional ImageData player_id = 5;                 // uint8. Participants: [1, 15] Neutral: 16
+  optional ImageData player_relative = 6;           // uint8. See "Alliance" enum in raw.proto. Range: [1, 4] 
+  optional ImageData selected = 7;                  // 1-bit. Selected units.
+  optional ImageData alerts = 9;                    // 1-bit. Shows 'UnitAttacked' alert location.
+  optional ImageData buildable = 10;                // 1-bit. Whether a building can be built here.
+  optional ImageData pathable = 11;                 // 1-bit. Whether a unit can walk here.
+
+  // Cheat layers, enable with SpatialCameraSetup.allow_cheating_layers.
+  optional ImageData unit_type = 8;                 // int32. Unique identifier for type of unit.
+}
+
+
+//
+// Observation - Rendered
+//
+
+message ObservationRender {
+  optional ImageData map = 1;
+  optional ImageData minimap = 2;
+}
+
+
+//
+// Action
+//
+
+message ActionSpatial {
+  oneof action {
+    ActionSpatialUnitCommand unit_command = 1;
+    ActionSpatialCameraMove camera_move = 2;
+    ActionSpatialUnitSelectionPoint unit_selection_point = 3;
+    ActionSpatialUnitSelectionRect unit_selection_rect = 4;
+  }
+}
+
+message ActionSpatialUnitCommand {
+  optional int32 ability_id = 1;
+  oneof target {
+    PointI target_screen_coord = 2;
+    PointI target_minimap_coord = 3;
+  }
+
+  optional bool queue_command = 4;          // Equivalent to shift+command.
+}
+
+message ActionSpatialCameraMove {
+  optional PointI center_minimap = 1;       // Simulates a click on the minimap to move the camera.
+}
+
+message ActionSpatialUnitSelectionPoint {
+  optional PointI selection_screen_coord = 1;
+  enum Type {
+    Select = 1;         // Equivalent to normal click. Changes selection to unit.
+    Toggle = 2;         // Equivalent to shift+click. Toggle selection of unit.
+    AllType = 3;        // Equivalent to control+click. Selects all units of a given type.
+    AddAllType = 4;     // Equivalent to shift+control+click. Selects all units of a given type.
+  }
+  optional Type type = 2;
+}
+
+message ActionSpatialUnitSelectionRect {
+  repeated RectangleI selection_screen_coord = 1;   // Eventually this should not be an array, but a single field (multiple would be cheating).
+  optional bool selection_add = 2;                  // Equivalent to shift+drag. Adds units to selection.
+}

data/lib/templates/new/api/ui.proto

@@ -0,0 +1,145 @@
+
+syntax = "proto2";
+
+package Api;
+
+//
+// Observation
+//
+
+message ObservationUI {
+  repeated ControlGroup groups = 1;
+  oneof panel {
+    SinglePanel single = 2;
+    MultiPanel multi = 3;
+    CargoPanel cargo = 4;
+    ProductionPanel production = 5;
+  }
+}
+
+message ControlGroup {
+  optional uint32 control_group_index = 1;
+  optional uint32 leader_unit_type = 2;
+  optional uint32 count = 3;
+}
+
+message UnitInfo {
+  optional uint32 unit_type = 1;
+  optional uint32 player_relative = 2;
+  optional int32 health = 3;
+  optional int32 shields = 4;
+  optional int32 energy = 5;
+  optional int32 transport_slots_taken = 6;
+  optional float build_progress = 7;    // Range: [0.0, 1.0]
+  optional UnitInfo add_on = 8;
+  optional int32 max_health = 9;
+  optional int32 max_shields = 10;
+  optional int32 max_energy = 11;
+}
+
+message SinglePanel {
+  optional UnitInfo unit = 1;
+  optional int32 attack_upgrade_level = 2;
+  optional int32 armor_upgrade_level = 3;
+  optional int32 shield_upgrade_level = 4;
+  repeated int32 buffs = 5;
+}
+
+message MultiPanel {
+  repeated UnitInfo units = 1;
+}
+
+message CargoPanel {
+  optional UnitInfo unit = 1;
+  repeated UnitInfo passengers = 2;
+  optional int32 slots_available = 3;       // TODO: Change to cargo size
+}
+
+message BuildItem {
+  optional uint32 ability_id = 1;
+  optional float build_progress = 2;    // Range: [0.0, 1.0]
+}
+
+message ProductionPanel {
+  optional UnitInfo unit = 1;
+
+  // build_queue ONLY gives information about units that are being produced.
+  // Use production_queue instead to see both units being trained as well as research in the queue.
+  repeated UnitInfo build_queue = 2;
+  repeated BuildItem production_queue = 3;
+}
+
+
+//
+// Action
+//
+
+message ActionUI {
+  oneof action {
+    ActionControlGroup control_group = 1;
+    ActionSelectArmy select_army = 2;
+    ActionSelectWarpGates select_warp_gates = 3;
+    ActionSelectLarva select_larva = 4;
+    ActionSelectIdleWorker select_idle_worker = 5;
+    ActionMultiPanel multi_panel = 6;
+    ActionCargoPanelUnload cargo_panel = 7;
+    ActionProductionPanelRemoveFromQueue production_panel = 8;
+    ActionToggleAutocast toggle_autocast = 9;
+  }
+}
+
+message ActionControlGroup {
+  enum ControlGroupAction {
+    Recall = 1;             // Equivalent to number hotkey. Replaces current selection with control group.
+    Set = 2;                // Equivalent to Control + number hotkey. Sets control group to current selection.
+    Append = 3;             // Equivalent to Shift + number hotkey. Adds current selection into control group.
+    SetAndSteal = 4;        // Equivalent to Control + Alt + number hotkey. Sets control group to current selection. Units are removed from other control groups.
+    AppendAndSteal = 5;     // Equivalent to Shift + Alt + number hotkey. Adds current selection into control group. Units are removed from other control groups.
+  }
+  optional ControlGroupAction action = 1;
+  optional uint32 control_group_index = 2;
+}
+
+message ActionSelectArmy {
+  optional bool selection_add = 1;
+}
+
+message ActionSelectWarpGates {
+  optional bool selection_add = 1;
+}
+
+message ActionSelectLarva {
+}
+
+message ActionSelectIdleWorker {
+  enum Type {
+    Set = 1;        // Equivalent to click with no modifiers. Replaces selection with single idle worker.
+    Add = 2;        // Equivalent to shift+click. Adds single idle worker to current selection.
+    All = 3;        // Equivalent to control+click. Selects all idle workers.
+    AddAll = 4;     // Equivalent to shift+control+click. Adds all idle workers to current selection.
+  }
+  optional Type type = 1;
+}
+
+message ActionMultiPanel {
+  enum Type {
+    SingleSelect = 1;         // Click on icon
+    DeselectUnit = 2;         // Shift Click on icon
+    SelectAllOfType = 3;      // Control Click on icon.
+    DeselectAllOfType = 4;    // Control+Shift Click on icon.
+  }
+  optional Type type = 1;
+  optional int32 unit_index = 2;
+}
+
+message ActionCargoPanelUnload {
+  optional int32 unit_index = 1;
+}
+
+message ActionProductionPanelRemoveFromQueue {
+  optional int32 unit_index = 1;
+}
+
+message ActionToggleAutocast {
+  optional int32 ability_id = 1;
+}

data/lib/templates/new/boot.rb.tt

@@ -0,0 +1,6 @@
+# This file should require your bot and create a $bot.
+# You are free to rename your bot class, name or restructure your code as long
+# as $bot is created correctly. if not, your ladder bot will break.
+
+require_relative "<%= @bot_file %>"
+$bot = <%= @classname %>.new(name: "<%= @botname %>", race: Api::Race::<%= @race %>)

data/lib/templates/new/my_bot.rb.tt

@@ -0,0 +1,23 @@
+require "sc2ai"
+
+class <%= @classname %> < Sc2::Player::Bot
+
+  def configure
+    @realtime = false # Step-mode vs Bot, Realtime vs Humans
+    @step_size = 1 # Gives 22.4ms, typically compete at 2 (44.8ms) or 4 (179.2ms).
+    @enable_feature_layer = false; # Enables ui_ and spatial_ actions. Advanced, and has performance cost.
+  end
+
+  def on_step
+    if game_loop == 0
+      enemy_start_pos = game_info.start_raw.start_locations.first
+      units.workers.attack(target: enemy_start_pos)
+    end
+
+    # If your attack fails, "good game" and exit
+    if units.workers.size.zero?
+      action_chat("gg", channel: Api::ActionChat::Channel::Broadcast)
+      leave_game
+    end
+  end
+end

data/lib/templates/new/run_example_match.rb.tt

@@ -0,0 +1,14 @@
+# Use the ladder's boot.rb file and configure there
+require "./boot.rb"
+
+# Or simply, create by hand
+#my_bot = MyBot.new(name: "Botname", race: Api::Race::Random)
+
+# Start a match
+Sc2::Match.new(
+  players: [
+    $bot,
+    Sc2::Player::Computer.new(race: Api::Race::Random, difficulty: Api::Difficulty::VeryEasy)
+  ],
+  map: "Goldenaura512AIE" # Or any of the downloaded map names
+).run

data/sc2ai.gemspec

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path("./lib"))
+require_relative "lib/sc2ai/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "sc2ai"
+  spec.version = Sc2::VERSION
+  spec.authors = ["Dyson Returns"]
+
+  spec.summary = "STARCRAFT® II AI API"
+  spec.description = "This is a Ruby interface to STARCRAFT® II. It can be used for machine learning via Rumale or custom scripted AI battle."
+  spec.homepage = "https://www.github.com/dysonreturns/sc2ai"
+  spec.licenses = ["MIT", "Nonstandard"]
+  spec.required_ruby_version = ">= 3.2.2"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/docs/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").select do |f|
+      (File.expand_path(f) == __FILE__) ||
+        %r{\A(?:lib|data|exe)/}.match?(f)
+    end
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Live dependencies ---
+  spec.add_dependency "async", "2.6.5"
+  # Sc2::Connection
+  spec.add_dependency "async-websocket", "0.26.0"
+  spec.add_dependency "google-protobuf", "3.25.1"
+  # Sc2::Client / Controller
+  spec.add_dependency "async-process", "1.3.1"
+  # Cli
+  spec.add_dependency "thor", "1.3.0"
+
+  # Geometry
+  spec.add_dependency "perfect-shape", "1.0.8"
+
+  spec.add_dependency "numo-narray", "0.9.2.1"
+  spec.add_dependency "numo-linalg", "0.1.7"
+  spec.add_dependency "rumale", "0.28.1"
+
+  # TODO: Find a way to not depend on a patched gem and yank this
+  spec.add_dependency "sc2ai-kdtree", "~> 0.4"
+
+  # Pre-packaged ladder dependencies
+  # We add these locally, so that authors know what to use
+  # spec.add_dependency "activerecord", "7.1.2"
+  # spec.add_dependency "sqlite3", "1.7.0"
+  # spec.add_dependency "rb_sys", "0.9.85"
+  # spec.add_dependency "concurrent-ruby", "1.2.2"
+  # spec.add_dependency "parallel", "1.24.0"
+
+  # Dev dependencies ---
+  spec.add_development_dependency "rake", "~> 13.1"
+  # Doc
+  spec.add_development_dependency "yard", "~> 0.9"
+  # Linting
+  # spec.add_development_dependency "fasterer" # no 3.3 support yet
+  spec.add_development_dependency "standard", "~> 1.33"
+
+  # Profiling
+  spec.add_development_dependency "memory_profiler", "~> 1.0"
+  spec.add_development_dependency "benchmark", "~> 0.3"
+  spec.add_development_dependency "benchmark-ips", "~> 2.13"
+
+  # Testing
+  spec.add_development_dependency "factory_bot", "~> 6.4"
+  spec.add_development_dependency "fakefs", "~> 2.5"
+  spec.add_development_dependency "rspec", "~> 3.12"
+  spec.add_development_dependency "simplecov", "~> 0.22"
+end