[−][src]Crate ninres
Read commonly used Nintendo file formats.
Please refer to the Wiki: https://github.com/Kinnay/Nintendo-File-Formats/wiki
All file formats are behind feature flags. Here is a list of available Nintendo file format features:
bfres
, sarc
You can also enable additional features:
tar_ninres
: write Nintendo resource to tar ball.
zstd
: ZSTD decompression.
All features of this crate can be compiled to WebAssembly.
Examples
Enable desired features in Cargo.toml
.
[dependencies]
ninres = { version = "*", features = ["bfres", "sarc", "zstd"] }
In your main.rs
.
use std::fs::read; use ninres::{NinRes, NinResFile}; let buffer = read("foo.pack")?; let ninres = buffer.as_ninres()?; match &ninres { NinResFile::Bfres(_bfres) => {} NinResFile::Sarc(_sarc) => {} } Ok(ninres)
Re-exports
pub use bfres::*; |
pub use sarc::*; |
Modules
bfres | Reads BFRES files. |
sarc | Reads SARC files. |
Enums
ByteOrderMask | |
NinResError | |
NinResFile |
Traits
IntoTar | Convert resource into tar buffer. This buffer can then e.g. be stored in a file. |
NinRes | Smart convert buffer into any known Nintendo file format. |
Type Definitions
NinResResult |