Restructure module layout so game-specific modules are at root-level

data-prepper/src/extract/mod.rs → data-prepper/src/extract.rs

@@ -1,7 +1,3 @@
-pub mod ryza3;
-pub mod sophie;
-mod util;
-
 use std::{
     fs::File,
     path::{Path, PathBuf},
@@ -60,8 +56,10 @@ impl Args {
 
         // extract data from game files
         match game_version {
-            GameVersion::A17 => sophie::extract(pak_index, &output_directory),
-            GameVersion::A24 => ryza3::extract(&self.game_directory, pak_index, &output_directory),
+            GameVersion::A17 => super::sophie::extract(pak_index, &output_directory),
+            GameVersion::A24 => {
+                super::ryza3::extract(&self.game_directory, pak_index, &output_directory)
+            }
             _ => bail!("Unsupported game version {:?}", game_version),
         }
     }

data-prepper/src/main.rs

@@ -1,5 +1,6 @@
 mod extract;
-mod extract_images;
+pub mod ryza3;
+pub mod sophie;
 mod typedefs;
 mod utils;
 
@@ -26,7 +27,7 @@ struct CliArgs {
 #[argh(subcommand)]
 enum Subcommand {
     Extract(extract::Args),
-    ExtractImages(extract_images::Args),
+    ExtractImages(ryza3::extract_images::Args), // TODO: allow extracting images from other games
     TypeDefs(typedefs::Args),
 }
 

data-prepper/src/extract/ryza3/data/enemies/data.rs → data-prepper/src/ryza3/data/enemies/data.rs

@@ -1,7 +1,4 @@
-use crate::{
-    extract::util::{self, ElementReader},
-    utils::PakIndex,
-};
+use crate::utils::{self, ElementReader, PakIndex};
 
 #[derive(Debug)]
 pub struct EnemyData {
@@ -21,7 +18,7 @@ pub struct EnemyData {
 
 impl EnemyData {
     pub fn read(pak_index: &mut PakIndex) -> anyhow::Result<Vec<Self>> {
-        util::read_xml(pak_index, r"\saves\enemy\enemy_data.xml", |d| {
+        utils::read_xml(pak_index, r"\saves\enemy\enemy_data.xml", |d| {
             Self::read_from_doc(d)
         })
     }

data-prepper/src/extract/ryza3/data/enemies/drop.rs → data-prepper/src/ryza3/data/enemies/drop.rs

@@ -1,7 +1,4 @@
-use crate::{
-    extract::util::{self, ElementReader},
-    utils::PakIndex,
-};
+use crate::utils::{self, ElementReader, PakIndex};
 
 #[derive(Debug)]
 pub struct DropData {
@@ -39,7 +36,7 @@ pub struct DropData {
 
 impl DropData {
     pub fn read(pak_index: &mut PakIndex) -> anyhow::Result<Vec<Self>> {
-        util::read_xml(pak_index, r"\saves\enemy\drop_data.xml", |d| {
+        utils::read_xml(pak_index, r"\saves\enemy\drop_data.xml", |d| {
             Self::read_from_doc(d)
         })
     }

data-prepper/src/extract/ryza3/data/enemies/library_monster.rs → data-prepper/src/ryza3/data/enemies/library_monster.rs

@@ -1,7 +1,4 @@
-use crate::{
-    extract::util::{self, ElementReader},
-    utils::PakIndex,
-};
+use crate::utils::{self, ElementReader, PakIndex};
 
 pub struct LibraryMonster {
     pub monster_tag: String,
@@ -12,7 +9,7 @@ pub struct LibraryMonster {
 
 impl LibraryMonster {
     pub fn read(pak_index: &mut PakIndex) -> anyhow::Result<Vec<Self>> {
-        util::read_xml(pak_index, r"\saves\library\librarymonster.xml", |d| {
+        utils::read_xml(pak_index, r"\saves\library\librarymonster.xml", |d| {
             Self::read_from_doc(d)
         })
     }

data-prepper/src/extract/ryza3/data/enemies/status.rs → data-prepper/src/ryza3/data/enemies/status.rs

@@ -1,7 +1,4 @@
-use crate::{
-    extract::util::{self, ElementReader},
-    utils::PakIndex,
-};
+use crate::utils::{self, ElementReader, PakIndex};
 
 #[derive(Debug, Clone)]
 pub struct EnemyStatus {
@@ -33,7 +30,7 @@ pub struct EnemyStatus {
 
 impl EnemyStatus {
     pub fn read(pak_index: &mut PakIndex) -> anyhow::Result<Vec<Self>> {
-        util::read_xml(pak_index, r"\saves\enemy\enemy_status.xml", |d| {
+        utils::read_xml(pak_index, r"\saves\enemy\enemy_status.xml", |d| {
             Self::read_from_doc(d)
         })
     }

data-prepper/src/extract/ryza3/data/feeding/species.rs → data-prepper/src/ryza3/data/feeding/species.rs

@@ -1,9 +1,6 @@
 //! Data from `\saves\feeding\feedingspecies.xml`
 
-use crate::{
-    extract::util::{self, ElementReader},
-    utils::PakIndex,
-};
+use crate::utils::{self, ElementReader, PakIndex};
 
 pub struct Species {
     pub no: usize,
@@ -35,7 +32,7 @@ pub struct Species {
 
 impl Species {
     pub fn read(pak_index: &mut PakIndex) -> anyhow::Result<Vec<Self>> {
-        util::read_xml(
+        utils::read_xml(
             pak_index,
             r"\saves\feeding\feedingspecies.xml",
             Self::read_from_doc,

data-prepper/src/extract/ryza3/data/feeding/unique_item_event.rs → data-prepper/src/ryza3/data/feeding/unique_item_event.rs

@@ -1,9 +1,6 @@
 //! Data from `\saves\feeding\feedinguniqueitemevent.xml`
 
-use crate::{
-    extract::util::{self, ElementReader},
-    utils::PakIndex,
-};
+use crate::utils::{self, ElementReader, PakIndex};
 
 pub struct FeedingUniqueItemEvent {
     pub no: usize,
@@ -15,7 +12,7 @@ pub struct FeedingUniqueItemEvent {
 
 impl FeedingUniqueItemEvent {
     pub fn read(pak_index: &mut PakIndex) -> anyhow::Result<Vec<Self>> {
-        util::read_xml(
+        utils::read_xml(
             pak_index,
             r"\saves\feeding\feedinguniqueitemevent.xml",
             Self::read_from_doc,

data-prepper/src/extract/ryza3/data/field_data/gimmick.rs → data-prepper/src/ryza3/data/field_data/gimmick.rs

@@ -3,10 +3,7 @@ use std::collections::BTreeMap;
 use anyhow::Context;
 use tracing::debug;
 
-use crate::{
-    extract::util::{self, ElementReader},
-    utils::PakIndex,
-};
+use crate::utils::{self, ElementReader, PakIndex};
 
 #[derive(Debug)]
 pub struct GimmickProperty {
@@ -48,7 +45,7 @@ impl GimmickProperty {
                 let stripped = file_name.trim_start_matches(PREFIX);
                 debug_assert!(stripped.ends_with(".xml"));
 
-                let parsed = util::read_xml(pak_index, file_name, Self::read_from_doc)
+                let parsed = utils::read_xml(pak_index, file_name, Self::read_from_doc)
                     .with_context(|| format!("parse gimmick doc '{file_name}'"))?;
 
                 Ok((stripped.to_owned(), parsed))

data-prepper/src/extract/ryza3/data/field_data/mod.rs → data-prepper/src/ryza3/data/field_data/mod.rs

@@ -11,7 +11,7 @@ use serde::Serialize;
 use tracing::trace;
 use typescript_type_def::TypeDef;
 
-use crate::extract::ryza3::data::field_data::gimmick::GimmickProperty;
+use crate::ryza3::data::field_data::gimmick::GimmickProperty;
 use crate::utils::PakIndex;
 pub use field_data_types::*;
 

data-prepper/src/extract/ryza3/data/field_map/fm_info.rs → data-prepper/src/ryza3/data/field_map/fm_info.rs

@@ -1,5 +1,4 @@
-use crate::extract::util::{self, ElementReader};
-use crate::utils::PakIndex;
+use crate::utils::{self, ElementReader, PakIndex};
 use anyhow::Context;
 
 pub struct FieldMapInfo {
@@ -18,7 +17,7 @@ pub struct FieldMapInfo {
 
 impl FieldMapInfo {
     pub fn read(pak_index: &mut PakIndex) -> anyhow::Result<Vec<Self>> {
-        util::read_xml(pak_index, r"\saves\fieldmap\info\fm_info.xml", |d| {
+        utils::read_xml(pak_index, r"\saves\fieldmap\info\fm_info.xml", |d| {
             Self::read_from_doc(d)
         })
     }

data-prepper/src/extract/ryza3/data/field_map/fm_info2.rs → data-prepper/src/ryza3/data/field_map/fm_info2.rs

@@ -1,5 +1,4 @@
-use crate::extract::util::{self, ElementReader};
-use crate::utils::PakIndex;
+use crate::utils::{self, ElementReader, PakIndex};
 use anyhow::Context;
 
 pub struct FieldMapInfo2 {
@@ -16,7 +15,7 @@ pub struct FieldMapInfo2 {
 impl FieldMapInfo2 {
     pub fn read(pak_index: &mut PakIndex) -> anyhow::Result<Vec<Self>> {
         // NOTE: reading as shift_jis
-        util::read_xml_shift_jis(pak_index, r"\saves\fieldmap\info\fm_info2.xml", |d| {
+        utils::read_xml_shift_jis(pak_index, r"\saves\fieldmap\info\fm_info2.xml", |d| {
             Self::read_from_doc(d)
         })
     }

data-prepper/src/extract/ryza3/data/field_map/mod.rs → data-prepper/src/ryza3/data/field_map/mod.rs

@@ -1,4 +1,4 @@
-use crate::extract::ryza3::data::strings_table::StringsTable;
+use crate::ryza3::data::strings_table::StringsTable;
 use crate::utils::PakIndex;
 use serde::Serialize;
 use std::collections::BTreeMap;

data-prepper/src/extract/ryza3/data/field_map/region_maps.rs → data-prepper/src/ryza3/data/field_map/region_maps.rs

@@ -1,5 +1,4 @@
-use crate::extract::util::{self, ElementReader};
-use crate::utils::PakIndex;
+use crate::utils::{self, ElementReader, PakIndex};
 use anyhow::Context;
 
 pub struct RegionMap {
@@ -12,7 +11,7 @@ pub struct RegionMap {
 
 impl RegionMap {
     pub fn read(pak_index: &mut PakIndex) -> anyhow::Result<Vec<Self>> {
-        util::read_xml(
+        utils::read_xml(
             pak_index,
             r"\saves\ui_cmn\a24_map\uil_a24_overall_map.xml",
             Self::read_from_doc,

data-prepper/src/extract/ryza3/data/item_categories/mod.rs → data-prepper/src/ryza3/data/item_categories/mod.rs

@@ -4,7 +4,7 @@ use anyhow::Context;
 use serde::Serialize;
 use typescript_type_def::TypeDef;
 
-use crate::extract::ryza3::executable::Ryza3ExecutableData;
+use crate::ryza3::executable::Ryza3ExecutableData;
 
 use super::strings_table::StringsTable;
 

data-prepper/src/extract/ryza3/data/item_effects/item_effect.rs → data-prepper/src/ryza3/data/item_effects/item_effect.rs

@@ -1,10 +1,7 @@
 use anyhow::Context;
 use roxmltree::Node;
 
-use crate::{
-    extract::util::{self, ElementReader},
-    utils::PakIndex,
-};
+use crate::utils::{self, ElementReader, PakIndex};
 
 pub struct ItemEffect {
     pub name_id: Option<String>,
@@ -23,7 +20,7 @@ pub struct ItemEffect {
 
 impl ItemEffect {
     pub fn read(pak_index: &mut PakIndex) -> anyhow::Result<Vec<Self>> {
-        util::read_xml(pak_index, r"\saves\item\item_effect.xml", |d| {
+        utils::read_xml(pak_index, r"\saves\item\item_effect.xml", |d| {
             Self::read_from_doc(d)
         })
     }

data-prepper/src/extract/ryza3/data/item_effects/mod.rs → data-prepper/src/ryza3/data/item_effects/mod.rs

@@ -7,7 +7,7 @@ use serde::Serialize;
 use tracing::debug;
 use typescript_type_def::TypeDef;
 
-use crate::{extract::ryza3::executable::Ryza3ExecutableData, utils::PakIndex};
+use crate::{ryza3::executable::Ryza3ExecutableData, utils::PakIndex};
 
 use super::strings_table::StringsTable;
 

data-prepper/src/extract/ryza3/data/items/item_data.rs → data-prepper/src/ryza3/data/items/item_data.rs

@@ -1,9 +1,6 @@
 use tracing::trace;
 
-use crate::{
-    extract::util::{self, ElementReader},
-    utils::PakIndex,
-};
+use crate::utils::{self, ElementReader, PakIndex};
 
 pub struct ItemData {
     pub name_id: Option<String>,
@@ -48,7 +45,7 @@ pub struct ItemData {
 
 impl ItemData {
     pub fn read(pak_index: &mut PakIndex) -> anyhow::Result<Vec<Self>> {
-        util::read_xml(pak_index, r"\saves\item\itemdata.xml", |d| {
+        utils::read_xml(pak_index, r"\saves\item\itemdata.xml", |d| {
             Self::read_from_doc(d)
         })
     }

data-prepper/src/extract/ryza3/data/items/library_item.rs → data-prepper/src/ryza3/data/items/library_item.rs

@@ -1,7 +1,4 @@
-use crate::{
-    extract::util::{self, ElementReader},
-    utils::PakIndex,
-};
+use crate::utils::{self, ElementReader, PakIndex};
 
 pub struct LibraryItem {
     pub item_tag: String,
@@ -12,7 +9,7 @@ pub struct LibraryItem {
 
 impl LibraryItem {
     pub fn read(pak_index: &mut PakIndex) -> anyhow::Result<Vec<Self>> {
-        util::read_xml(pak_index, r"\saves\library\libraryitem.xml", |d| {
+        utils::read_xml(pak_index, r"\saves\library\libraryitem.xml", |d| {
             Self::read_from_doc(d)
         })
     }

data-prepper/src/extract/ryza3/data/recipes/itemrecipedata.rs → data-prepper/src/ryza3/data/recipes/itemrecipedata.rs

@@ -2,10 +2,7 @@
 
 use anyhow::{bail, Context};
 
-use crate::{
-    extract::util::{self, ElementReader},
-    utils::PakIndex,
-};
+use crate::utils::{self, ElementReader, PakIndex};
 
 pub enum ItemRecipeData {
     Header(RecipeHeader),
@@ -86,7 +83,7 @@ impl IngredientData {
 
 impl ItemRecipeData {
     pub fn read(pak_index: &mut PakIndex) -> anyhow::Result<Vec<Self>> {
-        util::read_xml(pak_index, r"\saves\item\itemrecipedata.xml", |d| {
+        utils::read_xml(pak_index, r"\saves\item\itemrecipedata.xml", |d| {
             Self::read_from_doc(d)
         })
     }

data-prepper/src/extract/ryza3/data/recipes/mixfielddata.rs → data-prepper/src/ryza3/data/recipes/mixfielddata.rs

@@ -2,10 +2,7 @@ use std::collections::HashMap;
 
 use anyhow::{bail, Context};
 
-use crate::{
-    extract::util::{self, ElementReader},
-    utils::PakIndex,
-};
+use crate::utils::{self, ElementReader, PakIndex};
 
 /// A hash map of `tag` to `ExtendedFieldData`.
 pub struct ExtendedFieldData(pub HashMap<String, Vec<Field>>);
@@ -74,7 +71,7 @@ pub struct RingParam {
 
 impl ExtendedFieldData {
     pub fn read(pak_index: &mut PakIndex) -> anyhow::Result<Self> {
-        util::read_xml(pak_index, r"\saves\mix\mixfielddata.xml", |d| {
+        utils::read_xml(pak_index, r"\saves\mix\mixfielddata.xml", |d| {
             Self::read_from_doc(d)
         })
     }

data-prepper/src/extract/ryza3/data/strings_table.rs → data-prepper/src/ryza3/data/strings_table.rs

@@ -2,10 +2,7 @@ use std::collections::HashMap;
 
 use anyhow::Context;
 
-use crate::{
-    extract::util::{self, ElementReader},
-    utils::PakIndex,
-};
+use crate::utils::{self, ElementReader, PakIndex};
 
 pub struct StringsTable {
     pub id_lookup: HashMap<String, String>,
@@ -14,7 +11,7 @@ pub struct StringsTable {
 
 impl StringsTable {
     pub fn read(pak_index: &mut PakIndex) -> anyhow::Result<Self> {
-        util::read_xml(
+        utils::read_xml(
             pak_index,
             r"\saves\text_en\strcombineall.xml",
             Self::read_from_doc,