tiger_pkg/
version.rs

1use std::sync::Arc;
2
3use binrw::Endian;
4
5use crate::{
6    d1_internal_alpha::PackageD1InternalAlpha, d1_legacy::PackageD1Legacy,
7    d1_roi::PackageD1RiseOfIron, d2_beta::PackageD2Beta, d2_beyondlight::PackageD2BeyondLight,
8    Package, PackageD2PreBL,
9};
10
11pub trait Version: clap::ValueEnum {
12    fn open(&self, path: &str) -> anyhow::Result<Arc<dyn Package>>;
13    fn endian(&self) -> Endian;
14    fn name(&self) -> &'static str;
15    fn id(&self) -> String {
16        self.to_possible_value()
17            .expect("Package version is missing an id/commandline value")
18            .get_name()
19            .to_string()
20    }
21
22    fn aes_key_0(&self) -> [u8; 16] {
23        [
24            0xD6, 0x2A, 0xB2, 0xC1, 0x0C, 0xC0, 0x1B, 0xC5, 0x35, 0xDB, 0x7B, 0x86, 0x55, 0xC7,
25            0xDC, 0x3B,
26        ]
27    }
28
29    fn aes_key_1(&self) -> [u8; 16] {
30        [
31            0x3A, 0x4A, 0x5D, 0x36, 0x73, 0xA6, 0x60, 0x58, 0x7E, 0x63, 0xE6, 0x76, 0xE4, 0x08,
32            0x92, 0xB5,
33        ]
34    }
35
36    fn aes_nonce_base(&self) -> [u8; 12] {
37        [
38            0x84, 0xDF, 0x11, 0xC0, 0xAC, 0xAB, 0xFA, 0x20, 0x33, 0x11, 0x26, 0x99,
39        ]
40    }
41}
42
43#[derive(serde::Serialize, serde::Deserialize, PartialEq, PartialOrd, Debug, Clone, Copy)]
44pub enum GameVersion {
45    Destiny(DestinyVersion),
46    Marathon(MarathonVersion),
47}
48
49impl Version for GameVersion {
50    fn open(&self, path: &str) -> anyhow::Result<Arc<dyn Package>> {
51        match self {
52            Self::Destiny(v) => v.open(path),
53            Self::Marathon(v) => v.open(path),
54        }
55    }
56
57    fn endian(&self) -> Endian {
58        match self {
59            Self::Destiny(v) => v.endian(),
60            Self::Marathon(v) => v.endian(),
61        }
62    }
63
64    fn name(&self) -> &'static str {
65        match self {
66            Self::Destiny(v) => v.name(),
67            Self::Marathon(v) => v.name(),
68        }
69    }
70
71    fn aes_key_0(&self) -> [u8; 16] {
72        match self {
73            Self::Destiny(v) => v.aes_key_0(),
74            Self::Marathon(v) => v.aes_key_0(),
75        }
76    }
77
78    fn aes_key_1(&self) -> [u8; 16] {
79        match self {
80            Self::Destiny(v) => v.aes_key_1(),
81            Self::Marathon(v) => v.aes_key_1(),
82        }
83    }
84
85    fn aes_nonce_base(&self) -> [u8; 12] {
86        match self {
87            Self::Destiny(v) => v.aes_nonce_base(),
88            Self::Marathon(v) => v.aes_nonce_base(),
89        }
90    }
91}
92
93impl clap::ValueEnum for GameVersion {
94    fn value_variants<'a>() -> &'a [Self] {
95        &[
96            Self::Destiny(DestinyVersion::DestinyInternalAlpha),
97            Self::Destiny(DestinyVersion::DestinyFirstLookAlpha),
98            Self::Destiny(DestinyVersion::DestinyTheTakenKing),
99            Self::Destiny(DestinyVersion::DestinyRiseOfIron),
100            Self::Destiny(DestinyVersion::Destiny2Beta),
101            Self::Destiny(DestinyVersion::Destiny2Forsaken),
102            Self::Destiny(DestinyVersion::Destiny2Shadowkeep),
103            Self::Destiny(DestinyVersion::Destiny2BeyondLight),
104            Self::Destiny(DestinyVersion::Destiny2WitchQueen),
105            Self::Destiny(DestinyVersion::Destiny2Lightfall),
106            Self::Destiny(DestinyVersion::Destiny2TheFinalShape),
107            Self::Marathon(MarathonVersion::MarathonAlpha),
108        ]
109    }
110
111    fn to_possible_value(&self) -> Option<clap::builder::PossibleValue> {
112        match self {
113            Self::Destiny(v) => v.to_possible_value(),
114            Self::Marathon(v) => v.to_possible_value(),
115        }
116    }
117}
118
119#[derive(
120    serde::Serialize, serde::Deserialize, clap::ValueEnum, PartialEq, PartialOrd, Debug, Clone, Copy,
121)]
122pub enum MarathonVersion {
123    /// Closed alpha from April 2025
124    #[value(name = "ma_alpha")]
125    MarathonAlpha = 500,
126}
127
128impl Version for MarathonVersion {
129    fn open(&self, path: &str) -> anyhow::Result<Arc<dyn Package>> {
130        // nblock: Version (53) is the same as D2BeyondLight. Using Final Shape version for now.
131        Ok(Arc::new(PackageD2BeyondLight::open(
132            path,
133            DestinyVersion::Destiny2TheFinalShape,
134        )?))
135    }
136
137    fn endian(&self) -> Endian {
138        Endian::Little
139    }
140
141    fn name(&self) -> &'static str {
142        match self {
143            MarathonVersion::MarathonAlpha => "Marathon Closed Alpha",
144        }
145    }
146}
147
148#[derive(
149    serde::Serialize, serde::Deserialize, clap::ValueEnum, PartialEq, PartialOrd, Debug, Clone, Copy,
150)]
151pub enum DestinyVersion {
152    /// X360 december 2013 internal alpha version of Destiny
153    #[value(name = "d1_devalpha")]
154    DestinyInternalAlpha = 1_0500,
155
156    /// PS4 First Look Alpha
157    #[value(name = "d1_fla")]
158    DestinyFirstLookAlpha = 1_0800,
159
160    /// PS3/X360 version of Destiny (The Taken King)
161    #[value(name = "d1_ttk")]
162    DestinyTheTakenKing = 1_2000,
163
164    /// The latest version of Destiny (Rise of Iron)
165    #[value(name = "d1_roi")]
166    DestinyRiseOfIron = 1_2400,
167
168    /// Destiny 2 (Beta)
169    #[value(name = "d2_beta")]
170    Destiny2Beta = 2_1000,
171
172    /// Destiny 2 (Forsaken)
173    #[value(name = "d2_fs")]
174    Destiny2Forsaken = 2_2000,
175
176    /// The last version of Destiny 2 before Beyond Light (Shadowkeep/Season of Arrivals)
177    #[value(name = "d2_sk")]
178    Destiny2Shadowkeep = 2_2600,
179
180    /// Destiny 2 (Beyond Light/Season of the Lost)
181    #[value(name = "d2_bl")]
182    Destiny2BeyondLight = 2_3000,
183
184    /// Destiny 2 (Witch Queen/Season of the Seraph)
185    #[value(name = "d2_wq")]
186    Destiny2WitchQueen = 2_4000,
187
188    /// Destiny 2 (Lightfall)
189    #[value(name = "d2_lf")]
190    Destiny2Lightfall = 2_7000,
191
192    /// Destiny 2 (The Final Shape)
193    #[value(name = "d2_tfs")]
194    Destiny2TheFinalShape = 2_8000,
195}
196
197impl DestinyVersion {
198    pub fn is_d1(&self) -> bool {
199        *self <= DestinyVersion::DestinyRiseOfIron
200    }
201
202    pub fn is_d2(&self) -> bool {
203        *self >= DestinyVersion::Destiny2Beta
204    }
205
206    pub fn is_prebl(&self) -> bool {
207        DestinyVersion::Destiny2Beta <= *self && *self <= DestinyVersion::Destiny2Shadowkeep
208    }
209}
210
211impl Version for DestinyVersion {
212    fn open(&self, path: &str) -> anyhow::Result<Arc<dyn Package>> {
213        Ok(match self {
214            DestinyVersion::DestinyInternalAlpha => Arc::new(PackageD1InternalAlpha::open(path)?),
215            DestinyVersion::DestinyFirstLookAlpha => Arc::new(PackageD1RiseOfIron::open(path)?),
216            DestinyVersion::DestinyTheTakenKing => Arc::new(PackageD1Legacy::open(path)?),
217            DestinyVersion::DestinyRiseOfIron => Arc::new(PackageD1RiseOfIron::open(path)?),
218            DestinyVersion::Destiny2Beta => Arc::new(PackageD2Beta::open(path)?),
219
220            DestinyVersion::Destiny2Forsaken | DestinyVersion::Destiny2Shadowkeep => {
221                Arc::new(PackageD2PreBL::open(path)?)
222            }
223
224            DestinyVersion::Destiny2BeyondLight
225            | DestinyVersion::Destiny2WitchQueen
226            | DestinyVersion::Destiny2Lightfall
227            | DestinyVersion::Destiny2TheFinalShape => {
228                Arc::new(PackageD2BeyondLight::open(path, *self)?)
229            }
230        })
231    }
232
233    fn endian(&self) -> Endian {
234        match self {
235            DestinyVersion::DestinyInternalAlpha | DestinyVersion::DestinyTheTakenKing => {
236                Endian::Big
237            }
238            _ => Endian::Little,
239        }
240    }
241
242    fn name(&self) -> &'static str {
243        match self {
244            DestinyVersion::DestinyInternalAlpha => "Destiny X360 Internal Alpha",
245            DestinyVersion::DestinyFirstLookAlpha => "Destiny First Look Alpha",
246            DestinyVersion::DestinyTheTakenKing => "Destiny: The Taken King",
247            DestinyVersion::DestinyRiseOfIron => "Destiny: Rise of Iron",
248            DestinyVersion::Destiny2Beta => "Destiny 2: Beta",
249            DestinyVersion::Destiny2Forsaken => "Destiny 2: Forsaken",
250            DestinyVersion::Destiny2Shadowkeep => "Destiny 2: Shadowkeep",
251            DestinyVersion::Destiny2BeyondLight => "Destiny 2: Beyond Light",
252            DestinyVersion::Destiny2WitchQueen => "Destiny 2: Witch Queen",
253            DestinyVersion::Destiny2Lightfall => "Destiny 2: Lightfall",
254            DestinyVersion::Destiny2TheFinalShape => "Destiny 2: The Final Shape",
255        }
256    }
257}
tiger_pkg/version.rs

tiger_pkg/
version.rs
