refactor: some restructuring

- move structs inside `sr_tools.rs` into individual file
- implement in-game equip handler (relic & lightcone)

common/src/structs/avatar.rs

@@ -0,0 +1,286 @@
+use std::collections::{BTreeMap, HashMap};
+
+use proto::{
+    Avatar, AvatarSkillTree, AvatarType, BattleAvatar, BattleBuff, ExtraLineupType, Gender,
+    LineupAvatar, LineupInfo, MultiPathAvatarType, SpBarInfo,
+};
+use serde::{Deserialize, Serialize};
+
+use crate::sr_tools::FreesrData;
+
+use super::{lightcone::Lightcone, relic::Relic};
+
+#[derive(Serialize, Deserialize, Clone, Debug, Copy, PartialEq, Eq, Default)]
+#[repr(u32)]
+pub enum MultiPathAvatar {
+    MalePyhsical = 8001,
+    FemalePhysical = 8002,
+    MalePreservation = 8003,
+    FemalePreservation = 8004,
+    MaleHarmony = 8005,
+    FemaleHarmony = 8006,
+    MaleRememberance = 8007,
+    FemaleRememberance = 8008,
+    MarchHunt = 1224,
+    MarchPreservation = 1001,
+    #[default]
+    Unk = 0,
+}
+
+impl From<u32> for MultiPathAvatar {
+    fn from(value: u32) -> Self {
+        match value {
+            8001 => Self::MalePyhsical,
+            8002 => Self::FemalePhysical,
+            8003 => Self::MalePreservation,
+            8004 => Self::FemalePreservation,
+            8005 => Self::MaleHarmony,
+            8006 => Self::FemaleHarmony,
+            8007 => Self::MaleRememberance,
+            8008 => Self::FemaleRememberance,
+            1224 => Self::MarchHunt,
+            1001 => Self::MarchPreservation,
+            _ => Self::Unk,
+        }
+    }
+}
+
+impl From<MultiPathAvatar> for u32 {
+    fn from(value: MultiPathAvatar) -> Self {
+        match value {
+            MultiPathAvatar::MalePyhsical => 8001,
+            MultiPathAvatar::FemalePhysical => 8002,
+            MultiPathAvatar::MalePreservation => 8003,
+            MultiPathAvatar::FemalePreservation => 8004,
+            MultiPathAvatar::MaleHarmony => 8005,
+            MultiPathAvatar::FemaleHarmony => 8006,
+            MultiPathAvatar::MaleRememberance => 8007,
+            MultiPathAvatar::FemaleRememberance => 8008,
+            MultiPathAvatar::MarchHunt => 1224,
+            MultiPathAvatar::MarchPreservation => 1001,
+            _ => 8006,
+        }
+    }
+}
+
+impl MultiPathAvatar {
+    #[allow(unused)]
+    pub fn get_gender(&self) -> Gender {
+        if (*self as u32) < 8000 {
+            Gender::None
+        } else if *self as u32 % 2 == 1 {
+            Gender::Man
+        } else {
+            Gender::Woman
+        }
+    }
+
+    pub fn get_type(&self) -> MultiPathAvatarType {
+        match *self {
+            MultiPathAvatar::MalePyhsical => MultiPathAvatarType::BoyWarriorType,
+            MultiPathAvatar::FemalePhysical => MultiPathAvatarType::GirlWarriorType,
+            MultiPathAvatar::MalePreservation => MultiPathAvatarType::BoyKnightType,
+            MultiPathAvatar::FemalePreservation => MultiPathAvatarType::GirlKnightType,
+            MultiPathAvatar::MaleHarmony => MultiPathAvatarType::BoyShamanType,
+            MultiPathAvatar::FemaleHarmony => MultiPathAvatarType::GirlShamanType,
+            MultiPathAvatar::MarchHunt => MultiPathAvatarType::Mar7thRogueType,
+            MultiPathAvatar::MarchPreservation => MultiPathAvatarType::Mar7thKnightType,
+            MultiPathAvatar::Unk => MultiPathAvatarType::None,
+            MultiPathAvatar::MaleRememberance => MultiPathAvatarType::BoyMemoryType,
+            MultiPathAvatar::FemaleRememberance => MultiPathAvatarType::GirlMemoryType,
+        }
+    }
+
+    pub fn is_mc(&self) -> bool {
+        (*self as u32) > 8000
+    }
+
+    pub fn to_vec() -> Vec<MultiPathAvatar> {
+        vec![
+            Self::MalePyhsical,
+            Self::FemalePhysical,
+            Self::MalePreservation,
+            Self::FemalePreservation,
+            Self::MaleHarmony,
+            Self::FemaleHarmony,
+            Self::MaleRememberance,
+            Self::FemaleRememberance,
+            Self::MarchHunt,
+            Self::MarchPreservation,
+        ]
+    }
+}
+
+// AVATAR
+#[derive(Serialize, Deserialize, Debug, Clone)]
+pub struct AvatarJson {
+    // #[serde(alias = "ownerUid")]
+    // pub owner_uid: u32,
+    #[serde(alias = "avatarId")]
+    pub avatar_id: u32,
+    pub data: AvatarData,
+    pub level: u32,
+    pub promotion: u32,
+    #[serde(alias = "use_technique")]
+    #[serde(alias = "useTechnique")]
+    pub techniques: Vec<u32>,
+    #[serde(alias = "spValue")]
+    pub sp_value: Option<u32>,
+    #[serde(alias = "spMax")]
+    pub sp_max: Option<u32>,
+}
+
+#[derive(Serialize, Deserialize, Debug, Clone)]
+pub struct AvatarData {
+    pub rank: u32,
+    pub skills: HashMap<u32, u32>,
+}
+
+impl AvatarJson {
+    pub fn to_avatar_proto(&self, lightcone: Option<&Lightcone>, relics: Vec<&Relic>) -> Avatar {
+        // TODO: HARDCODED
+        let base_avatar_id = if self.avatar_id > 8000 {
+            8001
+        } else if self.avatar_id == 1001 || self.avatar_id == 1224 {
+            1001
+        } else {
+            self.avatar_id
+        };
+
+        Avatar {
+            base_avatar_id,
+            level: self.level,
+            promotion: self.promotion,
+            rank: self.data.rank,
+            skilltree_list: self
+                .data
+                .skills
+                .iter()
+                .map(|v| AvatarSkillTree {
+                    point_id: *v.0,
+                    level: *v.1,
+                })
+                .collect::<Vec<_>>(),
+            equipment_unique_id: lightcone.map(|v| v.get_unique_id()).unwrap_or_default(),
+            first_met_timestamp: 1712924677,
+            equip_relic_list: relics.iter().map(|v| (*v).into()).collect::<Vec<_>>(),
+            ..Default::default()
+        }
+    }
+
+    pub fn to_battle_avatar_proto(
+        &self,
+        index: u32,
+        lightcone: Option<&Lightcone>,
+        relics: Vec<&Relic>,
+    ) -> (BattleAvatar, Vec<BattleBuff>) {
+        let battle_avatar = BattleAvatar {
+            index,
+            avatar_type: AvatarType::AvatarUpgradeAvailableType.into(),
+            id: self.avatar_id,
+            level: self.level,
+            rank: self.data.rank,
+            skilltree_list: self
+                .data
+                .skills
+                .iter()
+                .map(|v| AvatarSkillTree {
+                    point_id: *v.0,
+                    level: *v.1,
+                })
+                .collect::<Vec<_>>(),
+            equipment_list: if let Some(lc) = lightcone {
+                vec![lc.into()]
+            } else {
+                vec![]
+            },
+            hp: 10_000,
+            promotion: self.promotion,
+            relic_list: relics.iter().map(|v| (*v).into()).collect::<Vec<_>>(),
+            world_level: 6,
+            sp_bar: Some(SpBarInfo {
+                cur_sp: self.sp_value.unwrap_or(10_000),
+                max_sp: self.sp_max.unwrap_or(10_000),
+            }),
+            ..Default::default()
+        };
+
+        let mut battle_buff = Vec::<BattleBuff>::new();
+        for buff_id in &self.techniques {
+            battle_buff.push(BattleBuff {
+                wave_flag: 0xffffffff,
+                owner_id: index,
+                level: 1,
+                id: *buff_id,
+                dynamic_values: HashMap::from([(String::from("SkillIndex"), 2.0)]),
+                ..Default::default()
+            });
+        }
+
+        (battle_avatar, battle_buff)
+    }
+
+    pub fn to_lineup_avatar_proto(&self, slot: u32) -> LineupAvatar {
+        LineupAvatar {
+            id: self.avatar_id,
+            hp: 10_000,
+            satiety: 100,
+            avatar_type: AvatarType::AvatarFormalType.into(),
+            sp_bar: Some(SpBarInfo {
+                cur_sp: self.sp_value.unwrap_or(10_000),
+                max_sp: self.sp_max.unwrap_or(10_000),
+            }),
+            slot,
+        }
+    }
+
+    pub fn to_lineup_avatars(player: &FreesrData) -> Vec<LineupAvatar> {
+        let avatar_ids = player
+            .avatars
+            .values()
+            .map(|v| &v.avatar_id)
+            .collect::<Vec<_>>();
+
+        player
+            .lineups
+            .iter()
+            .filter(|(slot, v)| **slot < 4 && v > &&0 && avatar_ids.contains(v))
+            .map(|(slot, avatar_id)| {
+                player
+                    .avatars
+                    .get(avatar_id)
+                    .unwrap()
+                    .to_lineup_avatar_proto(*slot)
+            })
+            .collect::<Vec<LineupAvatar>>()
+    }
+
+    pub fn to_lineup_info(lineups: &BTreeMap<u32, u32>) -> LineupInfo {
+        let mut lineup_info = LineupInfo {
+            extra_lineup_type: ExtraLineupType::LineupNone.into(),
+            name: "Squad 1".to_string(),
+            mp: 5,
+            max_mp: 5,
+            ..Default::default()
+        };
+
+        for id in lineups.values() {
+            if *id == 0 {
+                continue;
+            }
+            lineup_info.avatar_list.push(LineupAvatar {
+                id: *id,
+                hp: 10_000,
+                satiety: 100,
+                avatar_type: AvatarType::AvatarFormalType.into(),
+                sp_bar: Some(SpBarInfo {
+                    cur_sp: 10_000,
+                    max_sp: 10_000,
+                }),
+                slot: lineup_info.avatar_list.len() as u32,
+            });
+        }
+
+        lineup_info
+    }
+}

common/src/structs/battle.rs

@@ -0,0 +1,112 @@
+use std::collections::HashMap;
+
+use serde::{Deserialize, Serialize};
+
+use super::{monster::Monster, relic::SubAffix};
+
+// BATTLE CONFIG
+#[derive(Debug, Serialize, Deserialize, Clone)]
+pub struct BattleConfig {
+    pub battle_type: BattleType,
+    pub monsters: Vec<Vec<Monster>>,
+    pub blessings: Vec<BattleBuffJson>,
+    pub stage_id: u32,
+    pub cycle_count: u32,
+    pub path_resonance_id: u32,
+    pub custom_stats: Vec<SubAffix>,
+    #[serde(default)]
+    pub scepters: Vec<RogueMagicScepter>,
+}
+
+impl Default for BattleConfig {
+    fn default() -> Self {
+        Self {
+            battle_type: Default::default(),
+            monsters: vec![vec![Monster {
+                level: 60,
+                monster_id: 3014022,
+                max_hp: 0,
+            }]],
+            stage_id: 201012311,
+            blessings: Default::default(),
+            cycle_count: Default::default(),
+            path_resonance_id: Default::default(),
+            custom_stats: Default::default(),
+            scepters: Default::default(),
+        }
+    }
+}
+
+#[derive(Debug, Serialize, Deserialize, Clone, PartialEq)]
+pub enum BattleType {
+    #[serde(alias = "DEFAULT")]
+    Default = 0,
+    #[serde(alias = "MOC")]
+    Moc = 1,
+    PF = 2,
+    SU = 3,
+    AS = 4,
+}
+
+impl Default for BattleType {
+    fn default() -> Self {
+        Self::Default
+    }
+}
+
+// BATTLE BUFFS
+#[derive(Debug, Serialize, Deserialize, Clone, Default)]
+pub struct BattleBuffJson {
+    pub level: u32,
+    pub id: u32,
+    pub dynamic_key: Option<DynamicKey>,
+    #[serde(default)]
+    pub dynamic_values: Vec<DynamicKey>,
+}
+
+#[derive(Debug, Serialize, Deserialize, Clone, Default)]
+pub struct DynamicKey {
+    pub key: String,
+    pub value: u32,
+}
+
+#[allow(dead_code)]
+impl BattleBuffJson {
+    pub fn to_battle_buff_proto(&self) -> proto::BattleBuff {
+        proto::BattleBuff {
+            id: self.id,
+            level: self.level,
+            wave_flag: 0xffffffff,
+            owner_id: 0xffffffff,
+            dynamic_values: if let Some(dyn_key) = &self.dynamic_key {
+                HashMap::from([(dyn_key.key.clone(), dyn_key.value as f32)])
+            } else {
+                Default::default()
+            },
+            ..Default::default()
+        }
+    }
+}
+
+#[derive(Debug, Serialize, Deserialize, Clone, Eq, PartialEq, Default)]
+#[repr(u32)]
+pub enum RogueMagicComponentType {
+    Passive = 3,
+    #[default]
+    Active = 4,
+    Attach = 5,
+}
+
+#[derive(Debug, Serialize, Deserialize, Clone, Default)]
+pub struct RogueMagicScepter {
+    pub level: u32,
+    pub id: u32,
+    pub components: Vec<RogueMagicComponent>,
+}
+
+#[derive(Debug, Serialize, Deserialize, Clone, Default)]
+pub struct RogueMagicComponent {
+    pub id: u32,
+    pub level: u32,
+    pub component_type: RogueMagicComponentType,
+}

common/src/structs/lightcone.rs

@@ -0,0 +1,45 @@
+use proto::{BattleEquipment, Equipment, ItemType};
+use serde::{Deserialize, Serialize};
+
+use crate::impl_from;
+
+#[derive(Serialize, Deserialize, Debug, Clone)]
+pub struct Lightcone {
+    pub level: u32,
+    #[serde(alias = "itemId")]
+    pub item_id: u32,
+    #[serde(alias = "equipAvatar")]
+    pub equip_avatar: u32,
+    pub rank: u32,
+    pub promotion: u32,
+    #[serde(alias = "internalUid")]
+    pub internal_uid: u32,
+}
+
+impl_from!(Lightcone, Equipment, |value| {
+    Equipment {
+        equip_avatar_id: value.equip_avatar,
+        exp: 0,
+        is_protected: false,
+        level: value.level,
+        promotion: value.promotion,
+        rank: value.rank,
+        tid: value.item_id,
+        unique_id: value.get_unique_id(),
+    }
+});
+
+impl_from!(Lightcone, BattleEquipment, |value| {
+    BattleEquipment {
+        id: value.item_id,
+        level: value.level,
+        promotion: value.promotion,
+        rank: value.rank,
+    }
+});
+
+impl Lightcone {
+    pub fn get_unique_id(&self) -> u32 {
+        super::get_item_unique_id(self.internal_uid, ItemType::ItemEquipment)
+    }
+}

common/src/structs/mod.rs

@@ -0,0 +1,47 @@
+use proto::ItemType;
+
+pub mod avatar;
+pub mod battle;
+pub mod lightcone;
+pub mod monster;
+pub mod persistent;
+pub mod relic;
+pub mod scene;
+
+pub use avatar::*;
+pub use battle::*;
+pub use lightcone::*;
+pub use monster::*;
+pub use persistent::*;
+pub use scene::*;
+
+pub fn get_item_unique_id(internal_uid: u32, item_type: ItemType) -> u32 {
+    if item_type == ItemType::ItemEquipment {
+        2000 + internal_uid // 2000.3500
+    } else {
+        1 + internal_uid // 1..2000
+    }
+}
+
+#[macro_export]
+macro_rules! impl_from {
+    ($from:ty, $to:ty, |$param:ident| $body:block) => {
+        impl From<$from> for $to {
+            fn from($param: $from) -> Self {
+                $body
+            }
+        }
+
+        impl From<&$from> for $to {
+            fn from($param: &$from) -> Self {
+                $body
+            }
+        }
+
+        impl From<&mut $from> for $to {
+            fn from($param: &mut $from) -> Self {
+                $body
+            }
+        }
+    };
+}

common/src/structs/monster.rs

@@ -0,0 +1,48 @@
+use proto::{SceneMonster, SceneMonsterWave, SceneMonsterWaveParam};
+use serde::{Deserialize, Serialize};
+
+use crate::impl_from;
+
+#[derive(Debug, Serialize, Deserialize, Clone, Default)]
+pub struct Monster {
+    pub level: u32,
+    #[serde(alias = "monsterId")]
+    pub monster_id: u32,
+    #[serde(default)]
+    pub max_hp: u32,
+}
+
+impl_from!(Monster, SceneMonster, |value| {
+    SceneMonster {
+        monster_id: value.monster_id,
+        max_hp: value.max_hp,
+        cur_hp: value.max_hp,
+    }
+});
+
+impl Monster {
+    pub fn to_scene_monster_wave(mut wave_id: u32, monsters: &[Self]) -> SceneMonsterWave {
+        if wave_id < 1 {
+            wave_id += 1;
+        }
+
+        SceneMonsterWave {
+            wave_id,
+            wave_param: Some(SceneMonsterWaveParam {
+                level: monsters.iter().map(|v| v.level).max().unwrap_or(95),
+                ..Default::default()
+            }),
+
+            monster_list: monsters.iter().map(|v| v.into()).collect(),
+            ..Default::default()
+        }
+    }
+
+    pub fn to_scene_monster_waves(monsters: &[Vec<Self>]) -> Vec<SceneMonsterWave> {
+        monsters
+            .iter()
+            .enumerate()
+            .map(|(i, v)| Self::to_scene_monster_wave(i as u32, v))
+            .collect::<_>()
+    }
+}

common/src/structs/persistent.rs

@@ -0,0 +1,60 @@
+use std::collections::BTreeMap;
+
+use serde::{Deserialize, Serialize};
+
+use super::{
+    avatar::MultiPathAvatar,
+    scene::{Position, Scene},
+};
+
+// #[derive(Serialize, Deserialize, Clone, Debug, Copy, PartialEq, Eq, Default)]
+// #[repr(u32)]
+// pub enum AllowedLanguages {
+//     #[default]
+//     En,
+//     Jp,
+//     Kr,
+//     Cn,
+// }
+
+// impl FromStr for AllowedLanguages {
+//     type Err = ();
+
+//     fn from_str(input: &str) -> Result<AllowedLanguages, Self::Err> {
+//         match input {
+//             "en" => Ok(AllowedLanguages::En),
+//             "kr" => Ok(AllowedLanguages::Kr),
+//             "jp" => Ok(AllowedLanguages::Jp),
+//             "cn" => Ok(AllowedLanguages::Cn),
+//             _ => Ok(AllowedLanguages::En),
+//         }
+//     }
+// }
+
+#[derive(Debug, Serialize, Deserialize)]
+pub struct Persistent {
+    #[serde(default)]
+    pub lineups: BTreeMap<u32, u32>,
+    #[serde(default)]
+    pub position: Position,
+    #[serde(default)]
+    pub scene: Scene,
+    pub main_character: MultiPathAvatar,
+    pub march_type: MultiPathAvatar,
+    // pub game_language: AllowedLanguages,
+    // pub voice_language: AllowedLanguages,
+}
+
+impl Default for Persistent {
+    fn default() -> Self {
+        Self {
+            lineups: BTreeMap::from([(0, 1313), (1, 1006), (2, 8001), (3, 1405)]),
+            position: Default::default(),
+            main_character: MultiPathAvatar::FemaleRememberance,
+            scene: Default::default(),
+            march_type: MultiPathAvatar::MarchHunt,
+            // game_language: AllowedLanguages::En,
+            // voice_language: AllowedLanguages::Jp,
+        }
+    }
+}

common/src/structs/relic.rs

@@ -0,0 +1,95 @@
+use proto::{BattleRelic, EquipRelic, ItemType, RelicAffix};
+use serde::{Deserialize, Serialize};
+
+use crate::impl_from;
+
+#[derive(Debug, Serialize, Deserialize, Clone)]
+pub struct Relic {
+    pub level: u32,
+    #[serde(alias = "relicId")]
+    pub relic_id: u32,
+    // #[serde(alias = "relicSetId")]
+    // pub relic_set_id: u32,
+    #[serde(alias = "mainAffixId")]
+    pub main_affix_id: u32,
+    #[serde(alias = "subAffixes")]
+    pub sub_affixes: Vec<SubAffix>,
+    #[serde(alias = "internalUid")]
+    pub internal_uid: u32,
+    #[serde(alias = "equipAvatar")]
+    pub equip_avatar: u32,
+}
+
+#[derive(Debug, Serialize, Deserialize, Default, Clone)]
+pub struct SubAffix {
+    #[serde(alias = "subAffixId")]
+    pub sub_affix_id: u32,
+    pub count: u32,
+    pub step: u32,
+}
+
+impl Relic {
+    pub fn is_matching_slot(&self, slot: u32) -> bool {
+        self.get_slot() == slot
+    }
+
+    pub fn get_slot(&self) -> u32 {
+        self.relic_id % 10
+    }
+
+    pub fn get_unique_id(&self) -> u32 {
+        super::get_item_unique_id(self.internal_uid, ItemType::ItemRelic)
+    }
+}
+
+impl_from!(SubAffix, RelicAffix, |v| {
+    RelicAffix {
+        affix_id: v.sub_affix_id,
+        cnt: v.count,
+        step: v.step,
+    }
+});
+
+impl_from!(Relic, BattleRelic, |value| {
+    BattleRelic {
+        id: value.relic_id,
+        level: value.level,
+        main_affix_id: value.main_affix_id,
+        unique_id: value.get_unique_id(),
+        sub_affix_list: value
+            .sub_affixes
+            .iter()
+            .map(|v| v.into())
+            .collect::<Vec<_>>(),
+        ..Default::default()
+    }
+});
+
+impl_from!(Relic, EquipRelic, |value| {
+    EquipRelic {
+        slot: value.get_slot(),
+        relic_unique_id: value.get_unique_id(),
+    }
+});
+
+impl_from!(Relic, proto::Relic, |value| {
+    proto::Relic {
+        equip_avatar_id: value.equip_avatar,
+        exp: 0,
+        is_protected: false,
+        level: value.level,
+        main_affix_id: value.main_affix_id,
+        tid: value.relic_id,
+        unique_id: value.get_unique_id(),
+        sub_affix_list: value
+            .sub_affixes
+            .iter()
+            .map(|v| RelicAffix {
+                affix_id: v.sub_affix_id,
+                cnt: v.count,
+                step: v.step,
+            })
+            .collect::<Vec<_>>(),
+        ..Default::default()
+    }
+});

common/src/structs/scene.rs

@@ -0,0 +1,56 @@
+use proto::{MotionInfo, Vector};
+use serde::{Deserialize, Serialize};
+
+use crate::impl_from;
+
+// SCENE
+#[derive(Serialize, Deserialize, Debug, Clone)]
+pub struct Scene {
+    pub plane_id: u32,
+    pub floor_id: u32,
+    pub entry_id: u32,
+}
+
+impl Default for Scene {
+    fn default() -> Self {
+        Self {
+            plane_id: 20411,
+            floor_id: 20411001,
+            entry_id: 2041101,
+        }
+    }
+}
+
+#[derive(Debug, Serialize, Deserialize, Clone)]
+pub struct Position {
+    pub x: i32,
+    pub y: i32,
+    pub z: i32,
+    pub rot_y: i32,
+}
+
+impl Default for Position {
+    fn default() -> Self {
+        Position {
+            x: -26968,
+            y: 78953,
+            z: 14457,
+            rot_y: 11858,
+        }
+    }
+}
+
+impl_from!(Position, MotionInfo, |value| {
+    MotionInfo {
+        rot: Some(Vector {
+            x: 0,
+            y: value.rot_y,
+            z: 0,
+        }),
+        pos: Some(Vector {
+            x: value.x,
+            y: value.y,
+            z: value.z,
+        }),
+    }
+});