Opt: add the keywords and categories

.github/FUNDING.yml

@@ -0,0 +1,5 @@
+github: [eigenein]
+custom:
+- 'https://www.paypal.me/eigenein'
+- 'https://bunq.me/eigenein'
+- 'https://money.yandex.ru/to/410011693851843'

.github/workflows/publish.yaml

@@ -42,7 +42,6 @@ jobs:
         with:
           release_name: ${{ github.ref_name }}
           body: ${{ steps.changelog.outputs.changelog }}
-          prerelease: false
 
       - name: Publish the crates
         run: |

Cargo.toml

@@ -7,14 +7,15 @@ authors = ["Pavel Perestoronin <[email protected]>"]
 readme = "README.md"
 repository = "https://github.com/eigenein/wotbreplay-parser"
 license = "MIT"
-keywords = []
-categories = []
+keywords = ["world-of-tanks-blitz", "replay", "parser", "wargaming", "results"]
+categories = ["parsing"]
 
 [features]
 default = []
 
 [dependencies]
 prost = "0.11.3"
+serde = { version = "1.0.148", features = ["derive"] }
 serde_bytes = "0.11.7"
 serde-pickle = "1.1.1"
 thiserror = "1.0.37"

README.md

@@ -8,6 +8,35 @@ World of Tanks Blitz replay parser in Rust.
 ![License: MIT](https://img.shields.io/crates/l/wotbreplay-parser)
 [![docs.rs](https://img.shields.io/docsrs/wotbreplay-parser)](https://docs.rs/wotbreplay-parser)
 
+## Quickstart
+
+```rust
+use std::fs::File;
+
+use anyhow::Result;
+use wotbreplay_parser::Replay;
+use wotbreplay_parser::models::TeamNumber;
+
+fn main() -> Result<()> {
+    let battle_results = Replay::open(File::open("tests/replays/battle_results.wotbreplay")?)?
+        .read_battle_results()?;
+
+    assert_eq!(battle_results.timestamp, 1670018359);
+    assert_eq!(battle_results.players.len(), 14);
+
+    assert_eq!(battle_results.players[0].account_id, 520886428);
+    assert_eq!(battle_results.players[0].info.nickname, "77mmmr");
+    assert_eq!(battle_results.players[0].info.team_number(), TeamNumber::Two);
+    assert_eq!(battle_results.players[0].info.platoon_id, None);
+
+    assert_eq!(battle_results.players[1].info.nickname, "SNAK_THE_RIPPER");
+    assert_eq!(battle_results.players[1].info.team_number(), TeamNumber::One);
+    assert_eq!(battle_results.players[1].info.platoon_id, Some(547466834));
+
+    Ok(())
+}
+```
+
 ## Replay structure
 
 `*.wotbreplay` is a ZIP-archive containing:

src/lib.rs

@@ -1,3 +1,15 @@
+//! World of Tanks Blitz replay parser.
+
+#![warn(
+    clippy::all,
+    clippy::missing_const_for_fn,
+    clippy::trivially_copy_pass_by_ref,
+    clippy::map_unwrap_or,
+    clippy::explicit_into_iter_loop,
+    clippy::unused_self,
+    clippy::needless_pass_by_value
+)]
+
 mod error;
 pub mod models;
 mod replay;
@@ -6,3 +18,15 @@ mod result;
 pub use crate::error::Error;
 pub use crate::replay::Replay;
 pub use crate::result::Result;
+
+#[cfg(doctest)]
+mod test_readme {
+    macro_rules! external_doc_test {
+        ($x:expr) => {
+            #[doc = $x]
+            extern "C" {}
+        };
+    }
+
+    external_doc_test!(include_str!("../README.md"));
+}

src/models.rs

@@ -1,31 +1,5 @@
-use ::prost::Message;
+mod battle_results;
+mod battle_results_dat;
 
-#[derive(Message)]
-pub struct BattleResults {
-    #[prost(int64, tag = "2")]
-    pub timestamp: i64,
-
-    #[prost(message, repeated, tag = "201")]
-    pub players: Vec<Player>,
-}
-
-#[derive(Message)]
-pub struct Player {
-    #[prost(uint32, tag = "1")]
-    pub account_id: u32,
-
-    #[prost(message, required, tag = "2")]
-    pub info: PlayerInfo,
-}
-
-#[derive(Message)]
-pub struct PlayerInfo {
-    #[prost(string, tag = "1")]
-    pub nickname: String,
-
-    #[prost(uint32, optional, tag = "2")]
-    pub platoon_id: Option<u32>,
-
-    #[prost(uint32, tag = "3")]
-    pub team_number: u32,
-}
+pub use self::battle_results::*;
+pub use self::battle_results_dat::*;

src/models/battle_results.rs

@@ -0,0 +1,162 @@
+use prost::bytes::Buf;
+use prost::Message;
+
+use crate::error::Error;
+use crate::result::Result;
+
+impl BattleResults {
+    /// Parse battle results from the buffer.
+    ///
+    /// Note, that this does NOT parse `battle_results.dat` itself, but the un-pickled tuple element.
+    pub fn parse(buffer: impl Buf) -> Result<Self> {
+        Self::decode(buffer).map_err(Error::DecodeFailed)
+    }
+}
+
+/// Parsed battle results.
+#[derive(Message)]
+pub struct BattleResults {
+    /// Battle timestamp.
+    #[prost(int64, tag = "2")]
+    pub timestamp: i64,
+
+    /// Players in the battle.
+    #[prost(message, repeated, tag = "201")]
+    pub players: Vec<Player>,
+
+    /// Player's results.
+    #[prost(message, repeated, tag = "301")]
+    pub player_results: Vec<PlayerResults>,
+}
+
+/// Battle player.
+#[derive(Message)]
+pub struct Player {
+    /// Player's account ID.
+    #[prost(uint32, tag = "1")]
+    pub account_id: u32,
+
+    /// Player's extended information.
+    #[prost(message, required, tag = "2")]
+    pub info: PlayerInfo,
+}
+
+/// Player's extended information.
+#[derive(Message)]
+pub struct PlayerInfo {
+    /// Player's nickname.
+    #[prost(string, tag = "1")]
+    pub nickname: String,
+
+    /// Some sort of platoon ID:
+    /// - contains same ID for a platoon members, or
+    /// - `None` for non-platoon players
+    #[prost(uint32, optional, tag = "2")]
+    pub platoon_id: Option<u32>,
+
+    /// Player's team assignment.
+    #[prost(enumeration = "TeamNumber", tag = "3")]
+    pub team_number: i32,
+
+    #[prost(string, optional, tag = "5")]
+    pub clan_tag: Option<String>,
+}
+
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, prost::Enumeration)]
+#[repr(i32)]
+pub enum TeamNumber {
+    One = 1,
+    Two = 2,
+}
+
+/// Player's battle results.
+#[derive(Message)]
+pub struct PlayerResults {
+    /// Looks like some sort of sequential result ID. They reference each other,
+    /// but I haven't figured this out yet.
+    #[prost(uint32, tag = "1")]
+    pub result_id: u32,
+
+    /// Extended player's results information.
+    #[prost(message, required, tag = "2")]
+    pub info: PlayerResultsInfo,
+}
+
+/// Extended player's results information.
+#[derive(Message)]
+pub struct PlayerResultsInfo {
+    /// Credits earned – without special awards and medals and premium account excluded.
+    #[prost(uint32, tag = "2")]
+    pub credits: u32,
+
+    /// Base XP (the total without multipliers).
+    #[prost(uint32, tag = "3")]
+    pub base_xp: u32,
+
+    #[prost(uint32, tag = "4")]
+    pub n_shots: u32,
+
+    #[prost(uint32, tag = "5")]
+    pub n_hits_dealt: u32,
+
+    #[prost(uint32, tag = "7")]
+    pub n_penetrations_dealt: u32,
+
+    #[prost(uint32, tag = "8")]
+    pub damage_dealt: u32,
+
+    /// TODO: distinguish the kinds of assisted damage.
+    #[prost(uint32, tag = "9")]
+    pub damage_assisted_1: u32,
+
+    /// TODO: distinguish the kinds of assisted damage.
+    #[prost(uint32, tag = "10")]
+    pub damage_assisted_2: u32,
+
+    #[prost(uint32, tag = "12")]
+    pub n_hits_received: u32,
+
+    #[prost(uint32, tag = "13")]
+    pub n_non_penetrating_hits_received: u32,
+
+    #[prost(uint32, tag = "15")]
+    pub n_penetrations_received: u32,
+
+    #[prost(uint32, tag = "17")]
+    pub n_enemies_damaged: u32,
+
+    #[prost(uint32, tag = "18")]
+    pub n_enemies_destroyed: u32,
+
+    #[prost(uint32, tag = "32")]
+    pub victory_points_earned: u32,
+
+    #[prost(uint32, tag = "33")]
+    pub victory_points_seized: u32,
+
+    /// Player's account ID.
+    #[prost(uint32, tag = "101")]
+    pub account_id: u32,
+
+    /// Player's tank ID as per Wargaming.net API.
+    #[prost(uint32, tag = "103")]
+    pub tank_id: u32,
+
+    /// Rating for the Rating Battles.
+    ///
+    /// Note, that this is **not** the game client's displayed rating.
+    /// This field matches the `mm_rating` as returned by the Wargaming.net API.
+    #[prost(float, optional, tag = "107")]
+    pub mm_rating: Option<f32>,
+
+    #[prost(uint32, tag = "117")]
+    pub damage_blocked: u32,
+}
+
+impl PlayerResultsInfo {
+    /// Returns displayed rating as per the game client.
+    pub fn display_rating(&self) -> Option<u32> {
+        self.mm_rating
+            .map(|mm_rating| (mm_rating * 10.0 + 3000.0) as u32)
+    }
+}

src/models/battle_results_dat.rs

@@ -0,0 +1,29 @@
+use std::io::Read;
+
+use prost::Message;
+use serde::Deserialize;
+use serde_bytes::ByteBuf;
+
+use crate::models::BattleResults;
+use crate::{Error, Result};
+
+/// Represents un-pickled `battle_results.dat`.
+#[derive(Debug, Deserialize)]
+pub struct BattleResultsDat(
+    /// No idea what this is.
+    u64,
+    /// Protobuf-serialized battle results.
+    ByteBuf,
+);
+
+impl BattleResultsDat {
+    /// Parses the pickled structure from the reader which contains `battle_results.dat`.
+    pub fn from_reader(reader: impl Read) -> Result<Self> {
+        serde_pickle::from_reader(reader, Default::default()).map_err(Error::UnpickleFailed)
+    }
+
+    /// Decodes the battle results from the internal buffer.
+    pub fn decode_battle_results(&self) -> Result<BattleResults> {
+        BattleResults::decode(self.1.as_ref()).map_err(Error::DecodeFailed)
+    }
+}

src/replay.rs

@@ -1,35 +1,28 @@
 use std::io::{Read, Seek};
 
-use prost::Message;
-use serde_bytes::ByteBuf;
 use zip::ZipArchive;
 
 use crate::error::Error;
-use crate::models::BattleResults;
+use crate::models::{BattleResults, BattleResultsDat};
 use crate::result::Result;
 
+/// Opened (but not yet parsed) replay.
 pub struct Replay<R>(pub(crate) ZipArchive<R>);
 
 impl<R: Read + Seek> Replay<R> {
-    /// Opens a replay from the reader.
+    /// Opens a replay from the reader which contains a `*.wotbreplay`.
     pub fn open(reader: R) -> Result<Self> {
         ZipArchive::new(reader)
             .map_err(Error::OpenArchiveFailed)
             .map(Self)
     }
 
+    /// Reads and parses the battle results from the replay.
     pub fn read_battle_results(&mut self) -> Result<BattleResults> {
-        let mut pickled_battle_results = self
+        let pickled_battle_results = self
             .0
             .by_name("battle_results.dat")
             .map_err(Error::OpenBattleResultsFailed)?;
-        let mut serialized_battle_results = Vec::new();
-        pickled_battle_results
-            .read_to_end(&mut serialized_battle_results)
-            .map_err(Error::ReadEntryFailed)?;
-        let (_, battle_results): (u64, ByteBuf) =
-            serde_pickle::from_slice(&serialized_battle_results, Default::default())
-                .map_err(Error::UnpickleFailed)?;
-        BattleResults::decode(battle_results.as_ref()).map_err(Error::DecodeFailed)
+        BattleResultsDat::from_reader(pickled_battle_results)?.decode_battle_results()
     }
 }

tests/battle_results.rs

@@ -4,23 +4,93 @@ use anyhow::Result;
 use wotbreplay_parser::Replay;
 
 #[test]
-fn battle_results_ok() -> Result<()> {
-    let mut replay = Replay::open(File::open(
-        "tests/replays/20221202_2259__zeekrab_It20_Car_Comb_45t_2308705958773814583.wotbreplay",
-    )?)?;
-    let battle_results = replay.read_battle_results()?;
+fn player_results_ok() -> Result<()> {
+    let battle_results = Replay::open(File::open("tests/replays/player_results.wotbreplay")?)?
+        .read_battle_results()?;
 
-    assert_eq!(battle_results.timestamp, 1670018359);
-    assert_eq!(battle_results.players.len(), 14);
+    let snak_the_ripper_info = &battle_results.player_results[3].info;
+    assert_eq!(snak_the_ripper_info.base_xp, 929);
+    assert_eq!(snak_the_ripper_info.damage_dealt, 2584);
+    assert_eq!(snak_the_ripper_info.damage_assisted_1, 37);
+    assert_eq!(snak_the_ripper_info.account_id, 566225799);
+    assert_eq!(snak_the_ripper_info.display_rating(), Some(4070));
+    assert_eq!(snak_the_ripper_info.n_shots, 6);
+    assert_eq!(snak_the_ripper_info.n_hits_dealt, 5);
+    assert_eq!(snak_the_ripper_info.n_penetrations_dealt, 5);
+    assert_eq!(snak_the_ripper_info.tank_id, 5233);
+    assert_eq!(snak_the_ripper_info.n_enemies_damaged, 3);
+    assert_eq!(snak_the_ripper_info.n_enemies_destroyed, 2);
 
-    assert_eq!(battle_results.players[0].account_id, 520886428);
-    assert_eq!(battle_results.players[0].info.nickname, "77mmmr");
-    assert_eq!(battle_results.players[0].info.team_number, 2);
-    assert_eq!(battle_results.players[0].info.platoon_id, None);
+    let zeekrab_info = &battle_results.player_results[10].info;
+    assert_eq!(zeekrab_info.base_xp, 701);
+    assert_eq!(zeekrab_info.damage_dealt, 1438);
+    assert_eq!(zeekrab_info.damage_assisted_2, 31);
+    assert_eq!(zeekrab_info.damage_blocked, 190);
+    assert_eq!(zeekrab_info.account_id, 594778041);
+    assert_eq!(zeekrab_info.display_rating(), Some(4277));
+    assert_eq!(zeekrab_info.n_shots, 5);
+    assert_eq!(zeekrab_info.n_hits_dealt, 5);
+    assert_eq!(zeekrab_info.n_penetrations_dealt, 5);
+    assert_eq!(zeekrab_info.n_hits_received, 3);
+    assert_eq!(zeekrab_info.n_penetrations_received, 3);
+    assert_eq!(zeekrab_info.n_non_penetrating_hits_received, 0);
+    assert_eq!(zeekrab_info.victory_points_earned, 40);
+    assert_eq!(zeekrab_info.victory_points_seized, 40);
+    assert_eq!(zeekrab_info.tank_id, 26657);
+    assert_eq!(zeekrab_info.credits, 37679);
+    assert_eq!(zeekrab_info.n_enemies_damaged, 2);
+    assert_eq!(zeekrab_info.n_enemies_destroyed, 1);
 
-    assert_eq!(battle_results.players[1].info.nickname, "SNAK_THE_RIPPER");
-    assert_eq!(battle_results.players[1].info.team_number, 1);
-    assert_eq!(battle_results.players[1].info.platoon_id, Some(547466834));
+    let balls_soup_info = &battle_results.player_results[8].info;
+    assert_eq!(balls_soup_info.damage_dealt, 2064);
+    assert_eq!(balls_soup_info.display_rating(), None);
+    assert_eq!(balls_soup_info.n_shots, 9);
+    assert_eq!(balls_soup_info.n_hits_dealt, 8);
+    assert_eq!(balls_soup_info.n_penetrations_dealt, 8);
+    assert_eq!(balls_soup_info.n_hits_received, 6);
+    assert_eq!(balls_soup_info.n_penetrations_received, 4);
+    assert_eq!(balls_soup_info.n_non_penetrating_hits_received, 2);
+    assert_eq!(balls_soup_info.tank_id, 4737);
+    assert_eq!(balls_soup_info.n_enemies_damaged, 4);
+    assert_eq!(balls_soup_info.n_enemies_destroyed, 1);
+
+    let ceaser_info = &battle_results.player_results[0].info;
+    assert_eq!(ceaser_info.damage_dealt, 919);
+    assert_eq!(ceaser_info.display_rating(), Some(4439));
+    assert_eq!(ceaser_info.n_shots, 9);
+    assert_eq!(ceaser_info.n_hits_dealt, 6);
+    assert_eq!(ceaser_info.n_penetrations_dealt, 5);
+    assert_eq!(ceaser_info.n_enemies_damaged, 3);
+    assert_eq!(ceaser_info.n_enemies_destroyed, 0);
+
+    Ok(())
+}
+
+#[test]
+fn clan_tags_ok() -> Result<()> {
+    let battle_results = Replay::open(File::open("tests/replays/player_results.wotbreplay")?)?
+        .read_battle_results()?;
+
+    assert_eq!(battle_results.players[1].info.clan_tag.as_deref(), Some("AN0NY"));
+    assert_eq!(battle_results.players[10].info.clan_tag.as_deref(), Some("BBS"));
+    assert_eq!(battle_results.players[11].info.clan_tag, None);
+
+    Ok(())
+}
+
+#[test]
+fn victory_points_ok() -> Result<()> {
+    let battle_results = Replay::open(File::open("tests/replays/victory_points.wotbreplay")?)?
+        .read_battle_results()?;
+
+    assert_eq!(battle_results.player_results[1].info.victory_points_seized, 40);
+    assert_eq!(battle_results.player_results[1].info.victory_points_earned, 40);
+
+    assert_eq!(battle_results.player_results[3].info.victory_points_seized, 0);
+    assert_eq!(battle_results.player_results[3].info.victory_points_earned, 112);
+
+    assert_eq!(battle_results.player_results[5].info.victory_points_earned, 280);
+    assert_eq!(battle_results.player_results[5].info.victory_points_seized, 0);
 
     Ok(())
 }