libfj 0.10.0

An unofficial collection of APIs used in FreeJam games and mods
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

use serde::{Deserialize, Serialize};

#[derive(Deserialize, Serialize, Clone)]
pub struct AuthenticationPayload {
    #[serde(rename = "EmailAddress")]
    pub email_address: String,
    #[serde(rename = "Password")]
    pub password: String,
}

#[derive(Deserialize, Serialize, Clone)]
pub struct SteamAuthenticationPayload {
    #[serde(rename = "SteamTicket")]
    pub steam_ticket: String,
    #[serde(rename = "Demo")]
    pub demo: bool,
}

#[derive(Deserialize, Serialize, Clone)]
pub struct TokenPayload {
    #[serde(rename = "PublicID")] // [sic] compared to AuthenticationInfo's PublidId
    pub public_id: String,
    #[serde(rename = "Token")]
    pub token: String,
}

#[derive(Deserialize, Serialize, Clone)]
pub struct TempGetUserIdPayload {
    #[serde(rename = "publicId")] // [sic] yay consistency
    pub public_id: String,
    #[serde(rename = "token")]
    pub token: String,
}

#[derive(Deserialize, Serialize, Clone)]
pub struct TempGetUserIdResponse {
    #[serde(rename = "publicId")] // [sic] yay consistency
    pub public_id: String,
    #[serde(rename = "token")]
    pub token: String,
    #[serde(rename = "userId")]
    pub user_id: i32,
}

/// Authentication information
#[derive(Deserialize, Serialize, Clone)]
pub struct AuthenticationInfo {
    /// User's public ID
    #[serde(rename = "PublicId")]
    pub public_id: String,
    /// User's email address
    #[serde(rename = "EmailAddress")]
    pub email_address: String,
    /// Account display name
    #[serde(rename = "DisplayName")]
    pub display_name: String,
    /// Account purchases (???)
    #[serde(rename = "Purchases")]
    pub purchases: Vec<usize>, // ???
    /// Account flags (dev, admin, etc.???)
    #[serde(rename = "Flags")]
    pub flags: Vec<String>, // ???
    /// Is confirmed account?
    #[serde(rename = "Confirmed")]
    pub confirmed: bool,
    /// Temporary account token
    #[serde(rename = "Token")]
    pub token: String,
    /// Steam ID
    ///
    /// Since Steam users cannot be authenticated using this lib, this will always be blank or None
    #[serde(rename = "SteamId")]
    pub steam_id: Option<String>, // ???
    /// User ID
    #[serde(rename = "ID")]
    pub id: i32,
}

impl std::string::ToString for AuthenticationInfo {
    fn to_string(&self) -> String {
        format!("{} ({})", &self.display_name, &self.public_id)
    }
}

#[derive(Deserialize, Serialize, Clone)]
pub struct LobbyPayload {
    #[serde(rename = "PublicId")]
    pub public_id: String,
}

/// Lobby information for available Cardlife servers
#[derive(Deserialize, Serialize, Clone)]
pub struct LobbyInfo {
    #[serde(rename = "Games")]
    /// Available servers' information
    pub games: Vec<LiveGameInfo>,
}

/// Server information for a single Cardlife server
#[derive(Deserialize, Serialize, Clone)]
pub struct LiveGameInfo {
    /// Server game ID
    #[serde(rename = "Id")]
    pub id: usize,
    /// World name
    #[serde(rename = "WorldName")]
    pub world_name: String,
    /// Max players
    #[serde(rename = "MaxPlayers")]
    pub max_players: usize,
    /// Current player count
    #[serde(rename = "CurrentPlayers")]
    pub current_players: usize,
    /// Server version
    #[serde(rename = "GameVersion")]
    pub game_version: String,
    /// Ping latency
    #[serde(rename = "Ping")]
    pub ping: usize,
    /// Account has already joined this server?
    #[serde(rename = "HasPlayed")]
    pub has_played: bool,
    /// Server is password protected?
    #[serde(rename = "HasPassword")]
    pub has_password: bool,
    /// PvP is enabled on this server?
    #[serde(rename = "IsPvp")]
    pub is_pvp: bool,
    /// EasyAntiCheat is enabled on this server?
    #[serde(rename = "IsAntiCheatEnabled")]
    pub is_anticheat_enabled: bool,
    /// Official server?
    #[serde(rename = "IsOfficial")]
    pub is_official: bool,
    /// Mods installed on this server
    #[serde(rename = "ModInfo")]
    pub mod_info: String,
    /// Server region
    #[serde(rename = "Region")]
    pub region: String,
}

impl std::string::ToString for LiveGameInfo {
    fn to_string(&self) -> String {
        format!("{} ({}):{}/{}", self.world_name, self.id, self.current_players, self.max_players)
    }
}