flatland-client-lib 0.2.19

Flatland3 remote game client library (TCP session, bots, game state)
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

//! Client keybind settings (`assets/config/client-settings.yaml`).

use std::path::PathBuf;

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ClientSettings {
    #[serde(default = "default_version")]
    pub version: String,
    #[serde(default)]
    pub keys: ClientKeyBindings,
}

fn default_version() -> String {
    "1".into()
}

impl Default for ClientSettings {
    fn default() -> Self {
        Self {
            version: default_version(),
            keys: ClientKeyBindings::default(),
        }
    }
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ClientKeyBindings {
    #[serde(default = "default_target_t1")]
    pub target_t1: String,
    #[serde(default = "default_target_t2")]
    pub target_t2: String,
    #[serde(default = "default_auto_t1")]
    pub auto_t1: String,
    #[serde(default = "default_auto_t2")]
    pub auto_t2: String,
    #[serde(default = "default_loadout")]
    pub loadout_menu: String,
    #[serde(default = "default_rotation_editor")]
    pub rotation_editor: String,
    #[serde(default = "default_dodge")]
    pub dodge: String,
    #[serde(default = "default_lunge")]
    pub lunge: String,
    #[serde(default = "default_block")]
    pub block: String,
    #[serde(default = "default_clear_t1")]
    pub clear_target_t1: String,
    #[serde(default = "default_clear_t2")]
    pub clear_target_t2: String,
    /// Legacy client-local hotbar ability ids (unused for play casting — server persists hotbar).
    #[serde(default = "default_hotbar")]
    pub hotbar: Vec<Option<String>>,
}

fn default_target_t1() -> String {
    "Tab".into()
}
fn default_target_t2() -> String {
    "Shift+Tab".into()
}
fn default_auto_t1() -> String {
    "r".into()
}
fn default_auto_t2() -> String {
    "Shift+r".into()
}
fn default_loadout() -> String {
    "l".into()
}
fn default_rotation_editor() -> String {
    "o".into()
}
fn default_dodge() -> String {
    "c".into()
}
fn default_lunge() -> String {
    "Shift+Space".into()
}
fn default_block() -> String {
    "q".into()
}
fn default_clear_t1() -> String {
    "0".into()
}
fn default_clear_t2() -> String {
    "Shift+0".into()
}
fn default_hotbar() -> Vec<Option<String>> {
    Vec::new()
}

impl Default for ClientKeyBindings {
    fn default() -> Self {
        Self {
            target_t1: default_target_t1(),
            target_t2: default_target_t2(),
            auto_t1: default_auto_t1(),
            auto_t2: default_auto_t2(),
            loadout_menu: default_loadout(),
            rotation_editor: default_rotation_editor(),
            dodge: default_dodge(),
            lunge: default_lunge(),
            block: default_block(),
            clear_target_t1: default_clear_t1(),
            clear_target_t2: default_clear_t2(),
            hotbar: default_hotbar(),
        }
    }
}

impl ClientKeyBindings {
    /// Legacy lookup for `keys.hotbar` — unused for play (server-persisted hotbar on GameState).
    pub fn hotbar_ability(&self, slot_1_to_9: u8) -> Option<&str> {
        if !(1..=9).contains(&slot_1_to_9) {
            return None;
        }
        self.hotbar
            .get((slot_1_to_9 - 1) as usize)
            .and_then(|a| a.as_deref())
            .filter(|id| !id.is_empty())
    }
}

fn find_settings_path() -> PathBuf {
    let manifest = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
    for ancestor in manifest.ancestors() {
        let candidate = ancestor.join("assets/config/client-settings.yaml");
        if candidate.is_file() {
            return candidate;
        }
    }
    PathBuf::from("assets/config/client-settings.yaml")
}

pub fn load_client_settings() -> ClientSettings {
    let path = find_settings_path();
    let Ok(raw) = std::fs::read_to_string(&path) else {
        return ClientSettings::default();
    };
    serde_yaml::from_str(&raw).unwrap_or_default()
}