openra 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30d4d798e59b17cc3ce4e5ab7b5668eeccdf278abde065ca3d4072ce7b55d765
-  data.tar.gz: 16a57966678839e8422cfc2cbbe4ccee109d5a6c639adc65d888cb8556f3e21a
+  metadata.gz: 935333ec74bcce9f22c729a66247b9adbd18c25810254b60ffaae435c51f884f
+  data.tar.gz: 375cd8e312984afcf9316c1a58f6292be496f4177fd582c859490ee608341cbd
 SHA512:
-  metadata.gz: '09a36fe3464981b68d1b4ed936352fa7c060dd0b2aefe0e166088e335146818f7fc13454be60cfb6b73e36496cff8a794c10ccde05ca5c2d0d4674ffebb0b96d'
-  data.tar.gz: 15e26c775fdffaf32d92a9f73af433576c6e119d40274abdbc6de90ed05a5d8a7c140982a4f14cef2c42f5898389898a41e84f557ee9970a6645deb56f4275e6
+  metadata.gz: 43037b2237e9128f250417b965282a0f3b84aca84694f32044e6f43b2221230bf327a3e066884754861b7d130315323e2afc3addc24000a555146ede6c99dbed
+  data.tar.gz: d31fe43a09269b77a7a10cd0b6fb0f1ad88884f45ed9f801a2b11866d83f580a89daca4b9b95b9836175399ed1d4fedf7c8a5b8d51850e2823288bd07fa45e63

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## Unreleased
 
+### Added
+
+* [replay-data] Add AdvancedChronoshift to Openra::SUPPORT_POWERS ([AMHOL](https://github.com/AMHOL))
+* [metadata] Added metadata command ([AMHOL](https://github.com/AMHOL))
+
+### Fixed
+
+*  [replay-data] Store clients from SyncInfo command and keep syncing after game start ([AMHOL](https://github.com/AMHOL))
+
 [Compare v2.2.0...HEAD](https://github.com/AMHOL/openra-ruby/compare/v2.2.0...HEAD)
 
 ## v2.2.0

data/README.md

@@ -25,7 +25,7 @@ gem update openra
 
 ```sh
 openra replay-data /path/to/replay.orarep [--format json|pretty-json|yaml]
-openra detect-production-macros /path/to/replay.orarep [--format json|pretty-json|yaml]
+openra metadata /path/to/replay.orarep [--format json|pretty-json|yaml]
 ```
 
 ### Other tools

data/lib/{openra-yaml.rb → openra-mini_yaml.rb}

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require 'openra/yaml
+require 'openra/mini_yaml

data/lib/openra/cli.rb

@@ -9,6 +9,7 @@ require 'openra/constants'
 require 'openra/replays'
 require 'openra/cli/utils'
 require 'openra/cli/formatters'
+require 'openra/cli/commands/metadata'
 require 'openra/cli/commands/replay_data'
 require 'openra/cli/commands/version'
 require 'openra/cli/command_registry'

data/lib/openra/cli/command_registry.rb

@@ -5,6 +5,7 @@ module Openra
     class CommandRegistry
       extend Dry::CLI::Registry
 
+      register 'metadata', Commands::Metadata
       register 'replay-data', Commands::ReplayData
       register 'version', Commands::Version
     end

data/lib/openra/cli/commands/metadata.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Openra
+  class CLI
+    module Commands
+      class Metadata < Dry::CLI::Command
+        include CLI::Utils
+
+        desc 'Output replay metadata to stdout'
+
+        argument :replay, required: true, desc: 'Path of the replay file to read data from'
+        option :format, default: 'json', values: %w(json pretty-json yaml), desc: 'Output format'
+
+        def call(replay:, **options)
+          replay = Openra::Replays::Replay.new(replay)
+
+          data = {
+            mod: replay.metadata.mod,
+            version: replay.metadata.version,
+            map: {
+              name: utf8(replay.metadata.map_name),
+              hash: replay.metadata.map_hash
+            },
+            game: {
+              type: replay.players.each_with_object(Hash.new(0)) { |player, hash|
+                if player.team.nil?
+                  hash[SecureRandom.uuid] += 1
+                else
+                  hash[player.team] += 1
+                end
+              }.values.join('v'),
+              start_time: replay.metadata.start_time.iso8601,
+              end_time: replay.metadata.end_time.iso8601,
+              duration: time((replay.metadata.end_time - replay.metadata.start_time) * 1000)
+            },
+            players: replay.players.map { |player|
+              {
+                player_index: player.client_index,
+                name: utf8(player.name),
+                fingerprint: player.fingerprint,
+                color: player.color,
+                spawn: {
+                  random: player&.is_random_spawn,
+                  point: player.spawn_point
+                },
+                faction: {
+                  random: player&.is_random_faction,
+                  chosen: player.faction_name.downcase,
+                  actual: player&.faction_id
+                },
+                team: player&.team,
+                is_bot: player&.is_bot || false,
+                is_winner: player&.outcome == 'Won',
+                outcome_time: player.outcome_time.iso8601
+              }
+            }
+          }
+
+          puts FORMATTERS.fetch(options[:format]).call(data)
+        end
+      end
+    end
+  end
+end

data/lib/openra/cli/commands/replay_data.rb

@@ -40,9 +40,8 @@ module Openra
             chat: []
           }
 
-          game_started = false
           current_sync_clients = []
-          sync_info = nil
+          current_sync_info = nil
 
           replay.each_order do |order|
             client = current_sync_clients.find do |candidate|
@@ -51,9 +50,7 @@ module Openra
 
             case order.command
             when 'StartGame'
-              game_started = true
-
-              data[:clients] = sync_info.clients.map do |client|
+              data[:clients] = current_sync_info.clients.map do |client|
                 player = replay.player(client.index)
                 player_index = replay.players.index(player) + FIRST_PLAYER_INDEX if player
 
@@ -69,6 +66,7 @@ module Openra
                     point: client.spawn_point
                   },
                   faction: {
+                    random: player&.is_random_faction,
                     chosen: client.faction_name.downcase,
                     actual: player&.faction_id
                   },
@@ -78,33 +76,35 @@ module Openra
                   is_admin: client.is_admin,
                   is_player: !player.nil?,
                   is_winner: player&.outcome == 'Won',
+                  outcome_time: player.outcome_time.iso8601,
                   build: [],
                   support_powers: []
                 }
               end
 
               data[:game][:options] = {
-                explored_map: sync_info.global_settings.game_options.explored_map_enabled.value,
-                speed: sync_info.global_settings.game_options.game_speed.value,
-                starting_cash: sync_info.global_settings.game_options.starting_cash.value,
-                starting_units: sync_info.global_settings.game_options.starting_units.value,
-                fog_enabled: sync_info.global_settings.game_options.fog_enabled.value,
-                cheats_enabled: sync_info.global_settings.game_options.cheats_enabled.value,
-                kill_bounty_enabled: sync_info.global_settings.game_options.bounties_enabled.value,
-                allow_undeploy: sync_info.global_settings.game_options.conyard_undeploy_enabled.value,
-                crates_enabled: sync_info.global_settings.game_options.crates_enabled.value,
-                build_off_allies: sync_info.global_settings.game_options.build_off_allies_enabled.value,
-                restrict_build_radius: sync_info.global_settings.game_options.restricted_build_radius_enabled.value,
-                short_game: sync_info.global_settings.game_options.short_game_enabled.value,
-                techlevel: sync_info.global_settings.game_options.tech_level.value
+                explored_map: current_sync_info.global_settings.game_options.explored_map_enabled.value,
+                speed: current_sync_info.global_settings.game_options.game_speed.value,
+                starting_cash: current_sync_info.global_settings.game_options.starting_cash.value,
+                starting_units: current_sync_info.global_settings.game_options.starting_units.value,
+                fog_enabled: current_sync_info.global_settings.game_options.fog_enabled.value,
+                cheats_enabled: current_sync_info.global_settings.game_options.cheats_enabled.value,
+                kill_bounty_enabled: current_sync_info.global_settings.game_options.bounties_enabled.value,
+                allow_undeploy: current_sync_info.global_settings.game_options.conyard_undeploy_enabled.value,
+                crates_enabled: current_sync_info.global_settings.game_options.crates_enabled.value,
+                build_off_allies: current_sync_info.global_settings.game_options.build_off_allies_enabled.value,
+                restrict_build_radius: current_sync_info.global_settings.game_options.restricted_build_radius_enabled.value,
+                short_game: current_sync_info.global_settings.game_options.short_game_enabled.value,
+                techlevel: current_sync_info.global_settings.game_options.tech_level.value
               }
             when 'SyncInfo'
-              sync_info = Openra::Struct::SyncInfo.new(
-                Openra::YAML.load(order.target)
-              ) unless game_started
+              current_sync_info = Openra::Struct::SyncInfo.new(
+                Openra::MiniYAML.load(order.target)
+              )
+              current_sync_clients = current_sync_info.clients
             when 'SyncLobbyClients'
               current_sync_clients = Openra::Struct::SyncLobbyClients.new(
-                Openra::YAML.load(order.target)
+                Openra::MiniYAML.load(order.target)
               ).clients
             when *support_powers.keys
               key = support_powers.fetch(utf8(order.command))
@@ -114,7 +114,7 @@ module Openra
 
               client_hash[:support_powers] << {
                 type: key,
-                game_time: time(order.frame.pred * sync_info.global_settings.frametime_multiplier),
+                game_time: time(order.frame.pred * current_sync_info.global_settings.frametime_multiplier),
                 placement: cell(order.target_cell.to_i),
                 extra_placement: cell(order.extra_cell.to_i),
               }
@@ -127,7 +127,7 @@ module Openra
 
               client_hash[:build] << {
                 structure: utf8(order.target),
-                game_time: time(order.frame.pred * sync_info.global_settings.frametime_multiplier),
+                game_time: time(order.frame.pred * current_sync_info.global_settings.frametime_multiplier),
                 placement: cell(order.target_cell.to_i)
               }
             when 'Message'
@@ -151,7 +151,7 @@ module Openra
             end
           end
 
-          data[:server_name] = utf8(sync_info.global_settings.server_name)
+          data[:server_name] = utf8(current_sync_info.global_settings.server_name)
 
           puts FORMATTERS.fetch(options[:format]).call(data)
         end

data/lib/openra/cli/utils.rb

@@ -7,6 +7,7 @@ module Openra
         string.force_encoding('UTF-8')
       end
 
+      # https://github.com/OpenRA/OpenRA/blob/bleed/OpenRA.Game/CPos.cs#L24
       def cell(pos)
         return if pos.zero?
 

data/lib/openra/constants.rb

@@ -1,6 +1,17 @@
 # frozen_string_literal: true
 
 module Openra
+  # # https://github.com/OpenRA/OpenRA/blob/23b3c237b7071fd308c4664b0b6c5d719c0f3c74/OpenRA.Game/Map/MapPlayers.cs
+  # The player index is stored in the subject_id on orders to indicate which
+  # player issued the order, this is used because bot orders are issued by the
+  # host client
+  # I think the indices are as follows, but may differ for scripted maps:
+  # 0 => World
+  # 1 => Neutral
+  # 2 => Creeps
+  # 3 => Players@{0}
+  # 4 => Players@{1}
+  # 5 => ...
   FIRST_PLAYER_INDEX = 3
 
   SUPPORT_POWERS = {
@@ -9,6 +20,7 @@ module Openra
       'SovietParatroopers' => :paratroopers,
       'UkraineParabombs' => :parabombs,
       'Chronoshift' => :chronoshift,
+      'AdvancedChronoshift' => :chronoshift,
       'NukePowerInfoOrder' => :nuke,
       'GrantExternalConditionPowerInfoOrder' => :iron_curtain
     },

data/lib/openra/{yaml.rb → mini_yaml.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Openra
-  class YAML
+  class MiniYAML
     MATCHER = /(?<indentation>\t+)?(?<key>[^\:]+)?\:?\s?(?<value>.+)?/.freeze
 
     def self.load(yaml_string)

data/lib/openra/replays.rb

@@ -4,7 +4,7 @@ require 'date'
 require 'bindata'
 require 'bindata/big_integer'
 require 'bindata/pascal_string'
-require 'openra/yaml'
+require 'openra/mini_yaml'
 require 'openra/struct'
 require 'openra/replays/order_decorator'
 require 'openra/replays/order'

data/lib/openra/replays/file.rb

@@ -25,15 +25,15 @@ module Openra
       end
 
       def metadata
+        # https://github.com/OpenRA/OpenRA/blob/23b3c237b7071fd308c4664b0b6c5d719c0f3c74/OpenRA.Game/FileFormats/ReplayMetadata.cs#L96
         @metadata ||= begin
-          metadata_fs = file.tap(&:rewind)
-          offset = -(metadata_marker.data_length + 4)
-          metadata_fs.seek(offset, IO::SEEK_END)
-          Metadata.read(metadata_fs)
+          io = file.tap(&:rewind)
+          metadata_offset = -(metadata_marker.data_length + 4)
+          io.seek(metadata_offset, IO::SEEK_END)
+          Metadata.read(io)
         end
       end
 
-
       private
 
       attr_reader :filename

data/lib/openra/replays/metadata.rb

@@ -5,6 +5,7 @@ module Openra
     class Metadata < BinData::Record
       endian :little
       count_bytes_remaining :total_size
+      # -8 to remove metadata marker (int32)
       string :data, length: -> { total_size - 8 }
     end
   end

data/lib/openra/replays/metadata_marker.rb

@@ -2,6 +2,8 @@
 
 module Openra
   module Replays
+    # The metadata markers is an int32 marker at the end of the file, indicating
+    # the offset at which the metadata MiniYAML is stored in the replay file
     class MetadataMarker < BinData::Record
       endian :little
       count_bytes_remaining :total_size

data/lib/openra/replays/order.rb

@@ -2,6 +2,7 @@
 
 module Openra
   module Replays
+    # https://github.com/OpenRA/OpenRA/blob/bleed/OpenRA.Game/Network/Order.cs
     class Order < BinData::Record
       HEX_FE = ?\xFE.dup.force_encoding('ASCII-8BIT').freeze
       HEX_FF = ?\xFF.dup.force_encoding('ASCII-8BIT').freeze

data/lib/openra/replays/replay.rb

@@ -11,7 +11,7 @@ module Openra
 
       def metadata
         @metadata ||= Openra::Struct::Metadata.new(
-          Openra::YAML.load(file.metadata.data)
+          Openra::MiniYAML.load(file.metadata.data)
         )
       end
 

data/lib/openra/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Openra
-  VERSION = '2.2.0'.freeze
+  VERSION = '2.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openra
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Andy Holland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-13 00:00:00.000000000 Z
+date: 2020-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -151,18 +151,20 @@ files:
 - lib/bindata/big_integer.rb
 - lib/bindata/pascal_string.rb
 - lib/openra-cli.rb
+- lib/openra-mini_yaml.rb
 - lib/openra-replays.rb
 - lib/openra-struct.rb
 - lib/openra-types.rb
-- lib/openra-yaml.rb
 - lib/openra.rb
 - lib/openra/cli.rb
 - lib/openra/cli/command_registry.rb
+- lib/openra/cli/commands/metadata.rb
 - lib/openra/cli/commands/replay_data.rb
 - lib/openra/cli/commands/version.rb
 - lib/openra/cli/formatters.rb
 - lib/openra/cli/utils.rb
 - lib/openra/constants.rb
+- lib/openra/mini_yaml.rb
 - lib/openra/replays.rb
 - lib/openra/replays/file.rb
 - lib/openra/replays/metadata.rb
@@ -187,7 +189,6 @@ files:
 - lib/openra/struct/sync_lobby_clients.rb
 - lib/openra/types.rb
 - lib/openra/version.rb
-- lib/openra/yaml.rb
 - openra.gemspec
 homepage: https://github.com/AMHOL/openra-ruby
 licenses: