mirror of
https://github.com/NinjaCheetah/rustii.git
synced 2025-06-06 15:31:02 -04:00
Updated README to better represent current features
This commit is contained in:
parent
be9148fcfa
commit
5f578fbfd8
24
README.md
24
README.md
@ -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.
|
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
|
### What's Included (Library-Side)
|
||||||
- Structs for TMDs and Tickets that can be created from binary data
|
- Structs for parsing and editing WADs, TMDs, Tickets, and Certificate Chains
|
||||||
- Simple Title Key encryption/decryption
|
- Title Key and content encryption/decryption
|
||||||
- Content encryption/decryption
|
- High-level Title struct (offering the same utility as libWiiPy's `Title`)
|
||||||
- WAD parsing (allowing for packing/unpacking)
|
- 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
|
- 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
|
### What's Included (CLI-Side)
|
||||||
- Basically anything else. Any other features present in libWiiPy not listed here either do not yet exist, or are in an experimental state.
|
- 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
|
## 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:
|
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:
|
||||||
|
@ -44,10 +44,12 @@ enum Commands {
|
|||||||
#[command(subcommand)]
|
#[command(subcommand)]
|
||||||
command: archive::lz77::Commands
|
command: archive::lz77::Commands
|
||||||
},
|
},
|
||||||
|
/// Download data from the NUS
|
||||||
Nus {
|
Nus {
|
||||||
#[command(subcommand)]
|
#[command(subcommand)]
|
||||||
command: title::nus::Commands
|
command: title::nus::Commands
|
||||||
},
|
},
|
||||||
|
/// Pack/unpack a U8 archive
|
||||||
U8 {
|
U8 {
|
||||||
#[command(subcommand)]
|
#[command(subcommand)]
|
||||||
command: archive::u8::Commands
|
command: archive::u8::Commands
|
||||||
|
Loading…
x
Reference in New Issue
Block a user