mirror of
https://github.com/NinjaCheetah/rustii.git
synced 2025-06-06 15:31:02 -04:00
28 lines
1.8 KiB
Markdown
28 lines
1.8 KiB
Markdown
|
|
# rustii
|
|
|
|
*Like rusty but it's rustii because the Wii? Get it?*
|
|
|
|
[](https://github.com/NinjaCheetah/rustii/actions/workflows/rust.yml)
|
|
|
|
rustii is a library and command line tool written in Rust for handling the various files and formats found on the Wii. rustii is a port of my other library, [libWiiPy](https://github.com/NinjaCheetah/libWiiPy), which aims to accomplish the same goal in Python. Compared to libWiiPy, rustii is in its very early stages of development and is missing most of the features present in its Python counterpart. The goal is for rustii and libWiiPy to eventually have feature parity, with the rustii CLI acting as a drop-in replacement for the (comparatively much less efficient) [WiiPy](https://github.com/NinjaCheetah/WiiPy) CLI.
|
|
|
|
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)
|
|
- A basic CLI that uses the above features to allow for packing/unpacking WADs
|
|
|
|
### 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.
|
|
|
|
## 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:
|
|
```
|
|
cargo build --release
|
|
```
|
|
to compile the rustii library and CLI. The CLI can then be found at `target/release/rustii(.exe)`.
|