tiger-pkg 0.20.1

Tiger engine package reading library for Destiny 1/2 and Marathon
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

use std::{fs::File, io::Write, path::PathBuf};

use clap::Parser;
use clap_num::maybe_hex;
use tiger_pkg::{package::classify_file_prebl, DestinyVersion, GameVersion, TagHash, Version};

#[derive(Parser, Debug)]
#[command(author, version, about, long_about = None, disable_version_flag(true))]
struct Args {
    /// Package to extract
    package: String,

    /// Don't extract any files, just print them
    #[arg(short, long, default_value = "false")]
    dry_run: bool,

    /// Directory to extract to (default: ./out/pkg_name)
    #[arg(short)]
    output_dir: Option<String>,

    /// Version of the package to extract
    #[arg(short, value_enum)]
    version: GameVersion,

    /// Only extract 8080 files
    #[arg(long)]
    only_8080: bool,

    #[arg(long, value_parser = maybe_hex::<u32>)]
    reference: Option<u32>,

    #[arg(long = "type")]
    entry_type: Option<u8>,
    #[arg(long = "subtype")]
    entry_subtype: Option<u8>,

    /// Don't print files
    #[arg(short, long)]
    silent: bool,
}

fn main() -> anyhow::Result<()> {
    env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("info")).init();
    let args = Args::parse();
    if args.silent && args.dry_run {
        eprintln!("Warning: silent and dry_run are both enabled, nothing will be printed");
    }

    let pkg_name = PathBuf::from(args.package.clone())
        .file_stem()
        .unwrap()
        .to_string_lossy()
        .to_string();

    let filter = EntryFilter {
        entry_type: args.entry_type,
        entry_subtype: args.entry_subtype,
        reference: args.reference,
    };

    let package = args.version.open(&args.package)?;

    let out_dir = args
        .output_dir
        .unwrap_or_else(|| format!("./out/{pkg_name}"));

    std::fs::create_dir_all(&out_dir).ok();

    println!("PKG {:04x}_{}", package.pkg_id(), package.patch_id());
    for (i, e) in package
        .entries()
        .iter()
        .enumerate()
        .filter(|(_, e)| filter.matches(e))
    {
        if (e.file_type != 8 && e.file_type != 16) && args.only_8080 {
            continue;
        }

        if !args.silent {
            print!("{}/{} - ", e.file_type, e.file_subtype);
        }
        let ref_hash = TagHash(e.reference);

        let ext = if args.version == GameVersion::Destiny(DestinyVersion::Destiny2Shadowkeep) {
            classify_file_prebl(e.file_type, e.file_subtype)
        } else {
            "bin".to_string()
        };

        if !args.silent {
            if ref_hash.is_pkg_file() {
                println!(
                "{i} 0x{:04x} - Reference {ref_hash:?} / r=0x{:x} (type={}, subtype={}, ext={ext})",
                e.file_size, ref_hash.0, e.file_type, e.file_subtype
            );
            } else {
                println!(
                    "{i} 0x{:04x} - r=0x{:x} (type={}, subtype={}, ext={ext})",
                    e.file_size, ref_hash.0, e.file_type, e.file_subtype
                );
            }
        }

        if !args.dry_run {
            let data: Vec<u8> = match package.read_entry(i) {
                Ok(data) => data,
                Err(e) => {
                    eprintln!(
                        "Failed to extract entry {}/{}: {e}",
                        i,
                        package.entries().len() - 1
                    );
                    continue;
                }
            };

            let mut o = File::create(format!(
                "{out_dir}/{i}_{:08x}_t{}_s{}.{ext}",
                e.reference, e.file_type, e.file_subtype
            ))?;
            o.write_all(&data)?;
        }
    }

    Ok(())
}

pub struct EntryFilter {
    pub entry_type: Option<u8>,
    pub entry_subtype: Option<u8>,
    pub reference: Option<u32>,
}

impl EntryFilter {
    pub fn matches(&self, entry: &tiger_pkg::package::UEntryHeader) -> bool {
        if let Some(entry_type) = self.entry_type {
            if entry.file_type != entry_type {
                return false;
            }
        }

        if let Some(entry_subtype) = self.entry_subtype {
            if entry.file_subtype != entry_subtype {
                return false;
            }
        }

        if let Some(reference) = self.reference {
            if entry.reference != reference {
                return false;
            }
        }

        true
    }
}