was421 / fstools-rs

Some file formats defined in a rust library

fstools

Tools for FROMSOFTWARE
Report Bug · Request Feature

• About The Project
  • Built With
• Features
• Getting Started
  • Dependencies
  • Building from Source
• Usage
• Contributing
• License
• Contact
• Acknowledgments

About The Project

fstools-rs is a Rust-based toolkit for modding and analyzing FROMSOFTWARE games, supporting archive extraction, format conversion, and data analysis.

Built With

• Rust
• Many others...

(back to top)

Features

• Archive extraction: Unpack DVDBNDs and BNDs from game data as fast as possible.
• File analysis: Offers tools for analysis of asset data structures, intended to aid in understanding underlying game mechanics and data relationships.

(back to top)

Getting Started

Dependencies

• Rust Programming Language: Installation instructions are available at the official Rust language website.

Building from Source

1. Clone the repository:

   git clone https://github.com/soulsmods/fstools-rs.git

2. Change into the repository directory:

   cd fstools-rs

3. Compile the project using Cargo:

   cargo build --release

   The resulting binaries are located in target/release.

Usage

fstools is invoked via the command line, with each utility accessible through subcommands. For example, to recursively extract a BND within the DVDBNDs:

fstools-cli extract --recursive -o <destination_directory> [optional_dvdbnd_name]

Detailed documentation on subcommand parameters and options is available within the --help output.

(back to top)

Contributing

See CONTRIBUTING.md

License

Distributed under either the Apache Software License 2.0 or MIT License. See LICENSE-APACHE and LICENSE-MIT for more information.

(back to top)

Contact

Project Link: https://github.com/soulsmods/fstools-rs

Discussions Board: https://github.com/soulsmods/fstools-rs/discussions

(back to top)

Acknowledgments

• SoulsFormats - widely used and de-facto library for interacting with FROMSOFTWARE assets.

(back to top)