vault_coh 4.0.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efcd317fb3639ebb84a7fcb11f7d3b513422211d1c2b87f3e564ce4ddbf78f74
-  data.tar.gz: c52abcfeceab7cafcb94f15e93dad181afb600bc8bbbb29e0ebf8ea0ebe61c33
+  metadata.gz: b761236eb71771fd8c489d2867ae4ec1b77361e0834ae8636ea86e492994ea1c
+  data.tar.gz: b600e4662c61af2a3ccbe1104de63ad506909de5daaff9d0171ecbe397862ce2
 SHA512:
-  metadata.gz: 866f6b1d80b16c5a006d0f3878202225c26b08138e088c24b31990e71a698a137e5f04bc58992dd038826939dacc75f356409566c0b358a637315ebe3309e789
-  data.tar.gz: a5d2d75254cbeb6bdc05b23fb0adec01d9df3c379d8b862be8b4e8568f56d56eb349255b1cf4b49bd68ff76202366b7ccd22eb445abf65576cabacb2126a1a55
+  metadata.gz: 033d7db015b8ff4cfc49c93b71d47d625790766844c2b3693faf17dcf1ece45bde53772622f9a4e223845166327cdbbc87891cdfd79ff6b9b6eba5a5962e9da6
+  data.tar.gz: 5c61de1481d40eaf667a9b70cc67ab1e93fe50a7b8f6853e79e58aacda8d48a21d4daa1540de150899d4fd359b1805eabc6273882f8fdefeae1cc00b68ca2d07

data/Cargo.lock

@@ -322,9 +322,9 @@ checksum = "24188a676b6ae68c3b2cb3a01be17fbf7240ce009799bb56d5b1409051e78fde"
 
 [[package]]
 name = "shlex"
-version = "1.2.0"
+version = "1.3.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a7cee0529a6d40f580e7a5e6c495c8fbfe21b7b52795ed4bb5e62cdf92bc6380"
+checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64"
 
 [[package]]
 name = "syn"
@@ -360,11 +360,20 @@ version = "1.0.12"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b"
 
+[[package]]
+name = "uuid"
+version = "1.7.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f00cc9702ca12d3c81455259621e676d0f7251cec66a21e98fe2e9a37db93b2a"
+dependencies = [
+ "serde",
+]
+
 [[package]]
 name = "vault"
-version = "7.0.0"
+version = "9.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c883ce2ee65509850bbf77b935dac0d6876392de077138650de1f5d109381bd8"
+checksum = "771f7db565a750b784bea91fc8cf5190fca40a1f77c791e05d5a5e4168bfff59"
 dependencies = [
  "byteorder",
  "magnus",
@@ -372,6 +381,7 @@ dependencies = [
  "nom-tracable",
  "nom_locate",
  "serde",
+ "uuid",
 ]
 
 [[package]]

data/Gemfile

@@ -5,11 +5,11 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in vault_coh.gemspec
 gemspec
 
-gem 'rake', '~> 13.0'
+gem 'rake', '~> 13.2'
 
 gem 'rake-compiler'
 gem 'rb_sys'
 
-gem 'rspec', '~> 3.0'
+gem 'rspec', '~> 3.13'
 
-gem 'rubocop', '~> 1.59'
+gem 'rubocop', '~> 1.64'

data/Gemfile.lock

@@ -1,54 +1,56 @@
 PATH
   remote: .
   specs:
-    vault_coh (4.0.0)
+    vault_coh (6.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    diff-lcs (1.5.0)
-    json (2.7.1)
+    diff-lcs (1.5.1)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
     parallel (1.24.0)
-    parser (3.3.0.3)
+    parser (3.3.2.0)
       ast (~> 2.4.1)
       racc
-    racc (1.7.3)
+    racc (1.8.0)
     rainbow (3.1.1)
-    rake (13.1.0)
-    rake-compiler (1.2.5)
+    rake (13.2.1)
+    rake-compiler (1.2.7)
       rake
-    rb_sys (0.9.86)
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    rb_sys (0.9.97)
+    regexp_parser (2.9.2)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
-    rubocop (1.59.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.64.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.4)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
     ruby-progressbar (1.13.0)
+    strscan (3.1.0)
     unicode-display_width (2.5.0)
 
 PLATFORMS
@@ -56,11 +58,11 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  rake (~> 13.0)
+  rake (~> 13.2)
   rake-compiler
   rb_sys
-  rspec (~> 3.0)
-  rubocop (~> 1.59)
+  rspec (~> 3.13)
+  rubocop (~> 1.64)
   vault_coh!
 
 BUNDLED WITH

data/README.md

@@ -1,12 +1,12 @@
 # Vault
 
-[![Gem Version](https://badge.fury.io/rb/vault_coh.svg)](https://badge.fury.io/rb/vault_coh) [![Documentation](https://img.shields.io/badge/View-Documentation-blue.svg)](https://rubydoc.info/github/ryantaylor/vault-rb/v4.0.0)
+[![Gem Version](https://badge.fury.io/rb/vault_coh.svg)](https://badge.fury.io/rb/vault_coh) [![Documentation](https://img.shields.io/badge/View-Documentation-blue.svg)](https://rubydoc.info/github/ryantaylor/vault-rb/v6.0.0)
 
 A native Ruby client wrapper for the [vault](https://github.com/ryantaylor/vault) Company of Heroes replay parser, integrated via a Rust native extension.
 
 ## Installation
 
-First, make sure you have a relatively recent version of the Rust toolchain installed (minimum supported Rust version for `vault` is 1.65.0). You can install Rust easily using [rustup](https://rustup.rs/).
+First, make sure you have a relatively recent version of the Rust toolchain installed (minimum supported Rust version for `vault` is 1.66.0). You can install Rust easily using [rustup](https://rustup.rs/).
 
 Then you can add to Gemfile:
 ```
@@ -24,7 +24,7 @@ bytes = File.read('/path/to/replay.rec').unpack('C*')
 replay = VaultCoh::Replay.from_bytes(bytes)
 puts replay.version
 ```
-All information available from parsing can be found in the [documentation](https://rubydoc.info/github/ryantaylor/vault-rb/v4.0.0).
+All information available from parsing can be found in the [documentation](https://rubydoc.info/github/ryantaylor/vault-rb/v6.0.0).
 
 ## Contributing
 

data/ext/vault_coh/Cargo.toml

@@ -12,4 +12,4 @@ crate-type = ["cdylib"]
 [dependencies]
 magnus = { version = "0.6" }
 serde_magnus = { version = "0.8" }
-vault = { version = "7", features = ["magnus", "serde"] }
+vault = { version = "9", features = ["magnus", "serde"] }

data/ext/vault_coh/src/hash.rs

@@ -1,8 +1,4 @@
-use magnus::Value;
-use vault::commands::{
-    BuildGlobalUpgrade, BuildSquad, SelectBattlegroup, SelectBattlegroupAbility, Unknown,
-    UseBattlegroupAbility,
-};
+use magnus::{value::ReprValue, RHash, RString, Value};
 use vault::{Command, Map, Message, Player, Replay};
 
 pub trait HashExt {
@@ -35,42 +31,73 @@ impl HashExt for Message {
 
 impl HashExt for Command {
     fn to_h(&self) -> Value {
-        serde_magnus::serialize(self).unwrap()
-    }
-}
-
-impl HashExt for BuildGlobalUpgrade {
-    fn to_h(&self) -> Value {
-        serde_magnus::serialize(self).unwrap()
-    }
-}
-
-impl HashExt for BuildSquad {
-    fn to_h(&self) -> Value {
-        serde_magnus::serialize(self).unwrap()
-    }
-}
-
-impl HashExt for SelectBattlegroup {
-    fn to_h(&self) -> Value {
-        serde_magnus::serialize(self).unwrap()
-    }
-}
-
-impl HashExt for SelectBattlegroupAbility {
-    fn to_h(&self) -> Value {
-        serde_magnus::serialize(self).unwrap()
-    }
-}
-
-impl HashExt for UseBattlegroupAbility {
-    fn to_h(&self) -> Value {
-        serde_magnus::serialize(self).unwrap()
-    }
-}
-
-impl HashExt for Unknown {
-    fn to_h(&self) -> Value {
-        serde_magnus::serialize(self).unwrap()
+        match self {
+            Command::BuildGlobalUpgrade(data) => {
+                let hash: RHash = serde_magnus::serialize(data).unwrap();
+                hash.aset("type", RString::new("BuildGlobalUpgrade"))
+                    .unwrap();
+                hash.aset("action_type", RString::new("CMD_Upgrade"))
+                    .unwrap();
+                hash.as_value()
+            }
+            Command::BuildSquad(data) => {
+                let hash: RHash = serde_magnus::serialize(data).unwrap();
+                hash.aset("type", RString::new("BuildSquad")).unwrap();
+                hash.aset("action_type", RString::new("CMD_BuildSquad"))
+                    .unwrap();
+                hash.as_value()
+            }
+            Command::CancelConstruction(data) => {
+                let hash: RHash = serde_magnus::serialize(data).unwrap();
+                hash.aset("type", RString::new("CancelConstruction"))
+                    .unwrap();
+                hash.aset("action_type", RString::new("CMD_CancelConstruction"))
+                    .unwrap();
+                hash.as_value()
+            }
+            Command::CancelProduction(data) => {
+                let hash: RHash = serde_magnus::serialize(data).unwrap();
+                hash.aset("type", RString::new("CancelProduction")).unwrap();
+                hash.aset("action_type", RString::new("CMD_CancelProduction"))
+                    .unwrap();
+                hash.as_value()
+            }
+            Command::SelectBattlegroup(data) => {
+                let hash: RHash = serde_magnus::serialize(data).unwrap();
+                hash.aset("type", RString::new("SelectBattlegroup"))
+                    .unwrap();
+                hash.aset("action_type", RString::new("PCMD_InstantUpgrade"))
+                    .unwrap();
+                hash.as_value()
+            }
+            Command::SelectBattlegroupAbility(data) => {
+                let hash: RHash = serde_magnus::serialize(data).unwrap();
+                hash.aset("type", RString::new("SelectBattlegroupAbility"))
+                    .unwrap();
+                hash.aset("action_type", RString::new("PCMD_TentativeUpgrade"))
+                    .unwrap();
+                hash.as_value()
+            }
+            Command::Unknown(data) => {
+                let hash: RHash = serde_magnus::serialize(data).unwrap();
+                hash.aset("type", RString::new("Unknown")).unwrap();
+                hash.as_value()
+            }
+            Command::UseAbility(data) => {
+                let hash: RHash = serde_magnus::serialize(data).unwrap();
+                hash.aset("type", RString::new("UseAbility")).unwrap();
+                hash.aset("action_type", RString::new("CMD_Ability"))
+                    .unwrap();
+                hash.as_value()
+            }
+            Command::UseBattlegroupAbility(data) => {
+                let hash: RHash = serde_magnus::serialize(data).unwrap();
+                hash.aset("type", RString::new("UseBattlegroupAbility"))
+                    .unwrap();
+                hash.aset("action_type", RString::new("PCMD_Ability"))
+                    .unwrap();
+                hash.as_value()
+            }
+        }
     }
 }

data/ext/vault_coh/src/lib.rs

@@ -2,11 +2,7 @@ mod hash;
 
 use crate::hash::HashExt;
 use magnus::{class, define_module, exception, function, method, prelude::*, Error};
-use vault::commands::{
-    BuildGlobalUpgrade, BuildSquad, SelectBattlegroup, SelectBattlegroupAbility, Unknown,
-    UseBattlegroupAbility,
-};
-use vault::{Command, Faction, Map, Message, Player, Replay, Team};
+use vault::{Command, Map, Message, Player, Replay};
 
 #[magnus::init]
 fn init() -> Result<(), Error> {
@@ -16,7 +12,9 @@ fn init() -> Result<(), Error> {
     replay.define_singleton_method("from_bytes", function!(from_bytes, 1))?;
     replay.define_method("version", method!(Replay::version, 0))?;
     replay.define_method("timestamp", method!(Replay::timestamp, 0))?;
+    replay.define_method("game_type", method!(game_type_string, 0))?;
     replay.define_method("matchhistory_id", method!(Replay::matchhistory_id, 0))?;
+    replay.define_method("mod_uuid", method!(mod_uuid_string, 0))?;
     replay.define_method("map", method!(Replay::map, 0))?;
     replay.define_method("map_filename", method!(Replay::map_filename, 0))?;
     replay.define_method(
@@ -43,8 +41,8 @@ fn init() -> Result<(), Error> {
     let player = module.define_class("Player", class::object())?;
     player.define_method("name", method!(Player::name, 0))?;
     player.define_method("human?", method!(Player::human, 0))?;
-    player.define_method("faction", method!(Player::faction, 0))?;
-    player.define_method("team", method!(Player::team, 0))?;
+    player.define_method("faction", method!(faction_string, 0))?;
+    player.define_method("team", method!(team_value, 0))?;
     player.define_method("battlegroup", method!(Player::battlegroup, 0))?;
     player.define_method("steam_id", method!(Player::steam_id, 0))?;
     player.define_method("profile_id", method!(Player::profile_id, 0))?;
@@ -62,81 +60,9 @@ fn init() -> Result<(), Error> {
     message.define_method("message", method!(Message::message, 0))?;
     message.define_method("to_h", method!(Message::to_h, 0))?;
 
-    let faction = module.define_class("Faction", class::object())?;
-    faction.define_method("value", method!(Faction::to_string, 0))?;
-
-    let team = module.define_class("Team", class::object())?;
-    team.define_method("value", method!(Team::value, 0))?;
-
     let command = module.define_class("Command", class::object())?;
     command.define_method("to_h", method!(Command::to_h, 0))?;
 
-    let commands_module = module.define_module("Commands")?;
-
-    let build_global_upgrade_command =
-        commands_module.define_class("BuildGlobalUpgradeCommand", command)?;
-    build_global_upgrade_command
-        .define_method("value", method!(Command::extract_build_global_upgrade, 0))?;
-
-    let build_global_upgrade =
-        commands_module.define_class("BuildGlobalUpgrade", class::object())?;
-    build_global_upgrade.define_method("tick", method!(BuildGlobalUpgrade::tick, 0))?;
-    build_global_upgrade.define_method("pbgid", method!(BuildGlobalUpgrade::pbgid, 0))?;
-    build_global_upgrade.define_method("to_h", method!(BuildGlobalUpgrade::to_h, 0))?;
-
-    let build_squad_command = commands_module.define_class("BuildSquadCommand", command)?;
-    build_squad_command.define_method("value", method!(Command::extract_build_squad, 0))?;
-
-    let build_squad = commands_module.define_class("BuildSquad", class::object())?;
-    build_squad.define_method("tick", method!(BuildSquad::tick, 0))?;
-    build_squad.define_method("pbgid", method!(BuildSquad::pbgid, 0))?;
-    build_squad.define_method("to_h", method!(BuildSquad::to_h, 0))?;
-
-    let select_battlegroup_command =
-        commands_module.define_class("SelectBattlegroupCommand", command)?;
-    select_battlegroup_command
-        .define_method("value", method!(Command::extract_select_battlegroup, 0))?;
-
-    let select_battlegroup = commands_module.define_class("SelectBattlegroup", class::object())?;
-    select_battlegroup.define_method("tick", method!(SelectBattlegroup::tick, 0))?;
-    select_battlegroup.define_method("pbgid", method!(SelectBattlegroup::pbgid, 0))?;
-    select_battlegroup.define_method("to_h", method!(SelectBattlegroup::to_h, 0))?;
-
-    let select_battlegroup_ability_command =
-        commands_module.define_class("SelectBattlegroupAbilityCommand", command)?;
-    select_battlegroup_ability_command.define_method(
-        "value",
-        method!(Command::extract_select_battlegroup_ability, 0),
-    )?;
-
-    let select_battlegroup_ability =
-        commands_module.define_class("SelectBattlegroupAbility", class::object())?;
-    select_battlegroup_ability.define_method("tick", method!(SelectBattlegroupAbility::tick, 0))?;
-    select_battlegroup_ability
-        .define_method("pbgid", method!(SelectBattlegroupAbility::pbgid, 0))?;
-    select_battlegroup_ability.define_method("to_h", method!(SelectBattlegroupAbility::to_h, 0))?;
-
-    let use_battlegroup_ability_command =
-        commands_module.define_class("UseBattlegroupAbilityCommand", command)?;
-    use_battlegroup_ability_command.define_method(
-        "value",
-        method!(Command::extract_use_battlegroup_ability, 0),
-    )?;
-
-    let use_battlegroup_ability =
-        commands_module.define_class("UseBattlegroupAbility", class::object())?;
-    use_battlegroup_ability.define_method("tick", method!(UseBattlegroupAbility::tick, 0))?;
-    use_battlegroup_ability.define_method("pbgid", method!(UseBattlegroupAbility::pbgid, 0))?;
-    use_battlegroup_ability.define_method("to_h", method!(UseBattlegroupAbility::to_h, 0))?;
-
-    let unknown_command = commands_module.define_class("UnknownCommand", command)?;
-    unknown_command.define_method("value", method!(Command::extract_unknown, 0))?;
-
-    let unknown = commands_module.define_class("Unknown", class::object())?;
-    unknown.define_method("tick", method!(Unknown::tick, 0))?;
-    unknown.define_method("action_type", method!(Unknown::action_type, 0))?;
-    unknown.define_method("to_h", method!(Unknown::to_h, 0))?;
-
     Ok(())
 }
 
@@ -144,3 +70,19 @@ fn from_bytes(input: Vec<u8>) -> Result<Replay, Error> {
     Replay::from_bytes(&input)
         .map_err(|err| Error::new(exception::runtime_error(), err.to_string()))
 }
+
+fn mod_uuid_string(rb_self: &Replay) -> String {
+    rb_self.mod_uuid().to_string()
+}
+
+fn game_type_string(rb_self: &Replay) -> String {
+    rb_self.game_type().to_string()
+}
+
+fn faction_string(rb_self: &Player) -> String {
+    rb_self.faction().to_string()
+}
+
+fn team_value(rb_self: &Player) -> usize {
+    rb_self.team().value()
+}

data/lib/vault_coh/command.rb

@@ -3,17 +3,6 @@
 module VaultCoh
   # Base class that all command wrappers extend.
   class Command
-    # Data object that contains information specific to the
-    # type of command it represents.
-    #
-    # @return [Commands::BuildGlobalUpgrade |
-    #          Commands::BuildSquad |
-    #          Commands::SelectBattlegroup |
-    #          Commands::SelectBattlegroupAbility |
-    #          Commands::UseBattlegroupAbility |
-    #          Commands::Unknown]
-    def value; end
-
     # Returns a hash representation of the object.
     #
     # @return [Hash]

data/lib/vault_coh/faction.rb

@@ -3,16 +3,9 @@
 module VaultCoh
   # Identifiers for the Company of Heroes 3 factions.
   class Faction
-    AMERICANS = 'Americans'
-    BRITISH = 'British'
-    WEHRMACHT = 'Wehrmacht'
-    AFRIKAKORPS = 'AfrikaKorps'
-
-    # String identifier of the given faction.
-    #
-    # @see https://docs.rs/vault/3.0.0/vault/enum.Faction.html
-    #
-    # @return [AMERICANS|BRITISH|WEHRMACHT|AFRIKAKORPS]
-    def value; end
+    AMERICANS = 'americans'
+    BRITISH = 'british_africa'
+    WEHRMACHT = 'germans'
+    AFRIKAKORPS = 'afrika_korps'
   end
 end

data/lib/vault_coh/game_type.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module VaultCoh
+  # Identifiers for the Company of Heroes 3 game types.
+  class GameType
+    SKIRMISH = 'skirmish'
+    MULTIPLAYER = 'multiplayer'
+    AUTOMATCH = 'automatch'
+    CUSTOM = 'custom'
+  end
+end

data/lib/vault_coh/player.rb

@@ -20,13 +20,13 @@ module VaultCoh
 
     # The faction selected by the player in this match.
     #
-    # @return [Faction]
+    # @return [Faction::AMERICANS|Faction::WEHRMACHT|Faction::BRITISH|Faction::AFRIKAKORPS]
     def faction; end
 
     # The team the player was assigned to. Currently only head-to-head
     # matchups are supported (max two teams).
     #
-    # @return [Team]
+    # @return [Team::FIRST|Team::SECOND]
     def team; end
 
     # The pbgid of the battlegroup the player selected, or +nil+ if no
@@ -75,9 +75,7 @@ module VaultCoh
     # or use of battlegroups and their abilities. Sorted chronologically
     # from first to last.
     #
-    # @return [Array<Commands::SelectBattlegroupCommand |
-    #                Commands::SelectBattlegroupAbilityCommand |
-    #                Commands::UseBattlegroupAbilityCommand>]
+    # @return [Array<Command>]
     def battlegroup_commands; end
 
     # Returns a hash representation of the object.

data/lib/vault_coh/replay.rb

@@ -40,14 +40,34 @@ module VaultCoh
     # @return [String]
     def timestamp; end
 
+    # The type of game this replay represents. Note that this information
+    # is parsed on a best-effort basis and therefore may not always be
+    # correct. Also note that it's currently not known if there's a way to
+    # differentiate between automatch and custom games for replays recorded
+    # before the replay system release in patch 1.4.0. Games played before
+    # that patch will be marked as either +skirmish+ (for local AI games) or
+    # +multiplayer+ (for networked custom or automatch games). Games recorded
+    # on or after patch 1.4.0 will properly differentiate between +custom+
+    # and +automatch+ games.
+    #
+    # @return [GameType::SKIRMISH|GameType::MULTIPLAYER|GameType::AUTOMATCH|GameType::CUSTOM]
+    def game_type; end
+
     # The ID used by Relic to track this match on their internal servers.
     # This ID can be matched with an ID of the same name returned by
     # Relic’s CoH3 stats API, enabling linkage between replay files and
-    # statistical information for a match.
+    # statistical information for a match. When the game type is +skirmish+,
+    # there is no ID assigned by Relic, so this will be +nil+.
     #
-    # @return [Integer] unsigned, 64 bits
+    # @return [Integer|NilClass] unsigned, 64 bits
     def matchhistory_id; end
 
+    # The UUID of the base game mod this replay ran on. If no mod was used,
+    # this will be a nil UUID (all zeroes).
+    #
+    # @return [String]
+    def mod_uuid; end
+
     # Map information for this match.
     #
     # @return [Map]

data/lib/vault_coh/team.rb

@@ -5,12 +5,5 @@ module VaultCoh
   class Team
     FIRST = 0
     SECOND = 1
-
-    # Integer representation of the assigned team.
-    #
-    # @see https://docs.rs/vault/3.0.0/vault/enum.Team.html
-    #
-    # @return [FIRST|SECOND]
-    def value; end
   end
 end

data/lib/vault_coh/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module VaultCoh
-  VERSION = '4.0.0'
+  VERSION = '6.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vault_coh
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 6.0.0
 platform: ruby
 authors:
 - ryantaylor
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-21 00:00:00.000000000 Z
+date: 2024-06-03 00:00:00.000000000 Z
 dependencies: []
 description: Company of Heroes replay parsing in Ruby using the vault parsing library
   via a Rust native extension.
@@ -36,20 +36,8 @@ files:
 - ext/vault_coh/src/lib.rs
 - lib/vault_coh.rb
 - lib/vault_coh/command.rb
-- lib/vault_coh/commands.rb
-- lib/vault_coh/commands/build_global_upgrade.rb
-- lib/vault_coh/commands/build_global_upgrade_command.rb
-- lib/vault_coh/commands/build_squad.rb
-- lib/vault_coh/commands/build_squad_command.rb
-- lib/vault_coh/commands/select_battlegroup.rb
-- lib/vault_coh/commands/select_battlegroup_ability.rb
-- lib/vault_coh/commands/select_battlegroup_ability_command.rb
-- lib/vault_coh/commands/select_battlegroup_command.rb
-- lib/vault_coh/commands/unknown.rb
-- lib/vault_coh/commands/unknown_command.rb
-- lib/vault_coh/commands/use_battlegroup_ability.rb
-- lib/vault_coh/commands/use_battlegroup_ability_command.rb
 - lib/vault_coh/faction.rb
+- lib/vault_coh/game_type.rb
 - lib/vault_coh/map.rb
 - lib/vault_coh/message.rb
 - lib/vault_coh/player.rb
@@ -81,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.3.11
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: CoH3 replay parsing in Ruby with Rust

data/lib/vault_coh/commands/build_global_upgrade.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module VaultCoh
-  module Commands
-    # Data object representing information parsed from an
-    # upgrade construction command.
-    class BuildGlobalUpgrade
-      # This value is the tick at which the command was
-      # found while parsing the replay, which represents
-      # the time in the replay at which it was executed.
-      # Because CoH3's engine runs at 8 ticks per second,
-      # you can divide this value by 8 to get the number
-      # of seconds since the replay began, which will tell
-      # you when this command was executed.
-      #
-      # @return [Integer] unsigned, 32 bits
-      def tick; end
-
-      # Internal ID that uniquely identifies the upgrade being
-      # built. This value can be matched to CoH3 attribute
-      # files in order to determine the upgrade being built.
-      # Note that, while rare, it is possible that this value
-      # may change between patches for the same upgrade.
-      #
-      # @return [Integer] unsigned, 32 bits
-      def pbgid; end
-
-      # Returns a hash representation of the object.
-      #
-      # @return [Hash]
-      def to_h; end
-    end
-  end
-end

data/lib/vault_coh/commands/build_global_upgrade_command.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module VaultCoh
-  module Commands
-    # Wrapper for an upgrade construction command.
-    class BuildGlobalUpgradeCommand < Command
-    end
-  end
-end

data/lib/vault_coh/commands/build_squad.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module VaultCoh
-  module Commands
-    # Data object representing information parsed from a
-    # unit construction command.
-    class BuildSquad
-      # This value is the tick at which the command was
-      # found while parsing the replay, which represents
-      # the time in the replay at which it was executed.
-      # Because CoH3's engine runs at 8 ticks per second,
-      # you can divide this value by 8 to get the number
-      # of seconds since the replay began, which will tell
-      # you when this command was executed.
-      #
-      # @return [Integer] unsigned, 32 bits
-      def tick; end
-
-      # Internal ID that uniquely identifies the unit being
-      # built. This value can be matched to CoH3 attribute
-      # files in order to determine the unit being built.
-      # Note that, while rare, it is possible that this value
-      # may change between patches for the same unit.
-      #
-      # @return [Integer] unsigned, 32 bits
-      def pbgid; end
-
-      # Returns a hash representation of the object.
-      #
-      # @return [Hash]
-      def to_h; end
-    end
-  end
-end

data/lib/vault_coh/commands/build_squad_command.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module VaultCoh
-  module Commands
-    # Wrapper for a unit construction command.
-    class BuildSquadCommand < Command
-    end
-  end
-end

data/lib/vault_coh/commands/select_battlegroup.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module VaultCoh
-  module Commands
-    # Data object representing information parsed from a
-    # battlegroup selection command.
-    class SelectBattlegroup
-      # This value is the tick at which the command was
-      # found while parsing the replay, which represents
-      # the time in the replay at which it was executed.
-      # Because CoH3's engine runs at 8 ticks per second,
-      # you can divide this value by 8 to get the number
-      # of seconds since the replay began, which will tell
-      # you when this command was executed.
-      #
-      # @return [Integer] unsigned, 32 bits
-      def tick; end
-
-      # Internal ID that uniquely identifies the battlegroup
-      # selected. This value can be matched to CoH3 attribute
-      # files in order to determine the battlegroup being
-      # selected. Note that, while rare, it is possible that
-      # this value may change between patches for the same
-      # battlegroup.
-      #
-      # @return [Integer] unsigned, 32 bits
-      def pbgid; end
-
-      # Returns a hash representation of the object.
-      #
-      # @return [Hash]
-      def to_h; end
-    end
-  end
-end

data/lib/vault_coh/commands/select_battlegroup_ability.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module VaultCoh
-  module Commands
-    # Data object representing information parsed from a
-    # battlegroup ability selection command.
-    class SelectBattlegroupAbility
-      # This value is the tick at which the command was
-      # found while parsing the replay, which represents
-      # the time in the replay at which it was executed.
-      # Because CoH3's engine runs at 8 ticks per second,
-      # you can divide this value by 8 to get the number
-      # of seconds since the replay began, which will tell
-      # you when this command was executed.
-      #
-      # @return [Integer] unsigned, 32 bits
-      def tick; end
-
-      # Internal ID that uniquely identifies the battlegroup
-      # ability selected. This value can be matched to CoH3
-      # attribute files in order to determine the battlegroup
-      # ability being selected. Note that, while rare, it is
-      # possible that this value may change between patches
-      # for the same battlegroup.
-      #
-      # @return [Integer] unsigned, 32 bits
-      def pbgid; end
-
-      # Returns a hash representation of the object.
-      #
-      # @return [Hash]
-      def to_h; end
-    end
-  end
-end

data/lib/vault_coh/commands/select_battlegroup_ability_command.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module VaultCoh
-  module Commands
-    # Wrapper for a battlegroup ability selection command.
-    class SelectBattlegroupAbilityCommand < Command
-    end
-  end
-end

data/lib/vault_coh/commands/select_battlegroup_command.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module VaultCoh
-  module Commands
-    # Wrapper for a battlegroup selection command.
-    class SelectBattlegroupCommand < Command
-    end
-  end
-end

data/lib/vault_coh/commands/unknown.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module VaultCoh
-  module Commands
-    # Data object representing an unknown (i.e. not yet
-    # handled) command.
-    class Unknown
-      # This value is the tick at which the command was
-      # found while parsing the replay, which represents
-      # the time in the replay at which it was executed.
-      # Because CoH3's engine runs at 8 ticks per second,
-      # you can divide this value by 8 to get the number
-      # of seconds since the replay began, which will tell
-      # you when this command was executed.
-      #
-      # @return [Integer] unsigned, 32 bits
-      def tick; end
-
-      # This value identifies the type of the command
-      # (build, move, stop, etc.). Commands with similar
-      # functionality can be grouped by this value.
-      #
-      # @return [Integer] unsigned, 8 bits
-      def action_type; end
-
-      # Returns a hash representation of the object.
-      #
-      # @return [Hash]
-      def to_h; end
-    end
-  end
-end

data/lib/vault_coh/commands/unknown_command.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module VaultCoh
-  module Commands
-    # Wrapper for an unknown (i.e. not yet handled) command.
-    class UnknownCommand < Command
-    end
-  end
-end

data/lib/vault_coh/commands/use_battlegroup_ability.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module VaultCoh
-  module Commands
-    # Data object representing information parsed from a
-    # battlegroup ability usage command.
-    class UseBattlegroupAbility
-      # This value is the tick at which the command was
-      # found while parsing the replay, which represents
-      # the time in the replay at which it was executed.
-      # Because CoH3's engine runs at 8 ticks per second,
-      # you can divide this value by 8 to get the number
-      # of seconds since the replay began, which will tell
-      # you when this command was executed.
-      #
-      # @return [Integer] unsigned, 32 bits
-      def tick; end
-
-      # Internal ID that uniquely identifies the battlegroup
-      # ability used. This value can be matched to CoH3
-      # attribute files in order to determine the battlegroup
-      # ability being used. Note that, while rare, it is
-      # possible that this value may change between patches
-      # for the same battlegroup.
-      #
-      # @return [Integer] unsigned, 32 bits
-      def pbgid; end
-
-      # Returns a hash representation of the object.
-      #
-      # @return [Hash]
-      def to_h; end
-    end
-  end
-end

data/lib/vault_coh/commands/use_battlegroup_ability_command.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module VaultCoh
-  module Commands
-    # Wrapper for a battlegroup ability usage command.
-    class UseBattlegroupAbilityCommand < Command
-    end
-  end
-end

data/lib/vault_coh/commands.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module VaultCoh
-  # Various classes responsible for handling command data.
-  module Commands
-  end
-end