bl4-cli 0.5.20

Command-line tool for Borderlands 4 save editing
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215

//! Manifest orchestration command handler
//!
//! Orchestrates full manifest generation from memory dump and pak files.

use crate::manifest;
use anyhow::{bail, Context, Result};
use std::fs;
use std::path::{Path, PathBuf};
use std::process::Command as ProcessCommand;

/// Handle the Commands::Manifest command
///
/// Orchestrates full manifest generation from memory dump and pak files.
#[allow(clippy::too_many_arguments)]
pub fn handle_manifest(
    dump: Option<&Path>,
    paks: &Path,
    usmap: Option<PathBuf>,
    output: &Path,
    aes_key: Option<&str>,
    skip_extract: bool,
    extracted: PathBuf,
    skip_memory: bool,
) -> Result<()> {
    // Ensure output directory exists
    fs::create_dir_all(output).context("Failed to create output directory")?;

    // Determine usmap path - either provided or generated from dump
    let usmap_provided = usmap.is_some();
    let usmap_path = if let Some(usmap) = usmap {
        usmap
    } else if dump.is_some() {
        output.join("BL4.usmap")
    } else {
        bail!("Either --usmap or --dump must be provided");
    };

    // Memory dump extraction (usmap, parts)
    if !skip_memory {
        if let Some(dump_path) = dump {
            println!("=== Memory Dump Extraction ===\n");

            // Find bl4 binary - use current exe
            let bl4_exe =
                std::env::current_exe().context("Failed to get current executable path")?;

            // Step 1: Generate usmap from dump
            if !usmap_provided {
                println!("Step 1: Generating usmap from memory dump...");
                let status = ProcessCommand::new(&bl4_exe)
                    .args(["memory", "-d"])
                    .arg(dump_path)
                    .args(["dump-usmap", "-o"])
                    .arg(&usmap_path)
                    .status()
                    .context("Failed to run bl4 memory dump-usmap")?;
                if !status.success() {
                    bail!("dump-usmap failed with status: {}", status);
                }
                println!("  Wrote usmap to: {}", usmap_path.display());
            } else {
                println!("Step 1: Using provided usmap: {}", usmap_path.display());
            }

            // Step 2: Extract parts with categories
            println!("\nStep 2: Extracting parts with categories...");
            let parts_with_cats_path = output.join("parts_with_categories.json");
            let status = ProcessCommand::new(&bl4_exe)
                .args(["memory", "-d"])
                .arg(dump_path)
                .args(["extract-parts", "-o"])
                .arg(&parts_with_cats_path)
                .status()
                .context("Failed to run bl4 memory extract-parts")?;
            if !status.success() {
                bail!("extract-parts failed with status: {}", status);
            }

            // Step 3: Dump raw parts
            println!("\nStep 3: Dumping raw parts...");
            let parts_dump_path = output.join("parts_dump.json");
            let status = ProcessCommand::new(&bl4_exe)
                .args(["memory", "-d"])
                .arg(dump_path)
                .args(["dump-parts", "-o"])
                .arg(&parts_dump_path)
                .status()
                .context("Failed to run bl4 memory dump-parts")?;
            if !status.success() {
                bail!("dump-parts failed with status: {}", status);
            }

            // Step 4: Generate part_categories.json from parts_with_categories.json
            println!("\nStep 4: Generating part categories mapping...");
            let categories_path = output.join("part_categories.json");

            // Read parts_with_categories.json and extract unique prefix -> category mappings
            let parts_json = fs::read_to_string(&parts_with_cats_path)
                .context("Failed to read parts_with_categories.json")?;
            let parts_data: serde_json::Value = serde_json::from_str(&parts_json)
                .context("Failed to parse parts_with_categories.json")?;

            let mut prefix_categories: std::collections::BTreeMap<String, i64> =
                std::collections::BTreeMap::new();

            if let Some(parts) = parts_data.get("parts").and_then(|p| p.as_array()) {
                for part in parts {
                    if let (Some(name), Some(category)) = (
                        part.get("name").and_then(|n| n.as_str()),
                        part.get("category").and_then(|c| c.as_i64()),
                    ) {
                        // Extract prefix (everything before the first dot)
                        if let Some(prefix) = name.split('.').next() {
                            prefix_categories
                                .entry(prefix.to_string())
                                .or_insert(category);
                        }
                    }
                }
            }

            // Write part_categories.json
            let categories: Vec<serde_json::Value> = prefix_categories
                .into_iter()
                .map(|(prefix, category)| {
                    serde_json::json!({
                        "prefix": prefix,
                        "category": category
                    })
                })
                .collect();

            let categories_json = serde_json::json!({ "categories": categories });
            fs::write(
                &categories_path,
                serde_json::to_string_pretty(&categories_json)?,
            )?;
            println!(
                "  Wrote {} category mappings to: {}",
                categories.len(),
                categories_path.display()
            );

            // Step 5: Build parts database
            println!("\nStep 5: Building parts database...");
            let parts_db_path = output.join("parts_database.json");
            let status = ProcessCommand::new(&bl4_exe)
                .args(["memory", "build-parts-db"])
                .args(["-i"])
                .arg(&parts_dump_path)
                .args(["-o"])
                .arg(&parts_db_path)
                .args(["-c"])
                .arg(&categories_path)
                .status()
                .context("Failed to run bl4 memory build-parts-db")?;
            if !status.success() {
                bail!("build-parts-db failed with status: {}", status);
            }

            // Step 6: Extract part pools from parts database
            println!("\nStep 6: Extracting part pools...");
            let part_pools_path = output.join("part_pools.json");
            let status = ProcessCommand::new(&bl4_exe)
                .args(["extract", "part-pools"])
                .args(["-i"])
                .arg(&parts_db_path)
                .args(["-o"])
                .arg(&part_pools_path)
                .status()
                .context("Failed to run bl4 extract part-pools")?;
            if !status.success() {
                bail!("extract part-pools failed with status: {}", status);
            }

            println!("\n=== Memory extraction complete ===\n");
        }
    }

    // Pak extraction
    let extract_dir = if skip_extract {
        extracted
    } else {
        // Run uextract to extract pak files
        println!("=== Pak Extraction ===\n");
        println!("Extracting pak files with uextract...");
        let mut cmd = ProcessCommand::new("uextract");
        cmd.arg(paks)
            .arg("-o")
            .arg(&extracted)
            .arg("--usmap")
            .arg(&usmap_path)
            .arg("--format")
            .arg("json");

        if let Some(key) = aes_key {
            cmd.arg("--aes-key").arg(key);
        }

        let status = cmd.status().context("Failed to run uextract")?;
        if !status.success() {
            bail!("uextract failed with status: {}", status);
        }
        println!();
        extracted
    };

    // Generate manifest from extracted files
    println!("=== Manifest Generation ===\n");
    println!("Generating manifest files...");
    manifest::extract_manifest(&extract_dir, output)?;
    println!("\nManifest files written to {}", output.display());

    Ok(())
}