hypercutter 0.3.0

Extract data from GBA Pokemon ROMs.
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
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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
//! Output writers: PNG tilesets and sprite PNGs.

use std::path::Path;

use anyhow::{Context, Result};
use console::style;
use indicatif::{ProgressBar, ProgressStyle};
use rayon::prelude::*;

use crate::{Extractor, SpriteRenderer, TilesetRenderer};

use super::{Cli, Summary};

/// Run the full output pipeline.
pub(crate) fn run(
    cli: &Cli,
    extractor: &Extractor<'_>,
    dump_sprites: bool,
    dump_tilesets: bool,
) -> Result<Summary> {
    let q = cli.quiet;
    let mut summary = Summary {
        tilesets: 0,
        sprites: 0,
        forms: 0,
    };

    if dump_tilesets {
        let metatiles = extractor
            .metatiles()
            .with_context(|| "extracting metatiles")?;
        let tilesets_dir = cli.export.join("tilesets");
        if !q {
            println!(
                "  {} Extracting tilesets...",
                style("\u{2192}").cyan().bold(),
            );
        }
        let count =
            output::write_tileset_pngs(&metatiles, &tilesets_dir, extractor.rom().game(), cli)?;
        summary.tilesets = count;
        if !q {
            println!(
                "  {} Tilesets written to {}",
                style("\u{2713}").green().bold(),
                style(tilesets_dir.display()).bold(),
            );
        }
    }
    if dump_sprites {
        let sprites = extractor.sprites().with_context(|| "extracting sprites")?;
        let species_names = extractor
            .species_names()
            .with_context(|| "loading species names")?;
        let national_map = extractor
            .national_dex_map()
            .with_context(|| "loading national dex map")?;
        let sprites_dir = cli.export.join("pokemon/sprites");
        if !q {
            println!(
                "  {} Extracting sprites...",
                style("\u{2192}").cyan().bold(),
            );
        }
        let count = output::write_sprites(&sprites, &national_map, &sprites_dir, cli)?;
        summary.sprites = count;
        if !q {
            println!(
                "  {} Extracted {} sprites to {}",
                style("\u{2713}").green().bold(),
                style(count).bold(),
                style(sprites_dir.display()).bold(),
            );
        }
        // Also extract and write alternate forms.
        let forms = extractor.forms().with_context(|| "extracting forms")?;
        if !forms.is_empty() {
            if !q {
                println!(
                    "  {} Extracting alternate forms...",
                    style("\u{2192}").cyan().bold(),
                );
            }
            let form_count =
                output::write_forms(&forms, &species_names, &national_map, &sprites_dir, cli)?;
            summary.forms = form_count;
            if !q {
                println!(
                    "  {} Extracted {} form sprites",
                    style("\u{2713}").green().bold(),
                    style(form_count).bold(),
                );
            }
        }
    }
    Ok(summary)
}

pub(crate) mod output {
    use super::*;
    use crate::{Metatiles, Sprite, SpriteSheet};

    fn progress_bar(len: u64, quiet: bool) -> ProgressBar {
        if quiet {
            return ProgressBar::hidden();
        }
        let pb = ProgressBar::new(len);
        pb.set_style(
            ProgressStyle::with_template("  {spinner:.dim} [{bar:30}] {pos}/{len} {msg}")
                .unwrap()
                .progress_chars("#>-"),
        );
        pb
    }

    pub(super) fn write_tileset_pngs(
        metatiles: &Metatiles,
        export_dir: &Path,
        game: crate::Game,
        cli: &Cli,
    ) -> Result<usize> {
        std::fs::create_dir_all(export_dir)
            .with_context(|| format!("creating {}", export_dir.display()))?;
        let primary_tile_count = game.primary_tile_count();
        let exclude = super::super::game_exclude(game);
        let filter = cli
            .tileset_filter
            .as_deref()
            .map(glob::Pattern::new)
            .transpose()
            .with_context(|| "invalid tileset filter pattern")?;

        let entries: Vec<_> = metatiles
            .iter()
            .filter(|(name, _)| !exclude.contains(name))
            .filter(|(name, _)| {
                if let Some(ref pat) = filter {
                    pat.matches(name)
                } else {
                    true
                }
            })
            .collect();

        let pb = progress_bar(entries.len() as u64, cli.quiet);
        let count = entries.len();

        entries.par_iter().try_for_each(|(name, entry)| {
            let renderer = match entry.secondary.as_ref() {
                Some(secondary) => TilesetRenderer::new(&entry.primary)
                    .with_secondary(secondary)
                    .with_primary_tile_count(primary_tile_count),
                None => {
                    TilesetRenderer::new(&entry.primary).with_primary_tile_count(primary_tile_count)
                }
            };
            let img = renderer.render();
            let path = export_dir.join(format!("{name}.png"));
            img.save_png(&path)
                .with_context(|| format!("saving {}", path.display()))?;
            pb.inc(1);
            Ok::<(), anyhow::Error>(())
        })?;

        pb.finish_and_clear();
        Ok(count)
    }

    pub(super) fn write_sprites(
        sprites: &[Sprite],
        national_map: &[u16],
        out_dir: &Path,
        cli: &Cli,
    ) -> Result<usize> {
        if cli.spritesheet {
            write_spritesheet(sprites, out_dir, cli.spritesheet_columns)?;
            return Ok(sprites.len());
        }
        write_individual(sprites, national_map, out_dir, cli)
    }

    fn write_spritesheet(sprites: &[Sprite], out_dir: &Path, columns: usize) -> Result<()> {
        std::fs::create_dir_all(out_dir)
            .with_context(|| format!("creating {}", out_dir.display()))?;
        let mut front_imgs = Vec::new();
        let mut back_imgs = Vec::new();
        let mut species_list = Vec::new();
        for sprite in sprites {
            if let Some(img) = render_sprite(sprite, true) {
                front_imgs.push(img);
                species_list.push(sprite.name.clone());
            }
            if let Some(img) = render_sprite(sprite, false) {
                back_imgs.push(img);
            }
        }
        if !front_imgs.is_empty() {
            let sheet = compose_spritesheet(&front_imgs, columns);
            sheet
                .save_png(out_dir.join("front_spritesheet.png"))
                .with_context(|| "saving front spritesheet")?;
        }
        if !back_imgs.is_empty() {
            let sheet = compose_spritesheet(&back_imgs, columns);
            sheet
                .save_png(out_dir.join("back_spritesheet.png"))
                .with_context(|| "saving back spritesheet")?;
        }
        let list = species_list
            .into_iter()
            .enumerate()
            .map(|(i, name)| format!("{}: {}", i + 1, name))
            .collect::<Vec<_>>()
            .join("\n");
        std::fs::write(out_dir.join("species_list.txt"), list)
            .with_context(|| "writing species_list.txt")?;
        Ok(())
    }

    fn write_individual(
        sprites: &[Sprite],
        national_map: &[u16],
        out_dir: &Path,
        cli: &Cli,
    ) -> Result<usize> {
        std::fs::create_dir_all(out_dir)
            .with_context(|| format!("creating {}", out_dir.display()))?;

        let filter = cli
            .sprite_filter
            .as_deref()
            .map(glob::Pattern::new)
            .transpose()
            .with_context(|| "invalid sprite filter pattern")?;

        let filtered: Vec<_> = sprites
            .iter()
            .filter(|s| {
                if let Some(ref pat) = filter {
                    pat.matches(&s.name)
                } else {
                    true
                }
            })
            .collect();

        let pb = progress_bar(filtered.len() as u64 * 4, cli.quiet);
        let count = filtered.len();

        filtered.par_iter().try_for_each(|sprite| {
            let display_name = if sprite.name == "?" || sprite.name.is_empty() {
                "egg"
            } else {
                &sprite.name
            };
            let dex_num = national_map
                .get(sprite.id.0 as usize)
                .copied()
                .filter(|&n| n != 0)
                .unwrap_or(sprite.id.0);
            let species_dir = if display_name == "egg" {
                out_dir.join("egg")
            } else {
                out_dir.join(format!("{:03}_{}", dex_num, display_name))
            };
            std::fs::create_dir_all(&species_dir)
                .with_context(|| format!("creating {}", species_dir.display()))?;
            for (is_front, label) in [(true, "front"), (false, "back")] {
                for (is_shiny, suffix) in [(false, ""), (true, "_shiny")] {
                    if let Some(img) = render_sprite_variant(sprite, is_front, is_shiny) {
                        let path = species_dir.join(format!("{label}{suffix}.png"));
                        img.save_png(&path)
                            .with_context(|| format!("saving {}", path.display()))?;
                    }
                    pb.inc(1);
                }
            }
            Ok::<(), anyhow::Error>(())
        })?;

        pb.finish_and_clear();
        Ok(count)
    }

    fn render_sprite(sprite: &Sprite, is_front: bool) -> Option<crate::RgbaImage> {
        render_sprite_variant(sprite, is_front, false)
    }

    fn render_sprite_variant(
        sprite: &Sprite,
        is_front: bool,
        is_shiny: bool,
    ) -> Option<crate::RgbaImage> {
        let sheet: &SpriteSheet = if is_front {
            sprite.front.as_ref()?
        } else {
            sprite.back.as_ref()?
        };
        let palette_data = if is_shiny {
            &sprite.shiny_palette
        } else {
            &sprite.palette
        };
        let palette = palette_data.get(0)?;
        Some(SpriteRenderer::new(sheet, palette).render())
    }

    pub(super) fn write_forms(
        forms: &[crate::FormSprite],
        species_names: &[String],
        national_map: &[u16],
        sprites_dir: &Path,
        cli: &Cli,
    ) -> Result<usize> {
        use crate::sprite::MonCoords;
        use crate::tileset::TileData;
        use crate::{FormSprite, SpriteRenderer, SpriteSheet};
        use std::collections::BTreeMap;

        // Group forms by base species.
        let mut by_species: BTreeMap<u16, Vec<&FormSprite>> = BTreeMap::new();
        for form in forms {
            by_species.entry(form.base.0).or_default().push(form);
        }

        let filter = cli
            .sprite_filter
            .as_deref()
            .map(glob::Pattern::new)
            .transpose()
            .with_context(|| "invalid sprite filter pattern")?;

        // Flatten into a Vec for parallel processing.
        let mut work: Vec<(&FormSprite, std::path::PathBuf)> = Vec::new();
        for (base_id, form_list) in &by_species {
            let base_name = species_names
                .get(*base_id as usize)
                .cloned()
                .unwrap_or_default();
            if base_name.is_empty() || base_name == "?" {
                continue;
            }
            if let Some(ref pat) = filter {
                if !pat.matches(&base_name) {
                    continue;
                }
            }
            let dex_num = national_map
                .get(*base_id as usize)
                .copied()
                .filter(|&n| n != 0)
                .unwrap_or(*base_id);
            let species_dir = sprites_dir.join(format!("{:03}_{}", dex_num, base_name));
            let forms_dir = species_dir.join("forms");

            for form in form_list {
                let form_dir = forms_dir.join(&form.form);
                work.push((form, form_dir));
            }
        }

        let total = work.len() as u64 * 4;
        let pb = progress_bar(total, cli.quiet);

        let count = work.len();

        work.par_iter().try_for_each(|(form, form_dir)| {
            std::fs::create_dir_all(form_dir)
                .with_context(|| format!("creating {}", form_dir.display()))?;

            for (_is_front, label, tiles_data) in [
                (true, "front", form.front_tiles.as_ref()),
                (false, "back", form.back_tiles.as_ref()),
            ] {
                let Some(tiles) = tiles_data else {
                    continue;
                };
                let sheet = SpriteSheet {
                    tiles: TileData::from_bytes(tiles.clone()),
                    coords: MonCoords::default(),
                };
                for (_is_shiny, suffix, palette_opt) in [
                    (false, "", form.palette.as_ref()),
                    (true, "_shiny", form.shiny_palette.as_ref()),
                ] {
                    let Some(pal) = palette_opt else {
                        continue;
                    };
                    let Some(palette_data) = pal.get(0) else {
                        continue;
                    };
                    let img = SpriteRenderer::new(&sheet, palette_data).render();
                    let path = form_dir.join(format!("{label}{suffix}.png"));
                    img.save_png(&path)
                        .with_context(|| format!("saving {}", path.display()))?;
                    pb.inc(1);
                }
            }
            Ok::<(), anyhow::Error>(())
        })?;

        pb.finish_and_clear();
        Ok(count)
    }

    fn compose_spritesheet(images: &[crate::RgbaImage], columns: usize) -> crate::RgbaImage {
        let max_w = images.iter().map(|i| i.width()).max().unwrap_or(64);
        let max_h = images.iter().map(|i| i.height()).max().unwrap_or(64);
        let rows = images.len().div_ceil(columns);
        let pad = 1u32;
        let sheet_w = columns as u32 * (max_w + pad) - pad;
        let sheet_h = rows as u32 * (max_h + pad) - pad;
        let mut sheet = crate::RgbaImage::new(sheet_w, sheet_h);
        for (idx, img) in images.iter().enumerate() {
            let col = idx % columns;
            let row = idx / columns;
            let x = col as u32 * (max_w + pad);
            let y = row as u32 * (max_h + pad);
            sheet.alpha_blit(img, (x, y));
        }
        sheet
    }
}