smash-arc 0.6.0

A Rust library for working with Smash Ultimate's data.arc files
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

//! A library for working with the data.arc file from Smash Ultimate.
//!
//! ```rust
//! use smash_arc::{ArcFile, ArcLookup, FileNode, Hash40, Region};
//!
//! // Load the hashes needed to list directories (file format restriction)
//! Hash40::set_global_labels_file("hash_labels.txt").unwrap();
//!
//! // Parse the arc from a file
//! let arc = ArcFile::open("data.arc").unwrap();
//!
//! // loop over every file in the root
//! for node in arc.get_dir_listing("/").unwrap() {
//!     match node {
//!         FileNode::Dir(dir) => {
//!             // print out name of directory
//!             println!("directory: {}", dir.global_label().unwrap());
//!         }
//!         FileNode::File(file) => {
//!             // extract file
//!             let path = file.global_label().unwrap();
//!             std::fs::write(path, arc.get_file_contents(file, Region::UsEnglish).unwrap()).unwrap();
//!         }
//!     }
//! }
//! ```
//!
//! ## Cargo Features
//!
//! * `network` (enabled by default) = Ability to parse the file over the network
//! * `dir-listing` (enabled by default) = List directories
//! * `global-hashes` (enabled by default) = Enable a global table for cracking hashes
//! * `smash-runtime` = Enables features for running under the context of Smash Ultimate itself
//! (enable Aarch64 crc32 hardware acceleration, enable parsing the Arc from the game's memory
//! layout)
//! * `search` = Enable functionality to fuzzy search [`ArcFile`]s
//!
//! * ZSTD backends
//!   * `libzstd` - Recommended for use on platforms it builds for
//!   * `rust-zstd` - Increased portability (Recommended for use on switch)
//!   * `nozstd` - Provide no zstd backend, panic on ZSTD decompression

mod filesystem;
mod hash40;
mod hash_labels;
mod lookups;
mod region;
mod table_indices;
mod zstd_backend;

#[cfg(feature = "ffi-bindings")]
mod ffi_bindings;

#[cfg(feature = "search")]
mod search;

mod arc_file;
#[cfg(feature = "smash-runtime")]
mod loaded_arc;

#[cfg(feature = "smash-runtime")]
pub use loaded_arc::*;

pub use arc_file::*;
pub use filesystem::*;
pub use hash40::{hash40, Hash40};
pub use hash_labels::{HashLabels, GLOBAL_LABELS};
pub use lookups::{ArcLookup, LookupError, SearchLookup};
pub use table_indices::*;

#[cfg(feature = "serialize")]
pub use hash40::serde;
/// A node in the file tree, the hash of which can be used to handle lookups.
#[repr(C, u64)]
#[derive(Debug, PartialEq, Ord, PartialOrd, Eq)]
pub enum FileNode {
    Dir(Hash40),
    File(Hash40),
}

/// An enum representing a Region (country and associated language) supported by Smash Ultimate.
pub use region::Region;

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_parse() {
        let arc = ArcFile::open("/home/jam/re/ult/900/data.arc").unwrap();
    }
}