sc2ai 0.0.0.pre → 0.0.3

data/lib/sc2ai.rb

@@ -1,9 +1,100 @@
 # frozen_string_literal: true
 
-require_relative "sc2ai/version"
+# TODO: MOVE RUBY_GC_* to load into shell ENV, because they apparently can't be set at runtime.
+# Arbitrary very large numbers which should not be reached
+# RUBY_GC_MALLOC_LIMIT=128000000000;
+# RUBY_GC_OLDMALLOC_LIMIT=128000000000;
+# RUBY_GC_OLDMALLOC_LIMIT_MAX=128000000000;
+# RUBY_GC_HEAP_INIT_SLOTS=329375
 
+# In the event major runs, let it compact
+GC.auto_compact = true
+
+# For Numo linear algebra, fix paths for specific macOS's and on ladder
+library_paths = if ENV["LD_LIBRARY_PATH"].nil?
+  []
+else
+  ENV["LD_LIBRARY_PATH"].split(":")
+end
+library_paths << [
+  # MacOS
+  "/opt/homebrew/opt/lapack/lib",
+  "/opt/homebrew/opt/lapack/lib",
+  "/opt/homebrew/opt/openblas/lib",
+  # Ladder deploy
+  RbConfig::CONFIG["libdir"]
+]
+ENV["LD_LIBRARY_PATH"] = library_paths.compact.join(":")
+
+begin
+  require "numo/linalg/autoloader"
+rescue => e
+  puts "Error from numo-linalg: #{e}"
+  puts "Lets get some linear algebra on your system..."
+  puts 'Mac: "brew install openblas"'
+  puts 'Debian/Ubuntu and WSL2: "apt install libopenblas0"'
+  if Gem.win_platform?
+    puts 'Windows: from CMD "ridk enable & pacman -S mingw-w64-ucrt-x86_64-openblas --noconfirm".'
+  end
+  puts 'That should be enough. If you still experience issues, "bundle install --redownload" to rebuild dependencies anew'
+  exit
+end
+
+# noinspection RubyMismatchedArgumentType
+Dir.glob(File.join(__dir__, "sc2ai", "overrides", "**", "*.rb")).each do |file|
+  require(file)
+end
+
+# Protobuf internals don't allow sharing enums in the same package,
+#  so Blizzard under_scored some names. This throws errors when defining constants
+#  during packing/unpacking, because they dont start capitalized, so we silence temporarily.
+silence_warnings do
+  require "rumale"
+  require_relative "sc2ai/protocol/sc2api_pb"
+end
+# noinspection RubyMismatchedArgumentType
+Dir[File.join(__dir__, "sc2ai", "*.rb")].each { |file| require(file) }
+# The upper include can probably preload everything it needs
+# noinspection RubyMismatchedArgumentType
+Dir[File.join(__dir__, "sc2ai", "protocol", "extensions", "**", "*.rb")].each { |file| require(file) }
+# noinspection RubyMismatchedArgumentType
+Dir[File.join(__dir__, "sc2ai", "local_play", "**", "*.rb")].each { |file| require(file) }
+
+# Facilitates StarCraft 2 AI
 module Sc2
+  # Generic, single error for everything Sc2
   class Error < StandardError; end
 
-  # You just unpacked a new board game. What do you do before you play?
+  class << self
+    # Instantiate the Configuration singleton or return it.
+    # Remember that the instance has attribute readers so that we can access the configured values
+    def config
+      @config ||= Configuration.new
+      yield @config if block_given?
+      @config
+    end
+
+    # Set to new Sc2::Configuration
+    attr_writer :config
+
+    # Sets logger singleton
+    attr_writer :logger
+
+    # @return [Logger] a logger instance or a new $stdout logger if undefined
+    def logger
+      return @logger if @logger
+
+      require "logger"
+
+      @logger = Logger.new($stdout)
+      @logger.level = :debug
+      @logger
+    end
+
+    # Returns whether we are on the ladder or not
+    # @return [Boolean]
+    def ladder?
+      @is_live ||= ENV.has_key?("AIARENA")
+    end
+  end
 end

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

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+
+# Ladder startup
+
+# Sets Ruby path to local folder, env vars and
+base_dir=$(realpath ${0%/*}/)
+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
+
+# Maxime <3
+export RUBY_YJIT_ENABLE=true
+
+export AIARENA=true
+sc2ai ladderconfig
+exec sc2ai laddermatch "$@" 1>&2

data/lib/templates/new/.ladderignore

@@ -0,0 +1,20 @@
+# SC2 artifacts
+**/replays/*
+*.SC2Replay
+*.SC2Map
+*.proto
+*.zip
+
+
+# Gem-specific ignores
+.build/
+data/debug_observation.json
+
+# Other
+.idea/
+vendor/bundle
+spec/
+test/
+
+# My ignores
+

data/lib/templates/new/Gemfile.tt

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem 'sc2ai'
+
+

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

@@ -0,0 +1,59 @@
+
+syntax = "proto2";
+
+package Api;
+
+message AvailableAbility {
+  optional int32 ability_id = 1;
+  optional bool requires_point = 2;
+}
+
+message ImageData {
+  optional int32 bits_per_pixel = 1;    // Number of bits per pixel; 8 bits for a byte etc.
+  optional Size2DI size = 2;            // Dimension in pixels.
+  optional bytes data = 3;              // Binary data; the size of this buffer in bytes is width * height * bits_per_pixel / 8.
+}
+
+// Point on the screen/minimap (e.g., 0..64).
+// Note: bottom left of the screen is 0, 0.
+message PointI {
+  optional int32 x = 1;
+  optional int32 y = 2;
+}
+
+// Screen space rectangular area.
+message RectangleI {
+  optional PointI p0 = 1;
+  optional PointI p1 = 2;
+}
+
+// Point on the game board, 0..255.
+// Note: bottom left of the screen is 0, 0.
+message Point2D {
+  optional float x = 1;
+  optional float y = 2;
+}
+
+// Point on the game board, 0..255.
+// Note: bottom left of the screen is 0, 0.
+message Point {
+  optional float x = 1;
+  optional float y = 2;
+  optional float z = 3;
+}
+
+// Screen dimensions.
+message Size2DI {
+  optional int32 x = 1;
+  optional int32 y = 2;
+}
+
+enum Race {
+  NoRace = 0;
+  Terran = 1;
+  Zerg = 2;
+  Protoss = 3;
+  Random = 4;
+}
+
+

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

@@ -0,0 +1,120 @@
+
+syntax = "proto2";
+
+package Api;
+
+import "common.proto";
+
+// May not relevant: queueable (everything is queueable).
+// May not be important: AbilSetId - marine stim, marauder stim.
+// Stuff omitted: transient.
+// Stuff that may be important: cost, range, Alignment, targetfilters.
+message AbilityData {
+  optional uint32 ability_id = 1;                                 // Stable ID.
+  optional string link_name = 2;                                  // Catalog name of the ability.
+  optional uint32 link_index = 3;                                 // Catalog index of the ability.
+  optional string button_name = 4;                                // Name used for the command card. May not always be set.
+  optional string friendly_name = 5;                              // A human friendly name when the button name or link name isn't descriptive.
+  optional string hotkey = 6;                                     // Hotkey. May not always be set.
+  optional uint32 remaps_to_ability_id = 7;                       // This ability id may be represented by the given more generic id.
+
+  enum Target {
+    None = 1;                                                     // Does not require a target.
+    Point = 2;                                                    // Requires a target position.
+    Unit = 3;                                                     // Requires a unit to target. Given by position using feature layers.
+    PointOrUnit = 4;                                              // Requires either a target point or target unit.
+    PointOrNone = 5;                                              // Requires either a target point or no target. (eg. building add-ons)
+  }
+
+  optional bool available = 8;                                    // If true, the ability may be used by this set of mods/map.
+  optional Target target = 9;                                     // Determines if a point is optional or required.
+  optional bool allow_minimap = 10;                               // Can be cast in the minimap.
+  optional bool allow_autocast = 11;                              // Autocast can be set.
+  optional bool is_building = 12;                                 // Requires placement to construct a building.
+  optional float footprint_radius = 13;                           // Estimation of the footprint size. Need a better footprint.
+  optional bool is_instant_placement = 14;                        // Placement next to an existing structure, e.g., an add-on like a Tech Lab.
+  optional float cast_range = 15;                                 // Range unit can cast ability without needing to approach target.
+}
+
+enum Attribute {
+  Light = 1;
+  Armored = 2;
+  Biological = 3;
+  Mechanical = 4;
+  Robotic = 5;
+  Psionic = 6;
+  Massive = 7;
+  Structure = 8;
+  Hover = 9;
+  Heroic = 10;
+  Summoned = 11;
+}
+
+message DamageBonus {
+  optional Attribute attribute = 1;
+  optional float bonus = 2;
+}
+
+message Weapon {
+  enum TargetType {
+    Ground = 1;
+    Air = 2;
+    Any = 3;
+  }
+  optional TargetType type = 1;
+  optional float damage = 2;
+  repeated DamageBonus damage_bonus = 3;
+  optional uint32 attacks = 4;              // Number of hits per attack. (eg. Colossus has 2 beams)
+  optional float range = 5;
+  optional float speed = 6;                 // Time between attacks.
+}
+
+message UnitTypeData {
+  optional uint32 unit_id = 1;                                    // Stable ID.
+  optional string name = 2;                                       // Catalog name of the unit.
+  optional bool available = 3;                                    // If true, the ability may be used by this set of mods/map.
+  optional uint32 cargo_size = 4;                                 // Number of cargo slots it occupies in transports.
+  optional uint32 mineral_cost = 12;
+  optional uint32 vespene_cost = 13;
+  optional float food_required = 14;
+  optional float food_provided = 18;
+  optional uint32 ability_id = 15;                                // The ability that builds this unit.
+  optional Race race = 16;
+  optional float build_time = 17;
+  optional bool has_vespene = 19;
+  optional bool has_minerals = 20;
+  optional float sight_range = 25;                                // Range unit reveals vision.
+
+  repeated uint32 tech_alias = 21;                                // Other units that satisfy the same tech requirement.
+  optional uint32 unit_alias = 22;                                // The morphed variant of this unit.
+
+  optional uint32 tech_requirement = 23;                          // Structure required to build this unit. (Or any with the same tech_alias)
+  optional bool require_attached = 24;                            // Whether tech_requirement is an add-on.
+
+  // Values include changes from upgrades
+  repeated Attribute attributes = 8;
+  optional float movement_speed = 9;
+  optional float armor = 10;
+  repeated Weapon weapons = 11;
+}
+
+message UpgradeData {
+  optional uint32 upgrade_id = 1;       // Stable ID.
+  optional string name = 2;
+  optional uint32 mineral_cost = 3;
+  optional uint32 vespene_cost = 4;
+  optional float research_time = 5;
+  optional uint32 ability_id = 6;
+}
+
+message BuffData {
+  optional uint32 buff_id = 1;          // Stable ID.
+  optional string name = 2;
+}
+
+message EffectData {
+  optional uint32 effect_id = 1;          // Stable ID.
+  optional string name = 2;
+  optional string friendly_name = 3;
+  optional float radius = 4;
+}

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

@@ -0,0 +1,127 @@
+
+syntax = "proto2";
+
+package Api;
+
+import "common.proto";
+
+// Issue various useful commands to the game engine.
+message DebugCommand {
+  oneof command {
+    DebugDraw draw = 1;
+    DebugGameState game_state = 2;
+    DebugCreateUnit create_unit = 3;
+    DebugKillUnit kill_unit = 4;
+    DebugTestProcess test_process = 5;
+    DebugSetScore score = 6;                // Useful only for single-player "curriculum" maps.
+    DebugEndGame end_game = 7;
+    DebugSetUnitValue unit_value = 8;
+  }
+}
+
+message DebugDraw {
+  repeated DebugText text = 1;
+  repeated DebugLine lines = 2;
+  repeated DebugBox boxes = 3;
+  repeated DebugSphere spheres = 4;
+}
+
+message Line {
+  optional Point p0 = 1;
+  optional Point p1 = 2;
+}
+
+message Color {
+  optional uint32 r = 1;
+  optional uint32 g = 2;
+  optional uint32 b = 3;
+}
+
+// Display debug text on screen.
+message DebugText {
+  optional Color color = 1;
+  optional string text = 2;         // Text to display.
+  optional Point virtual_pos = 3;   // Virtualized position in 2D (the screen is 0..1, 0..1 for any resolution).
+  optional Point world_pos = 4;     // Position in the world.
+  optional uint32 size = 5;         // Pixel height of the text. Defaults to 8px.
+}
+
+// Display debug lines on screen.
+message DebugLine {
+  optional Color color = 1;
+  optional Line line = 2;           // World space line.
+}
+
+// Display debug boxes on screen.
+message DebugBox {
+  optional Color color = 1;
+  optional Point min = 2;
+  optional Point max = 3;
+}
+
+// Display debug spheres on screen.
+message DebugSphere {
+  optional Color color = 1;
+  optional Point p = 2;
+  optional float r = 3;
+}
+
+enum DebugGameState {
+  show_map = 1;
+  control_enemy = 2;
+  food = 3;
+  free = 4;
+  all_resources = 5;
+  god = 6;
+  minerals = 7;
+  gas = 8;
+  cooldown = 9;
+  tech_tree = 10;
+  upgrade = 11;
+  fast_build = 12;
+}
+
+message DebugCreateUnit {
+  optional uint32 unit_type = 1;
+  optional int32 owner = 2;
+  optional Point2D pos = 3;
+  optional uint32 quantity = 4;
+}
+
+message DebugKillUnit {
+  repeated uint64 tag = 1;
+}
+
+message DebugTestProcess {
+  enum Test {
+    hang = 1;
+    crash = 2;
+    exit = 3;
+  }
+  optional Test test = 1;
+  optional int32 delay_ms = 2;
+}
+
+message DebugSetScore {
+  optional float score = 1;
+}
+
+message DebugEndGame {
+  enum EndResult {
+    Surrender = 1;                  // Default if nothing is set. The current player admits defeat.
+    DeclareVictory = 2;
+  }
+  optional EndResult end_result = 1;
+}
+
+message DebugSetUnitValue {
+  enum UnitValue {
+    Energy = 1;
+    Life = 2;
+    Shields = 3;
+  }
+  optional UnitValue unit_value = 1;
+  optional float value = 2;
+  optional uint64 unit_tag = 3;
+}
+

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

@@ -0,0 +1,221 @@
+
+syntax = "proto2";
+
+package Api;
+
+enum ActionResult {
+  Success = 1;
+  NotSupported = 2;
+  Error = 3;
+  CantQueueThatOrder = 4;
+  Retry = 5;
+  Cooldown = 6;
+  QueueIsFull = 7;
+  RallyQueueIsFull = 8;
+  NotEnoughMinerals = 9;
+  NotEnoughVespene = 10;
+  NotEnoughTerrazine = 11;
+  NotEnoughCustom = 12;
+  NotEnoughFood = 13;
+  FoodUsageImpossible = 14;
+  NotEnoughLife = 15;
+  NotEnoughShields = 16;
+  NotEnoughEnergy = 17;
+  LifeSuppressed = 18;
+  ShieldsSuppressed = 19;
+  EnergySuppressed = 20;
+  NotEnoughCharges = 21;
+  CantAddMoreCharges = 22;
+  TooMuchMinerals = 23;
+  TooMuchVespene = 24;
+  TooMuchTerrazine = 25;
+  TooMuchCustom = 26;
+  TooMuchFood = 27;
+  TooMuchLife = 28;
+  TooMuchShields = 29;
+  TooMuchEnergy = 30;
+  MustTargetUnitWithLife = 31;
+  MustTargetUnitWithShields = 32;
+  MustTargetUnitWithEnergy = 33;
+  CantTrade = 34;
+  CantSpend = 35;
+  CantTargetThatUnit = 36;
+  CouldntAllocateUnit = 37;
+  UnitCantMove = 38;
+  TransportIsHoldingPosition = 39;
+  BuildTechRequirementsNotMet = 40;
+  CantFindPlacementLocation = 41;
+  CantBuildOnThat = 42;
+  CantBuildTooCloseToDropOff = 43;
+  CantBuildLocationInvalid = 44;
+  CantSeeBuildLocation = 45;
+  CantBuildTooCloseToCreepSource = 46;
+  CantBuildTooCloseToResources = 47;
+  CantBuildTooFarFromWater = 48;
+  CantBuildTooFarFromCreepSource = 49;
+  CantBuildTooFarFromBuildPowerSource = 50;
+  CantBuildOnDenseTerrain = 51;
+  CantTrainTooFarFromTrainPowerSource = 52;
+  CantLandLocationInvalid = 53;
+  CantSeeLandLocation = 54;
+  CantLandTooCloseToCreepSource = 55;
+  CantLandTooCloseToResources = 56;
+  CantLandTooFarFromWater = 57;
+  CantLandTooFarFromCreepSource = 58;
+  CantLandTooFarFromBuildPowerSource = 59;
+  CantLandTooFarFromTrainPowerSource = 60;
+  CantLandOnDenseTerrain = 61;
+  AddOnTooFarFromBuilding = 62;
+  MustBuildRefineryFirst = 63;
+  BuildingIsUnderConstruction = 64;
+  CantFindDropOff = 65;
+  CantLoadOtherPlayersUnits = 66;
+  NotEnoughRoomToLoadUnit = 67;
+  CantUnloadUnitsThere = 68;
+  CantWarpInUnitsThere = 69;
+  CantLoadImmobileUnits = 70;
+  CantRechargeImmobileUnits = 71;
+  CantRechargeUnderConstructionUnits = 72;
+  CantLoadThatUnit = 73;
+  NoCargoToUnload = 74;
+  LoadAllNoTargetsFound = 75;
+  NotWhileOccupied = 76;
+  CantAttackWithoutAmmo = 77;
+  CantHoldAnyMoreAmmo = 78;
+  TechRequirementsNotMet = 79;
+  MustLockdownUnitFirst = 80;
+  MustTargetUnit = 81;
+  MustTargetInventory = 82;
+  MustTargetVisibleUnit = 83;
+  MustTargetVisibleLocation = 84;
+  MustTargetWalkableLocation = 85;
+  MustTargetPawnableUnit = 86;
+  YouCantControlThatUnit = 87;
+  YouCantIssueCommandsToThatUnit = 88;
+  MustTargetResources = 89;
+  RequiresHealTarget = 90;
+  RequiresRepairTarget = 91;
+  NoItemsToDrop = 92;
+  CantHoldAnyMoreItems = 93;
+  CantHoldThat = 94;
+  TargetHasNoInventory = 95;
+  CantDropThisItem = 96;
+  CantMoveThisItem = 97;
+  CantPawnThisUnit = 98;
+  MustTargetCaster = 99;
+  CantTargetCaster = 100;
+  MustTargetOuter = 101;
+  CantTargetOuter = 102;
+  MustTargetYourOwnUnits = 103;
+  CantTargetYourOwnUnits = 104;
+  MustTargetFriendlyUnits = 105;
+  CantTargetFriendlyUnits = 106;
+  MustTargetNeutralUnits = 107;
+  CantTargetNeutralUnits = 108;
+  MustTargetEnemyUnits = 109;
+  CantTargetEnemyUnits = 110;
+  MustTargetAirUnits = 111;
+  CantTargetAirUnits = 112;
+  MustTargetGroundUnits = 113;
+  CantTargetGroundUnits = 114;
+  MustTargetStructures = 115;
+  CantTargetStructures = 116;
+  MustTargetLightUnits = 117;
+  CantTargetLightUnits = 118;
+  MustTargetArmoredUnits = 119;
+  CantTargetArmoredUnits = 120;
+  MustTargetBiologicalUnits = 121;
+  CantTargetBiologicalUnits = 122;
+  MustTargetHeroicUnits = 123;
+  CantTargetHeroicUnits = 124;
+  MustTargetRoboticUnits = 125;
+  CantTargetRoboticUnits = 126;
+  MustTargetMechanicalUnits = 127;
+  CantTargetMechanicalUnits = 128;
+  MustTargetPsionicUnits = 129;
+  CantTargetPsionicUnits = 130;
+  MustTargetMassiveUnits = 131;
+  CantTargetMassiveUnits = 132;
+  MustTargetMissile = 133;
+  CantTargetMissile = 134;
+  MustTargetWorkerUnits = 135;
+  CantTargetWorkerUnits = 136;
+  MustTargetEnergyCapableUnits = 137;
+  CantTargetEnergyCapableUnits = 138;
+  MustTargetShieldCapableUnits = 139;
+  CantTargetShieldCapableUnits = 140;
+  MustTargetFlyers = 141;
+  CantTargetFlyers = 142;
+  MustTargetBuriedUnits = 143;
+  CantTargetBuriedUnits = 144;
+  MustTargetCloakedUnits = 145;
+  CantTargetCloakedUnits = 146;
+  MustTargetUnitsInAStasisField = 147;
+  CantTargetUnitsInAStasisField = 148;
+  MustTargetUnderConstructionUnits = 149;
+  CantTargetUnderConstructionUnits = 150;
+  MustTargetDeadUnits = 151;
+  CantTargetDeadUnits = 152;
+  MustTargetRevivableUnits = 153;
+  CantTargetRevivableUnits = 154;
+  MustTargetHiddenUnits = 155;
+  CantTargetHiddenUnits = 156;
+  CantRechargeOtherPlayersUnits = 157;
+  MustTargetHallucinations = 158;
+  CantTargetHallucinations = 159;
+  MustTargetInvulnerableUnits = 160;
+  CantTargetInvulnerableUnits = 161;
+  MustTargetDetectedUnits = 162;
+  CantTargetDetectedUnits = 163;
+  CantTargetUnitWithEnergy = 164;
+  CantTargetUnitWithShields = 165;
+  MustTargetUncommandableUnits = 166;
+  CantTargetUncommandableUnits = 167;
+  MustTargetPreventDefeatUnits = 168;
+  CantTargetPreventDefeatUnits = 169;
+  MustTargetPreventRevealUnits = 170;
+  CantTargetPreventRevealUnits = 171;
+  MustTargetPassiveUnits = 172;
+  CantTargetPassiveUnits = 173;
+  MustTargetStunnedUnits = 174;
+  CantTargetStunnedUnits = 175;
+  MustTargetSummonedUnits = 176;
+  CantTargetSummonedUnits = 177;
+  MustTargetUser1 = 178;
+  CantTargetUser1 = 179;
+  MustTargetUnstoppableUnits = 180;
+  CantTargetUnstoppableUnits = 181;
+  MustTargetResistantUnits = 182;
+  CantTargetResistantUnits = 183;
+  MustTargetDazedUnits = 184;
+  CantTargetDazedUnits = 185;
+  CantLockdown = 186;
+  CantMindControl = 187;
+  MustTargetDestructibles = 188;
+  CantTargetDestructibles = 189;
+  MustTargetItems = 190;
+  CantTargetItems = 191;
+  NoCalldownAvailable = 192;
+  WaypointListFull = 193;
+  MustTargetRace = 194;
+  CantTargetRace = 195;
+  MustTargetSimilarUnits = 196;
+  CantTargetSimilarUnits = 197;
+  CantFindEnoughTargets = 198;
+  AlreadySpawningLarva = 199;
+  CantTargetExhaustedResources = 200;
+  CantUseMinimap = 201;
+  CantUseInfoPanel = 202;
+  OrderQueueIsFull = 203;
+  CantHarvestThatResource = 204;
+  HarvestersNotRequired = 205;
+  AlreadyTargeted = 206;
+  CantAttackWeaponsDisabled = 207;
+  CouldntReachTarget = 208;
+  TargetIsOutOfRange = 209;
+  TargetIsTooClose = 210;
+  TargetIsOutOfArc = 211;
+  CantFindTeleportLocation = 212;
+  InvalidItemClass = 213;
+  CantFindCancelOrder = 214;
+}