mkdedede 0.3.1

Rust crate for decoding and encoding Mario Kart ghost data passwords (Double Dash!! and DS)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

# MKDedede

A Rust crate for decoding and encoding Mario Kart: Double Dash!! and Mario Kart DS ghost data passwords

---

The games generate a 16-character password after a time trial that encodes some info about them. This crate parses and validates those passwords.

Double Dash ported from the JavaScript decoder by [WaluigiBSOD](https://github.com/WaluigiBSOD/mkdd-password-decoder).

DS ported from the C decoder by [simontime](https://github.com/simontime/MKDSTTCodeDecoder/blob/master/decoder.c).

## Simple Double Dash decoding example

```rust
use mkdedede::double_dash::decode;

match decode("SOME16CHARPASSWD") {
    Ok(ghost) => println!("{}", ghost),
    Err(e)    => eprintln!("invalid password: {}", e),
}
```

## Usage from C/C++ (FFI)

We provide an FFI layer that exposes C-compatible functions to decode and encode passwords!

To build for C/C++, use cargo to build the native bindings:

```bash
cargo build --release
```

This will produce `.so`, `.dylib`, or `.dll` (and their respective static architectures) inside `target/release/`. 

Include the provided header from `include/mkdedede.h` in your project and link the output shared library.

```c
#include <stdio.h>
#include "mkdedede.h"

int main() {
    MkddGhostDataC data;
    MkdededeDecodeStatus status = mkdedede_mkdd_decode("SOME16CHARPASSWD", &data);

    if (status == MKDEDEDE_SUCCESS) {
        printf("Course: %d\n", data.course);
        // ...
    } else {
        printf("Decode failed with status: %d\n", status);
    }
    return 0;
}
```

## License

AGPL-3.0, see [LICENSE](LICENSE)