add initial psogc_quest_tool utility

only supports showing quest file information

Cargo.toml

@@ -2,6 +2,7 @@
 
 members = [
     "psoutils",
+    "psogc_quest_tool"
 ]
 
 

psogc_quest_tool/Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+name = "psogc_quest_tool"
+version = "0.1.0"
+authors = ["gered <gered@blarg.ca>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+anyhow = "1.0.40"
+
+[dependencies.psoutils]
+path = "../psoutils"

psogc_quest_tool/src/main.rs

@@ -0,0 +1,185 @@
+use std::env;
+
+use anyhow::{Context, Result};
+
+use psoutils::quest::bin::QuestBin;
+use psoutils::quest::dat::{QuestDat, QuestDatTableType};
+use psoutils::quest::qst::QuestQst;
+use psoutils::quest::Quest;
+use std::fmt::Display;
+use std::path::Path;
+
+const VERSION: &'static str = env!("CARGO_PKG_VERSION");
+
+fn display_banner() {
+    println!("psogc_quest_tool v{}", VERSION);
+}
+
+fn display_help() {
+    println!("Tool for PSO Gamecube quest bin/dat and/or qst files.\n");
+    println!("USAGE: psogc_quest_tool <COMMAND> <ARGS...>\n");
+    println!("COMMANDS:");
+    println!("  info    - Displays info about a quest.");
+    println!("            - info input.bin input.dat");
+    println!("            - info input.qst");
+    println!("  convert - Converts a quest to a different file format");
+    println!("            - convert <input bin+dat or qst> <format_type> <output bin+dat or qst>");
+    println!("            Where format_type should be one of: raw_bindat, prs_bindat, online_qst, offline_qst");
+}
+
+fn display_quest_bin_info(bin: &QuestBin) {
+    println!("QUEST .BIN FILE");
+    println!("======================================================================");
+    println!("name:                       {}", bin.header.name);
+    println!("object_code size:           {}", bin.object_code.len());
+    println!(
+        "function_offset_table size: {}",
+        bin.function_offset_table.len()
+    );
+    println!("is_download:                {}", bin.header.is_download);
+    println!(
+        "quest_number:               {0} (8-bit)  {1}, 0x{1:04x} (16-bit)",
+        bin.header.quest_number(),
+        bin.header.quest_number_u16()
+    );
+    println!(
+        "episode:                    {} (0x{:02x})",
+        bin.header.episode() + 1,
+        bin.header.episode()
+    );
+    println!("language:                   {:?}", bin.header.language);
+    println!(
+        "short_description:          {}\n",
+        bin.header
+            .short_description
+            .trim()
+            .replace("\n", "\n                            ")
+    );
+    println!(
+        "long_description:           {}\n",
+        bin.header
+            .long_description
+            .trim()
+            .replace("\n", "\n                            ")
+    );
+    println!()
+}
+
+fn display_quest_dat_info(dat: &QuestDat, episode: u32) {
+    println!("QUEST .DAT FILE");
+    println!("======================================================================");
+
+    for (index, table) in dat.tables.iter().enumerate() {
+        let body_size = table.bytes.len();
+        match table.table_type() {
+            QuestDatTableType::Object => {
+                let num_entities = body_size / 68;
+                println!(
+                    "{:3} {:5} {:<21} {:30} {:5}",
+                    index,
+                    body_size,
+                    table.table_type().to_string(),
+                    table.area_name(episode).to_string(),
+                    num_entities
+                );
+            }
+            QuestDatTableType::NPC => {
+                let num_entities = body_size / 72;
+                println!(
+                    "{:3} {:5} {:<21} {:30} {:5}",
+                    index,
+                    body_size,
+                    table.table_type().to_string(),
+                    table.area_name(episode).to_string(),
+                    num_entities
+                );
+            }
+            QuestDatTableType::Wave => {
+                println!(
+                    "{:3} {:5} {:<21} {:30}",
+                    index,
+                    body_size,
+                    table.table_type().to_string(),
+                    table.area_name(episode).to_string()
+                );
+            }
+            QuestDatTableType::ChallengeModeSpawns => {
+                println!(
+                    "{:3} {:5} {:<21} {:30}",
+                    index,
+                    body_size,
+                    table.table_type().to_string(),
+                    table.area_name(episode).to_string()
+                );
+            }
+            QuestDatTableType::ChallengeModeUnknown => {
+                println!(
+                    "{:3} {:5} {:<21} {:30}",
+                    index,
+                    body_size,
+                    table.table_type().to_string(),
+                    table.area_name(episode).to_string(),
+                );
+            }
+            QuestDatTableType::Unknown(n) => {
+                println!("{:3} {:5} Unknown: {}", index, body_size, n);
+            }
+        };
+    }
+}
+
+fn quest_info(args: &[String]) -> Result<()> {
+    let quest = match args.len() {
+        0 => {
+            println!("No quest file(s) specified.");
+            std::process::exit(1);
+        }
+        1 => {
+            println!("Loading quest from .qst file ...");
+            let qst_path = Path::new(&args[0]);
+            Quest::from_qst_file(qst_path).context("Unable to load .qst file")?
+        }
+        2 => {
+            println!("Loading quest from .bin and .dat file ...");
+            let bin_path = Path::new(&args[0]);
+            let dat_path = Path::new(&args[1]);
+            Quest::from_bindat_files(bin_path, dat_path)
+                .context("Unable to load .bin/.dat files")?
+        }
+        _ => {
+            println!("Too many arguments. Should only specify either a single .qst file, or a .bin and .dat file.");
+            std::process::exit(1);
+        }
+    };
+
+    display_quest_bin_info(&quest.bin);
+    display_quest_dat_info(&quest.dat, quest.bin.header.episode() as u32);
+
+    Ok(())
+}
+
+fn quest_convert(args: &[String]) -> Result<()> {
+    todo!()
+}
+
+fn main() -> Result<()> {
+    display_banner();
+
+    let args: Vec<String> = env::args().collect();
+    if args.len() < 2 {
+        display_help();
+    }
+    let command = &args[1];
+    let remaining_args = &args[2..];
+    match command.to_lowercase().as_str() {
+        "info" => quest_info(&remaining_args),
+        "convert" => quest_convert(&remaining_args),
+        _ => {
+            println!("Unrecognized command");
+            display_help();
+            Ok(())
+        }
+    };
+
+    Ok(())
+}