steam-friend-code 0.1.2

Encode and decode Steam CS:GO/CS2 friend codes and short Steam quick-invite codes.
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
59
60
61
62
63
64
65
66
67
68

# steam-friend-code

[![Crates.io](https://img.shields.io/crates/v/steam-friend-code.svg)](https://crates.io/crates/steam-friend-code)
[![Docs.rs](https://docs.rs/steam-friend-code/badge.svg)](https://docs.rs/steam-friend-code)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)

Steam friend code utilities — encoding and decoding both CS:GO/CS2 in-game friend codes and short Steam quick-invite codes.

## Installation

```toml
[dependencies]
steam-friend-code = "0.1"
```

## Two Code Formats

### CSGO Friend Code

Base32/MD5-encoded codes used in the CS:GO and CS2 in-game friend system, displayed as `ABCDE-FGHJK-LMNPQ`.

```rust
use steam_friend_code::CsgoFriendCode;

// Encode a SteamID64 into a CS:GO friend code
let code = CsgoFriendCode::encode(76561198000000000)?;
println!("{}", code); // e.g. "ABCDE-FGHJK-LMNPQ"

// Decode a code back to SteamID64
let steam_id = CsgoFriendCode::decode("ABCDE-FGHJK-LMNPQ")?;
```

`SteamFriendCode` is a backward-compatible type alias for `CsgoFriendCode`.

### Short Steam Friend Code

Hex-mapped codes used in Steam quick-invite links (`https://s.team/p/{code}/{token}`).

```rust
use steam_friend_code::{
    create_short_steam_friend_code,
    parse_short_steam_friend_code,
    parse_quick_invite_link,
    SHORT_STEAM_FRIEND_CODE_CHARS,
};

// Create a short code from a SteamID64
let code = create_short_steam_friend_code(76561198000000000);

// Parse a short code back to SteamID64
let steam_id = parse_short_steam_friend_code(&code)?;

// Extract SteamID64 from a full s.team/p/... URL
let steam_id = parse_quick_invite_link("https://s.team/p/abcd-efgh/TOKEN")?;
```

`SHORT_STEAM_FRIEND_CODE_CHARS` is the character alphabet used by the short code encoding.

## API

| Symbol | Description |
|--------|-------------|
| `CsgoFriendCode` | Encode/decode CS:GO friend codes |
| `SteamFriendCode` | Alias for `CsgoFriendCode` |
| `create_short_steam_friend_code` | Encode SteamID64 → short invite code |
| `parse_short_steam_friend_code` | Decode short invite code → SteamID64 |
| `parse_quick_invite_link` | Extract SteamID64 from an `s.team/p/…` URL |
| `SHORT_STEAM_FRIEND_CODE_CHARS` | Character alphabet for short codes |