celeste_rs 0.5.1

Library for working with files related to Celeste and it's modding scene.
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

use serde::{Deserialize, Serialize};

use crate::saves::{
    def::{FileTime, Strawberries},
    AreaId,
    DashCount,
    DeathCount,
    StrawberryCount,
};

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct Areas {
    #[serde(rename = "AreaStats")]
    #[serde(default)]
    pub(crate) areas: Vec<AreaStats>,
}

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct AreaRef {
    #[serde(rename = "@ID")]
    #[serde(deserialize_with = "serde_aux::field_attributes::deserialize_number_from_string")]
    pub id: u16,
    #[serde(rename = "@Mode")]
    pub mode: AreaModeType,
    /// The SID of the last level played
    ///
    /// This is `None` in a Vanilla session, and is always Some in a modded session.<br>
    /// Modded sessions will always be stored in [CurrentSession_Safe](crate::saves::def::SaveData::current_session_safe) and any vanilla sessions will always be stored in [CurrentSession](crate::saves::def::SaveData::current_session)
    #[serde(rename = "@SID")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sid: Option<String>,
}

#[derive(Serialize, Deserialize, Debug, Clone, Copy)]
pub enum AreaModeType {
    Normal,
    BSide,
    CSide,
}

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct AreaStats {
    #[serde(flatten)]
    pub def: AreaDef,
    #[serde(rename = "Modes")]
    pub modes: Modes,
}
#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct Modes {
    #[serde(rename = "AreaModeStats")]
    pub(crate) modes: Vec<AreaMode>,
}

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct AreaDef {
    #[serde(rename = "@ID")]
    #[serde(deserialize_with = "serde_aux::field_attributes::deserialize_number_from_string")]
    pub id: AreaId,
    #[serde(rename = "@Cassette")]
    #[serde(deserialize_with = "serde_aux::field_attributes::deserialize_number_from_string")]
    pub cassette: bool,
    #[serde(rename = "@SID")]
    /// Is `None` in a non-modded save

    #[serde(skip_serializing_if = "Option::is_none")]
    pub sid: Option<String>,
}

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct AreaMode {
    #[serde(flatten)]
    pub stats: AreaModeStats,
    #[serde(rename = "Strawberries")]
    pub strawberries: Strawberries,
    #[serde(rename = "Checkpoints")]
    pub checkpoints: Checkpoints,
}

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct Checkpoints {
    #[serde(default)]
    #[serde(rename = "string")]
    pub(crate) checkpoints: Vec<String>,
}

#[derive(Serialize, Deserialize, Debug, Clone)]
pub struct AreaModeStats {
    #[serde(rename = "@TotalStrawberries")]
    #[serde(deserialize_with = "serde_aux::field_attributes::deserialize_number_from_string")]
    pub total_strawberries: StrawberryCount,
    #[serde(rename = "@Completed")]
    #[serde(deserialize_with = "serde_aux::field_attributes::deserialize_bool_from_anything")]
    pub completed: bool,
    #[serde(rename = "@SingleRunCompleted")]
    #[serde(deserialize_with = "serde_aux::field_attributes::deserialize_bool_from_anything")]
    pub single_run_completed: bool,
    #[serde(rename = "@FullClear")]
    #[serde(deserialize_with = "serde_aux::field_attributes::deserialize_bool_from_anything")]
    pub full_clear: bool,
    #[serde(rename = "@Deaths")]
    #[serde(deserialize_with = "serde_aux::field_attributes::deserialize_number_from_string")]
    pub deaths: DeathCount,
    #[serde(rename = "@TimePlayed")]
    #[serde(deserialize_with = "serde_aux::field_attributes::deserialize_number_from_string")]
    pub time_played: FileTime,
    #[serde(rename = "@BestTime")]
    #[serde(deserialize_with = "serde_aux::field_attributes::deserialize_number_from_string")]
    pub best_time: FileTime,
    #[serde(rename = "@BestFullClearTime")]
    #[serde(deserialize_with = "serde_aux::field_attributes::deserialize_number_from_string")]
    pub best_full_clear_time: FileTime,
    #[serde(rename = "@BestDashes")]
    #[serde(deserialize_with = "serde_aux::field_attributes::deserialize_number_from_string")]
    pub best_dashes: DashCount,
    #[serde(rename = "@BestDeaths")]
    #[serde(deserialize_with = "serde_aux::field_attributes::deserialize_number_from_string")]
    pub best_deaths: DeathCount,
    #[serde(rename = "@HeartGem")]
    #[serde(deserialize_with = "serde_aux::field_attributes::deserialize_bool_from_anything")]
    pub heart_gem: bool,
}