Merge pull request #20 from soulsmods/rename-fstools

Add fstools prefix to all crates, move under subfolder
soulsmods · Mar 10, 2024 · 7bedc7b · 7bedc7b
2 parents f8de80e + fbd0837
commit 7bedc7b
Show file tree

Hide file tree

Showing 56 changed files with 400 additions and 432 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,10 +1,12 @@
 [package]
 name = "fstools"
-edition = "2021"
+edition.workspace = true
+version.workspace = true
+license.workspace = true
 
 [dependencies]
-format = { path = "format" }
-souls_vfs = { path = "vfs" }
+fstools_formats.workspace = true
+fstools_vfs.workspace = true
 
 [dev-dependencies]
 insta = "1"
@@ -17,18 +19,22 @@ harness = false
 
 [workspace]
 resolver = "2"
-default-members = ["cli", "viewer"]
+default-members = ["crates/cli", "crates/viewer"]
 members = [
-    "format",
-    "cli",
-    "viewer",
-    "vfs",
-    "util",
+    "crates/formats",
+    "crates/cli",
+    "crates/viewer",
+    "crates/vfs",
 ]
 
 [workspace.package]
 version = "0.1.0"
 license = "MIT AND Apache-2.0"
+edition = "2021"
 
-[workspace.dependencies.thiserror]
-version = "1"
+[workspace.dependencies]
+fstools_formats = { path = "crates/formats", version = "0.1.0" }
+fstools_vfs = { path = "crates/vfs", version = "0.1.0" }
+memmap2 = "0.7"
+rayon = "1"
+thiserror = "1"
diff --git a/cli/Cargo.toml → crates/cli/Cargo.toml b/cli/Cargo.toml → crates/cli/Cargo.toml
@@ -1,18 +1,14 @@
 [package]
-name = "cli"
+name = "fstools_cli"
 version.workspace = true
 license.workspace = true
-edition = "2021"
+edition.workspace = true
 
 [dependencies]
 clap = { version = "4", features = ["derive"] }
-format = { path = "../format" }
 indicatif = { version = "0.17", features = ["rayon"] }
-rayon = "1"
-souls_vfs = { path = "../vfs" }
-util = { path = "../util" }
-
-[dependencies.memmap2]
-version = "0.7"
-
+fstools_formats.workspace = true
+fstools_vfs.workspace = true
+memmap2.workspace = true
+rayon.workspace = true
 
diff --git a/cli/src/bin/bdt-extract.rs → crates/cli/src/bin/bdt-extract.rs b/cli/src/bin/bdt-extract.rs → crates/cli/src/bin/bdt-extract.rs
@@ -1,9 +1,9 @@
 use std::{fs, io::Read, path::PathBuf};
 
 use clap::Parser;
+use fstools_vfs::{FileKeyProvider, Vfs};
 use indicatif::{ParallelProgressIterator, ProgressStyle};
 use rayon::iter::{IntoParallelRefIterator, ParallelIterator};
-use souls_vfs::{FileKeyProvider, Vfs};
 
 #[derive(Parser, Debug)]
 #[command(version, about, long_about = None)]

diff --git a/cli/src/bin/bdt-ls.rs → crates/cli/src/bin/bdt-ls.rs b/cli/src/bin/bdt-ls.rs → crates/cli/src/bin/bdt-ls.rs
diff --git a/cli/src/bin/bnd-extract.rs → crates/cli/src/bin/bnd-extract.rs b/cli/src/bin/bnd-extract.rs → crates/cli/src/bin/bnd-extract.rs
@@ -4,7 +4,7 @@ use std::{
 };
 
 use clap::Parser;
-use format::{bnd4::BND4, dcx::DcxHeader};
+use fstools_formats::{bnd4::BND4, dcx::DcxHeader};
 
 #[derive(Parser, Debug)]
 #[command(version, about, long_about = None)]

diff --git a/cli/src/lib.rs → crates/cli/src/lib.rs b/cli/src/lib.rs → crates/cli/src/lib.rs
diff --git a/format/Cargo.toml → crates/formats/Cargo.toml b/format/Cargo.toml → crates/formats/Cargo.toml
@@ -1,26 +1,23 @@
 [package]
-name = "format"
+name = "fstools_formats"
 version.workspace = true
 license.workspace = true
-edition = "2021"
+edition.workspace = true
 build = "build.rs"
 
 [features]
 default = []
 strict-padding = []
 
 [dependencies]
+aes = "0.8"
 bytemuck = "1"
 byteorder = "1"
-aes = "0.8"
-rayon = "1"
-rug = "1.24"
+flate2 = "1.0"
+oodle-sys = "0.1"
+rayon.workspace = true
 rsa = "0.9"
+rug = "1.24"
 zerocopy = { version = "0.7.32", features = ["derive"] }
-flate2 = "1.0"
-
-[dependencies.thiserror]
-workspace = true
+thiserror.workspace = true
 
-[dependencies.oodle-sys]
-version = "0.1"
diff --git a/format/build.rs → crates/formats/build.rs b/format/build.rs → crates/formats/build.rs
diff --git a/format/liboo2corelinux64.a → crates/formats/liboo2corelinux64.a b/format/liboo2corelinux64.a → crates/formats/liboo2corelinux64.a
diff --git a/format/liboo2corelinux64.so.9 → crates/formats/liboo2corelinux64.so.9 b/format/liboo2corelinux64.so.9 → crates/formats/liboo2corelinux64.so.9
diff --git a/format/src/bhd.rs → crates/formats/src/bhd.rs b/format/src/bhd.rs → crates/formats/src/bhd.rs
diff --git a/format/src/bnd4.rs → crates/formats/src/bnd4.rs b/format/src/bnd4.rs → crates/formats/src/bnd4.rs
diff --git a/format/src/dcx/deflate.rs → crates/formats/src/dcx/deflate.rs b/format/src/dcx/deflate.rs → crates/formats/src/dcx/deflate.rs
diff --git a/format/src/dcx/mod.rs → crates/formats/src/dcx/mod.rs b/format/src/dcx/mod.rs → crates/formats/src/dcx/mod.rs
diff --git a/format/src/dcx/oodle.rs → crates/formats/src/dcx/oodle.rs b/format/src/dcx/oodle.rs → crates/formats/src/dcx/oodle.rs
diff --git a/format/src/flver/bone.rs → crates/formats/src/flver/bone.rs b/format/src/flver/bone.rs → crates/formats/src/flver/bone.rs
diff --git a/format/src/flver/dummy.rs → crates/formats/src/flver/dummy.rs b/format/src/flver/dummy.rs → crates/formats/src/flver/dummy.rs
diff --git a/format/src/flver/face_set.rs → crates/formats/src/flver/face_set.rs b/format/src/flver/face_set.rs → crates/formats/src/flver/face_set.rs
diff --git a/format/src/flver/header.rs → crates/formats/src/flver/header.rs b/format/src/flver/header.rs → crates/formats/src/flver/header.rs
diff --git a/format/src/flver/material.rs → crates/formats/src/flver/material.rs b/format/src/flver/material.rs → crates/formats/src/flver/material.rs
diff --git a/format/src/flver/mesh.rs → crates/formats/src/flver/mesh.rs b/format/src/flver/mesh.rs → crates/formats/src/flver/mesh.rs
diff --git a/format/src/flver/mod.rs → crates/formats/src/flver/mod.rs b/format/src/flver/mod.rs → crates/formats/src/flver/mod.rs
diff --git a/format/src/flver/reader.rs → crates/formats/src/flver/reader.rs b/format/src/flver/reader.rs → crates/formats/src/flver/reader.rs
diff --git a/format/src/flver/texture.rs → crates/formats/src/flver/texture.rs b/format/src/flver/texture.rs → crates/formats/src/flver/texture.rs
diff --git a/format/src/flver/vertex_buffer/accessor.rs → ...rmats/src/flver/vertex_buffer/accessor.rs b/format/src/flver/vertex_buffer/accessor.rs → ...rmats/src/flver/vertex_buffer/accessor.rs
diff --git a/format/src/flver/vertex_buffer/mod.rs → ...es/formats/src/flver/vertex_buffer/mod.rs b/format/src/flver/vertex_buffer/mod.rs → ...es/formats/src/flver/vertex_buffer/mod.rs
diff --git a/.../src/flver/vertex_buffer/normalization.rs → .../src/flver/vertex_buffer/normalization.rs b/.../src/flver/vertex_buffer/normalization.rs → .../src/flver/vertex_buffer/normalization.rs
diff --git a/format/src/io_ext/mod.rs → crates/formats/src/io_ext/mod.rs b/format/src/io_ext/mod.rs → crates/formats/src/io_ext/mod.rs
diff --git a/format/src/io_ext/read.rs → crates/formats/src/io_ext/read.rs b/format/src/io_ext/read.rs → crates/formats/src/io_ext/read.rs
diff --git a/format/src/io_ext/zerocopy.rs → crates/formats/src/io_ext/zerocopy.rs b/format/src/io_ext/zerocopy.rs → crates/formats/src/io_ext/zerocopy.rs
diff --git a/format/src/lib.rs → crates/formats/src/lib.rs b/format/src/lib.rs → crates/formats/src/lib.rs
diff --git a/format/src/matbin.rs → crates/formats/src/matbin.rs b/format/src/matbin.rs → crates/formats/src/matbin.rs
diff --git a/format/src/tpf.rs → crates/formats/src/tpf.rs b/format/src/tpf.rs → crates/formats/src/tpf.rs
diff --git a/vfs/.gitignore → crates/vfs/.gitignore b/vfs/.gitignore → crates/vfs/.gitignore
diff --git a/crates/vfs/Cargo.toml b/crates/vfs/Cargo.toml
@@ -0,0 +1,12 @@
+[package]
+name = "fstools_vfs"
+version.workspace = true
+license.workspace = true
+edition.workspace = true
+
+[dependencies]
+aes = "0.8"
+encoding_rs = "0.8"
+fstools_formats.workspace = true
+memmap2.workspace = true
+thiserror.workspace = true
diff --git a/vfs/src/bnd.rs → crates/vfs/src/bnd.rs b/vfs/src/bnd.rs → crates/vfs/src/bnd.rs
@@ -3,7 +3,7 @@ use std::{
     io::{self, Cursor, Read},
 };
 
-use format::{
+use fstools_formats::{
     bnd4::BND4,
     dcx::{DcxError, DcxHeader},
 };

diff --git a/vfs/src/key_provider.rs → crates/vfs/src/key_provider.rs b/vfs/src/key_provider.rs → crates/vfs/src/key_provider.rs
@@ -1,6 +1,6 @@
 use std::{fs, path::PathBuf};
 
-use format::bhd::BhdKey;
+use fstools_formats::bhd::BhdKey;
 
 // TODO: replace Option with Result
 pub trait ArchiveKeyProvider {

diff --git a/vfs/src/lib.rs → crates/vfs/src/lib.rs b/vfs/src/lib.rs → crates/vfs/src/lib.rs
@@ -11,7 +11,7 @@ use aes::{
     cipher::{generic_array::GenericArray, BlockDecrypt, BlockSizeUser, KeyInit},
     Aes128,
 };
-use format::bhd::Bhd;
+use fstools_formats::bhd::Bhd;
 use memmap2::MmapOptions;
 use thiserror::Error;
 

diff --git a/vfs/src/name.rs → crates/vfs/src/name.rs b/vfs/src/name.rs → crates/vfs/src/name.rs
diff --git a/vfs/src/reader.rs → crates/vfs/src/reader.rs b/vfs/src/reader.rs → crates/vfs/src/reader.rs
diff --git a/viewer/Cargo.toml → crates/viewer/Cargo.toml b/viewer/Cargo.toml → crates/viewer/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
-name = "viewer"
-edition = "2021"
+name = "fstools_viewer"
+edition.workspace = true
 version.workspace = true
 license.workspace = true
 
@@ -10,11 +10,8 @@ license.workspace = true
 clap = { version = "4", features = ["derive"] }
 byteorder = "1"
 bevy = { version = "0.13", features = ["dds"] }
-format = { path = "../format" }
-souls_vfs = { path = "../vfs" }
-util = { path = "../util" }
 bevy_panorbit_camera = "0.14"
 bevy-inspector-egui = "0.23"
-
-[dependencies.thiserror]
-workspace = true
+fstools_formats.workspace = true
+fstools_vfs.workspace = true
+thiserror.workspace = true
diff --git a/viewer/assets/shaders/shader.wgsl → crates/viewer/assets/shaders/shader.wgsl b/viewer/assets/shaders/shader.wgsl → crates/viewer/assets/shaders/shader.wgsl
diff --git a/viewer/src/flver/asset.rs → crates/viewer/src/flver/asset.rs b/viewer/src/flver/asset.rs → crates/viewer/src/flver/asset.rs
@@ -9,7 +9,7 @@ use bevy::{
     },
 };
 use byteorder::LE;
-use format::flver::{
+use fstools_formats::flver::{
     face_set::FaceSetIndices,
     mesh::Mesh as FlverMesh,
     reader::{VertexAttributeSemantic, FLVER},
@@ -102,7 +102,7 @@ fn load_mesh(flver: &Flver, flver_mesh: &FlverMesh<LE>) -> Mesh {
     let layout_members = flver.vertex_attributes(layout);
 
     for member in layout_members {
-        use format::flver::reader::VertexAttributeSemantic::*;
+        use fstools_formats::flver::reader::VertexAttributeSemantic::*;
 
         let semantic = VertexAttributeSemantic::from(member.semantic_id.get());
         let Some(accessor) = flver.vertex_attribute_accessor(buffer, member) else {

diff --git a/viewer/src/flver/mod.rs → crates/viewer/src/flver/mod.rs b/viewer/src/flver/mod.rs → crates/viewer/src/flver/mod.rs
diff --git a/viewer/src/formats/mod.rs → crates/viewer/src/formats/mod.rs b/viewer/src/formats/mod.rs → crates/viewer/src/formats/mod.rs
diff --git a/viewer/src/formats/tpf.rs → crates/viewer/src/formats/tpf.rs b/viewer/src/formats/tpf.rs → crates/viewer/src/formats/tpf.rs
@@ -12,8 +12,8 @@ use bevy::{
     },
     utils::BoxedFuture,
 };
-use format::tpf::TPF;
-use souls_vfs::undo_container_compression;
+use fstools_formats::tpf::TPF;
+use fstools_vfs::undo_container_compression;
 use thiserror::Error;
 
 use crate::formats::TpfPlugin;

diff --git a/viewer/src/main.rs → crates/viewer/src/main.rs b/viewer/src/main.rs → crates/viewer/src/main.rs
@@ -4,7 +4,7 @@ use bevy::prelude::*;
 use bevy_inspector_egui::quick::WorldInspectorPlugin;
 use bevy_panorbit_camera::{PanOrbitCamera, PanOrbitCameraPlugin};
 use clap::Parser;
-use souls_vfs::{FileKeyProvider, Vfs};
+use fstools_vfs::{FileKeyProvider, Vfs};
 use vfs::VfsAssetRepositoryPlugin;
 
 use crate::{flver::asset::FlverAsset, formats::FormatsPlugins};

diff --git a/viewer/src/vfs/mod.rs → crates/viewer/src/vfs/mod.rs b/viewer/src/vfs/mod.rs → crates/viewer/src/vfs/mod.rs
@@ -4,7 +4,7 @@ use bevy::{
     asset::io::{AssetSource, AssetSourceId},
     prelude::*,
 };
-use souls_vfs::Vfs;
+use fstools_vfs::Vfs;
 
 use self::reader::VfsAssetRepository;
 

diff --git a/viewer/src/vfs/reader.rs → crates/viewer/src/vfs/reader.rs b/viewer/src/vfs/reader.rs → crates/viewer/src/vfs/reader.rs
@@ -14,7 +14,7 @@ use bevy::{
     prelude::{Deref, DerefMut, Resource},
     tasks::futures_lite::{io::Cursor, AsyncRead},
 };
-use souls_vfs::{Vfs, VfsEntryReader as VfsEntryReaderImpl, VfsOpenError};
+use fstools_vfs::{Vfs, VfsEntryReader as VfsEntryReaderImpl, VfsOpenError};
 
 #[derive(Clone, Deref, DerefMut, Resource)]
 pub struct VfsAssetRepository(pub(crate) Arc<Vfs>);

diff --git a/deny.toml b/deny.toml
@@ -0,0 +1,52 @@
+[graph]
+targets = [
+    "x86_64-unknown-linux-gnu",
+    "x86_64-apple-darwin",
+    "x86_64-pc-windows-msvc",
+    "x86_64-pc-windows-gnu",
+]
+all-features = true
+
+[advisories]
+version = 2
+ignore = [
+    { id = "RUSTSEC-2023-0071", reason = "we're decrypting public data with publicly available keys" }
+]
+
+[licenses]
+version = 2
+allow = [
+    "0BSD",
+    "Apache-2.0",
+    "BSD-2-Clause",
+    "BSD-3-Clause",
+    "MIT",
+    "Unlicense",
+    "Zlib",
+]
+
+exceptions = [
+    { name = "unicode-ident", allow = [
+        "Unicode-DFS-2016",
+    ] },
+    { name = "rug", allow = [
+        "LGPL-3.0"
+    ] },
+    { name = "gmp-mpfr-sys", allow = [
+        "LGPL-3.0"
+    ] }
+]
+
+[bans]
+multiple-versions = "warn"
+wildcards = "deny"
+# Certain crates that we don't want multiple versions of in the dependency tree
+deny = [
+    { name = "bevy", deny-multiple-versions = true },
+]
+
+[sources]
+unknown-registry = "deny"
+unknown-git = "deny"
+allow-registry = ["https://github.com/rust-lang/crates.io-index"]
+allow-git = []
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,9 +1,9 @@
 pub mod formats {
-    pub use format::*;
+    pub use fstools_formats::*;
 }
 
 pub mod vfs {
-    pub use souls_vfs::*;
+    pub use fstools_vfs::*;
 }
 
 pub mod prelude {

diff --git a/tests/dcx.rs b/tests/dcx.rs
@@ -1,7 +1,7 @@
 use std::{collections::HashSet, error::Error, io::Read, path::PathBuf, sync::Arc};
 
-use format::dcx::DcxError;
 use fstools::{formats::dcx::DcxHeader, prelude::*};
+use fstools_formats::dcx::DcxError;
 use insta::assert_snapshot;
 use libtest_mimic::{Arguments, Failed, Trial};
 

diff --git a/util/Cargo.toml b/util/Cargo.toml
diff --git a/util/src/lib.rs b/util/src/lib.rs
diff --git a/vfs/Cargo.toml b/vfs/Cargo.toml