#cli #unpacker #terraria #tmod

app tmod-unpacker

A simple CLI to unpack .tmod files, written in pure Rust

2 stable releases

1.0.1 Feb 23, 2023

#4 in #terraria

MIT/Apache

12KB
180 lines

.tmod unpacker

A simple CLI to unpack .tmod files, written in pure Rust.

Installation

cargo install tmod-unpacker

Usage

tmod-unpacker <input file> <output directory>

There is a simple help option which displays the above usage as well:

tmod-unpacker -h
# or
tmod-unpacker --help

You can enable logging with this crate using the RUST_LOG environment variable. If you are not experiencing errors, it is recommended that you stick to RUST_LOG=info or maybe RUST_LOG=debug if you are interested in the metadata of the mod. Using RUST_LOG=trace is extremely verbose and is intended to help diagnose errors in the reading and extraction of a .tmod file. Use with caution.

MSRV

The MSRV of this crate is 1.63.0. If for some reason you require this crate but cannot update to this version or higher, install the crate with:

cargo install --git "https://github.com/campbellcole/tmod-unpacker" --branch "msrv-1-56-1"

The above branch has an MSRV of 1.56.1, as the name suggests.

NOTE: The branch listed above is not supported and it is recommended that you use the newest possible version of Rust.

Side Note

There are no tests written for this crate because I do not have the capability to create a dummy .tmod file at the moment. This was tested on a few .tmod files from the Steam Workshop, but retrieving those requires SteamCMD and being logged in, which is not feasible for tests. If you encounter any issues, please open an issue on GitHub issues.

Dependencies

~3.5–5.5MB
~95K SLoC