phantop/doukutsu-rs
1
0
Fork 0
mirror of https://github.com/doukutsu-rs/doukutsu-rs synced 2025-03-25 11:29:30 +00:00
Code Issues Releases Wiki Activity

NXEngine data compatibility and npc set loading

Browse source
This commit is contained in:
Alula 2020-08-19 03:59:16 +02:00
parent 25ae8707ef
commit ff5962d97e
No known key found for this signature in database
GPG key ID: 3E00485503A1D8BA
3 changed files with 138 additions and 80 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/main.rs
View file

@ -5,7 +5,7 @@ extern crate strum_macros;
use std::{env, mem};
use std::path;
use ggez::{Context, ContextBuilder, event, GameResult, filesystem};
use ggez::{Context, ContextBuilder, event, filesystem, GameResult};
use ggez::conf::{WindowMode, WindowSetup};
use ggez::event::{KeyCode, KeyMods};
use ggez::event::winit_event::{ElementState, Event, KeyboardInput, WindowEvent};
@ -20,9 +20,9 @@ use pretty_env_logger::env_logger::Env;
use crate::engine_constants::EngineConstants;
use crate::scene::loading_scene::LoadingScene;
use crate::scene::Scene;
use crate::sound::SoundManager;
use crate::stage::StageData;
use crate::texture_set::TextureSet;
use crate::sound::SoundManager;
mod common;
mod engine_constants;
@ -203,7 +203,7 @@ pub fn main() -> GameResult {
path.push("data");
path
} else {
path::PathBuf::from("./data")
path::PathBuf::from(&env::var("CAVESTORY_DATA_DIR").unwrap_or(str!("data")))
};
info!("Resource directory: {:?}", resource_dir);

200
src/stage.rs
View file

@ -1,61 +1,40 @@
use std::io::{Cursor, Read};
use std::str::from_utf8;
use byteorder::{BE, LE, ReadBytesExt};
use byteorder::LE;
use byteorder::ReadBytesExt;
use ggez::{Context, filesystem, GameResult};
use ggez::GameError::ResourceLoadError;
use log::info;
use strum::AsStaticRef;
use crate::map::Map;
#[derive(Debug, EnumIter, AsStaticStr, PartialEq, Eq, Hash, Copy, Clone)]
pub enum NpcType {
#[strum(serialize = "0")]
Zero,
Almo1,
Almo2,
Ballos,
Bllg,
Cemet,
Cent,
Curly,
Dark,
Dr,
Eggs1,
Eggs2,
Frog,
Guest,
Hell,
Heri,
IronH,
Island,
Kings,
Maze,
Miza,
Moon,
Omg,
Plant,
Press,
Priest,
Ravil,
Red,
Regu,
Sand,
Stream,
Sym,
Toro,
TwinD,
Weed,
X,
#[derive(Debug, PartialEq, Eq, Hash)]
pub struct NpcType {
name: String,
}
impl Clone for NpcType {
fn clone(&self) -> Self {
Self {
name: self.name.clone(),
}
}
}
impl NpcType {
pub fn new(name: &str) -> Self {
Self {
name: name.to_owned(),
}
}
pub fn filename(&self) -> String {
["Npc", self.as_static()].join("")
["Npc", &self.name].join("")
}
}
#[derive(Debug, PartialEq, Eq, Hash)]
pub struct Tileset {
name: String,
@ -148,12 +127,12 @@ impl BackgroundType {
pub struct StageData {
pub name: String,
pub map: String,
pub boss: String,
pub boss_no: usize,
pub tileset: Tileset,
pub background: Background,
pub background_type: BackgroundType,
pub npc: NpcType,
pub npc1: NpcType,
pub npc2: NpcType,
}
impl Clone for StageData {
@ -161,27 +140,50 @@ impl Clone for StageData {
StageData {
name: self.name.clone(),
map: self.map.clone(),
boss: self.boss.clone(),
boss_no: self.boss_no,
tileset: self.tileset.clone(),
background: self.background.clone(),
background_type: self.background_type,
npc: self.npc,
npc1: self.npc1.clone(),
npc2: self.npc2.clone(),
}
}
}
const NXENGINE_BACKDROPS: [&str; 15] = [
"bk0", "bkBlue", "bkGreen", "bkBlack", "bkGard", "bkMaze",
"bkGray", "bkRed", "bkWater", "bkMoon", "bkFog", "bkFall",
"bkLight", "bkSunset", "bkHellish"
];
const NXENGINE_TILESETS: [&str; 22] = [
"0", "Pens", "Eggs", "EggX", "EggIn", "Store", "Weed",
"Barr", "Maze", "Sand", "Mimi", "Cave", "River",
"Gard", "Almond", "Oside", "Cent", "Jail", "White",
"Fall", "Hell", "Labo"
];
const NXENGINE_NPCS: [&str; 34] = [
"Guest", "0", "Eggs1", "Ravil", "Weed", "Maze",
"Sand", "Omg", "Cemet", "Bllg", "Plant", "Frog",
"Curly", "Stream", "IronH", "Toro", "X", "Dark",
"Almo1", "Eggs2", "TwinD", "Moon", "Cent", "Heri",
"Red", "Miza", "Dr", "Almo2", "Kings", "Hell",
"Press", "Priest", "Ballos", "Island"
];
impl StageData {
// todo: refactor to make it less repetitive.
pub fn load_stage_table(ctx: &mut Context, root: &str) -> GameResult<Vec<Self>> {
let stage_tbl_path = [root, "stage.tbl"].join("");
let stage_dat_path = [root, "stage.dat"].join("");
let mrmap_bin_path = [root, "mrmap.bin"].join("");
if filesystem::exists(ctx, &stage_tbl_path) {
// Cave Story+ stage table. Probably one of most awful formats out there.
// Cave Story+ stage table.
let mut stages = Vec::new();
info!("Loading stage table from {}", &stage_tbl_path);
info!("Loading CaveStory+/Booster's Lab style stage table from {}", &stage_tbl_path);
let mut data = Vec::new();
filesystem::open(ctx, stage_tbl_path)?.read_to_end(&mut data)?;
@ -192,8 +194,8 @@ impl StageData {
let mut ts_buf = vec![0u8; 0x20];
let mut map_buf = vec![0u8; 0x20];
let mut back_buf = vec![0u8; 0x20];
let mut npc_buf = vec![0u8; 0x20];
let mut boss_buf = vec![0u8; 0x20];
let mut npc1_buf = vec![0u8; 0x20];
let mut npc2_buf = vec![0u8; 0x20];
let mut name_jap_buf = vec![0u8; 0x20];
let mut name_buf = vec![0u8; 0x20];
@ -201,8 +203,8 @@ impl StageData {
f.read_exact(&mut map_buf)?;
let bg_type = f.read_u32::<LE>()? as usize;
f.read_exact(&mut back_buf)?;
f.read_exact(&mut npc_buf)?;
f.read_exact(&mut boss_buf)?;
f.read_exact(&mut npc1_buf)?;
f.read_exact(&mut npc2_buf)?;
let boss_no = f.read_u8()? as usize;
f.read_exact(&mut name_jap_buf)?;
f.read_exact(&mut name_buf)?;
@ -216,34 +218,35 @@ impl StageData {
let background = from_utf8(&back_buf)
.map_err(|_| ResourceLoadError("UTF-8 error in background field".to_string()))?
.trim_matches('\0').to_owned();
let boss = from_utf8(&boss_buf)
.map_err(|_| ResourceLoadError("UTF-8 error in boss field".to_string()))?
let npc1 = from_utf8(&npc1_buf)
.map_err(|_| ResourceLoadError("UTF-8 error in npc1 field".to_string()))?
.trim_matches('\0').to_owned();
let npc2 = from_utf8(&npc2_buf)
.map_err(|_| ResourceLoadError("UTF-8 error in npc2 field".to_string()))?
.trim_matches('\0').to_owned();
let name = from_utf8(&name_buf)
.map_err(|_| ResourceLoadError("UTF-8 error in name field".to_string()))?
.trim_matches('\0').to_owned();
println!("bg type: {}", bg_type);
let stage = Self {
name: name.clone(),
map: map.clone(),
boss: boss.clone(),
boss_no,
tileset: Tileset::new(&tileset),
background: Background::new(&background),
background_type: BackgroundType::new(bg_type),
npc: NpcType::Zero,
npc1: NpcType::new(&npc1),
npc2: NpcType::new(&npc2),
};
stages.push(stage);
}
return Ok(stages);
} else if filesystem::exists(ctx, &mrmap_bin_path) {
// CSE2 stage table
// CSE2E stage table
let mut stages = Vec::new();
info!("Loading stage table from {}", &mrmap_bin_path);
info!("Loading CSE2E style stage table from {}", &mrmap_bin_path);
let mut data = Vec::new();
let mut fh = filesystem::open(ctx, &mrmap_bin_path)?;
@ -260,16 +263,16 @@ impl StageData {
let mut ts_buf = vec![0u8; 0x10];
let mut map_buf = vec![0u8; 0x10];
let mut back_buf = vec![0u8; 0x10];
let mut npc_buf = vec![0u8; 0x10];
let mut boss_buf = vec![0u8; 0x10];
let mut npc1_buf = vec![0u8; 0x10];
let mut npc2_buf = vec![0u8; 0x10];
let mut name_buf = vec![0u8; 0x22];
f.read_exact(&mut ts_buf)?;
f.read_exact(&mut map_buf)?;
let bg_type = f.read_u8()? as usize;
f.read_exact(&mut back_buf)?;
f.read_exact(&mut npc_buf)?;
f.read_exact(&mut boss_buf)?;
f.read_exact(&mut npc1_buf)?;
f.read_exact(&mut npc2_buf)?;
let boss_no = f.read_u8()? as usize;
f.read_exact(&mut name_buf)?;
@ -282,8 +285,64 @@ impl StageData {
let background = from_utf8(&back_buf)
.map_err(|_| ResourceLoadError("UTF-8 error in background field".to_string()))?
.trim_matches('\0').to_owned();
let boss = from_utf8(&boss_buf)
.map_err(|_| ResourceLoadError("UTF-8 error in boss field".to_string()))?
let npc1 = from_utf8(&npc1_buf)
.map_err(|_| ResourceLoadError("UTF-8 error in npc1 field".to_string()))?
.trim_matches('\0').to_owned();
let npc2 = from_utf8(&npc2_buf)
.map_err(|_| ResourceLoadError("UTF-8 error in npc2 field".to_string()))?
.trim_matches('\0').to_owned();
let name = from_utf8(&name_buf)
.map_err(|_| ResourceLoadError("UTF-8 error in name field".to_string()))?
.trim_matches('\0').to_owned();
println!("bg type: {}", bg_type);
let stage = Self {
name: name.clone(),
map: map.clone(),
boss_no,
tileset: Tileset::new(&tileset),
background: Background::new(&background),
background_type: BackgroundType::new(bg_type),
npc1: NpcType::new(&npc1),
npc2: NpcType::new(&npc2),
};
stages.push(stage);
}
return Ok(stages);
} else if filesystem::exists(ctx, &stage_dat_path) {
let mut stages = Vec::new();
info!("Loading NXEngine style stage table from {}", &stage_dat_path);
let mut data = Vec::new();
let mut fh = filesystem::open(ctx, &stage_dat_path)?;
let count = fh.read_u8()? as usize;
fh.read_to_end(&mut data)?;
if data.len() < count * 0x49 {
return Err(ResourceLoadError("Specified stage table size is bigger than actual number of entries.".to_string()));
}
let mut f = Cursor::new(data);
for _ in 0..count {
let mut map_buf = vec![0u8; 0x20];
let mut name_buf = vec![0u8; 0x23];
f.read_exact(&mut map_buf)?;
f.read_exact(&mut name_buf)?;
let tileset_id = f.read_u8()? as usize;
let bg_id = f.read_u8()? as usize;
let bg_type = f.read_u8()? as usize;
let boss_no = f.read_u8()? as usize;
let _npc1 = f.read_u8()? as usize;
let _npc2 = f.read_u8()? as usize;
let map = from_utf8(&map_buf)
.map_err(|_| ResourceLoadError("UTF-8 error in map field".to_string()))?
.trim_matches('\0').to_owned();
let name = from_utf8(&name_buf)
.map_err(|_| ResourceLoadError("UTF-8 error in name field".to_string()))?
@ -292,19 +351,18 @@ impl StageData {
let stage = Self {
name: name.clone(),
map: map.clone(),
boss: boss.clone(),
boss_no,
tileset: Tileset::new(&tileset),
background: Background::new(&background),
tileset: Tileset::new(NXENGINE_TILESETS.get(tileset_id).unwrap_or(&"0")),
background: Background::new(NXENGINE_BACKDROPS.get(bg_id).unwrap_or(&"0")),
background_type: BackgroundType::new(bg_type),
npc: NpcType::Zero,
npc1: NpcType::new(NXENGINE_NPCS.get(tileset_id).unwrap_or(&"0")),
npc2: NpcType::new(NXENGINE_NPCS.get(tileset_id).unwrap_or(&"0")),
};
stages.push(stage);
}
return Ok(stages);
}
// todo: NXEngine stage.dat support?
Err(ResourceLoadError("No stage table found.".to_string()))
}

12
src/texture_set.rs
View file

@ -7,7 +7,7 @@ use ggez::graphics::{Drawable, DrawParam, FilterMode, Image, Rect};
use ggez::graphics::spritebatch::SpriteBatch;
use ggez::nalgebra::{Point2, Vector2};
use itertools::Itertools;
use log::info;
use log::{debug, info};
use crate::common;
use crate::engine_constants::EngineConstants;
@ -91,15 +91,15 @@ impl TextureSet {
}
}
fn load_image(&self, ctx: &mut Context, constants: &EngineConstants, path: &str) -> GameResult<Image> {
fn load_image(&self, ctx: &mut Context, path: &str) -> GameResult<Image> {
let img = {
let mut buf = Vec::new();
let mut reader = filesystem::open(ctx, path)?;
let _ = reader.read_to_end(&mut buf)?;
let mut rgba = image::load_from_memory(&buf)?.to_rgba();
let image = image::load_from_memory(&buf)?;
let mut rgba = image.to_rgba();
// Cave Story+ data files don't have an alpha channel, therefore they need a special treatment.
if constants.is_cs_plus {
if image.color().channel_count() != 4 {
for (r, g, b, a) in rgba.iter_mut().tuples() {
if *r == 0 && *g == 0 && *b == 0 {
*a = 0;
@ -123,7 +123,7 @@ impl TextureSet {
info!("Loading texture: {}", path);
let image = self.load_image(ctx, constants, &path)?;
let image = self.load_image(ctx, &path)?;
let size = image.dimensions();
assert_ne!(size.w, 0.0, "size.w == 0");