Updated README to better represent current features

This commit is contained in:
Campbell 2025-04-08 20:57:44 -04:00
parent be9148fcfa
commit 5f578fbfd8
Signed by: NinjaCheetah
GPG Key ID: 39C2500E1778B156
2 changed files with 19 additions and 7 deletions

View File

@ -9,15 +9,25 @@ rustii is a library and command line tool written in Rust for handling the vario
I'm still very new to Rust, so pardon any messy code or confusing API decisions you may find. libWiiPy started off like that, too.
### What's Included
- Structs for TMDs and Tickets that can be created from binary data
- Simple Title Key encryption/decryption
- Content encryption/decryption
- WAD parsing (allowing for packing/unpacking)
### What's Included (Library-Side)
- Structs for parsing and editing WADs, TMDs, Tickets, and Certificate Chains
- Title Key and content encryption/decryption
- High-level Title struct (offering the same utility as libWiiPy's `Title`)
- LZ77 compression/decompression
- ASH decompression
- NUS TMD/Ticket/certificate chain/content downloading
- A basic CLI that uses the above features to allow for packing/unpacking WADs
- The very basics of U8 archive handling (not really functional yet though)
### What's Not Included
- Basically anything else. Any other features present in libWiiPy not listed here either do not yet exist, or are in an experimental state.
### What's Included (CLI-Side)
- WAD packing/unpacking/converting
- NUS TMD/Ticket/Title downloading
- LZ77 compression/decompression
- ASH decompression
- Fakesigning command for WADs/TMDs/Tickets
- Info command for WADs/TMDs/Tickets
To see specific usage information, check `rustii --help` and `rustii <command> --help`.
## Building
rustii is a standard Rust package. You'll need to have [Rust installed](https://www.rust-lang.org/learn/get-started), and then you can simply run:

View File

@ -44,10 +44,12 @@ enum Commands {
#[command(subcommand)]
command: archive::lz77::Commands
},
/// Download data from the NUS
Nus {
#[command(subcommand)]
command: title::nus::Commands
},
/// Pack/unpack a U8 archive
U8 {
#[command(subcommand)]
command: archive::u8::Commands