hypixel-sdk 0.2.1

Async client for the Hypixel Public API with typed models and SkyBlock helpers
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

use std::collections::HashMap;

use serde::{Deserialize, Serialize};
use serde_json::Value;

use super::common::JsonObject;

/// A network game definition, as returned by `resources/games`.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct Game {
    #[serde(default)]
    pub id: i32,
    #[serde(default)]
    pub name: String,
    #[serde(rename = "databaseName", default)]
    pub database_name: String,
    #[serde(rename = "modeNames", default)]
    pub mode_names: HashMap<String, String>,
    #[serde(default)]
    pub retired: bool,
    #[serde(default)]
    pub legacy: bool,
}

/// The SkyBlock skills resource from `resources/skyblock/skills`.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct SkillsResource {
    #[serde(default)]
    pub version: String,
    #[serde(default)]
    pub skills: HashMap<String, Skill>,
}

/// A single skill's definition, including its per-level XP table.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct Skill {
    #[serde(default)]
    pub name: String,
    #[serde(default)]
    pub description: String,
    #[serde(rename = "maxLevel", default)]
    pub max_level: i32,
    #[serde(default)]
    pub levels: Vec<SkillLevel>,
}

/// One tier within a [`Skill`]'s level table.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct SkillLevel {
    #[serde(default)]
    pub level: i32,
    #[serde(rename = "totalExpRequired", default)]
    pub total_exp_required: f64,
    #[serde(default)]
    pub unlocks: Vec<String>,
}

/// A SkyBlock item definition from `resources/skyblock/items`.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct SkyBlockItem {
    #[serde(default)]
    pub id: String,
    #[serde(default)]
    pub material: Option<String>,
    #[serde(default)]
    pub name: Option<String>,
    #[serde(default)]
    pub tier: Option<String>,
    #[serde(default)]
    pub npc_sell_price: Option<f64>,
    #[serde(default)]
    pub category: Option<String>,
    #[serde(flatten)]
    pub extra: JsonObject,
}

/// The SkyBlock collections resource from `resources/skyblock/collections`.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct CollectionsResource {
    #[serde(default)]
    pub version: String,
    #[serde(default)]
    pub collections: HashMap<String, Value>,
}

/// An active resource pack from `resources/packs`.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct ResourcePack {
    #[serde(default)]
    pub id: String,
    #[serde(rename = "deployId", default)]
    pub deploy_id: String,
    #[serde(rename = "lastUpdated", default)]
    pub last_updated: i64,
    #[serde(default)]
    pub versions: Vec<ResourcePackVersion>,
    #[serde(flatten)]
    pub extra: JsonObject,
}

/// One built version of a [`ResourcePack`].
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct ResourcePackVersion {
    #[serde(rename = "packFormat", default)]
    pub pack_format: i32,
    #[serde(default)]
    pub hash: String,
    #[serde(default)]
    pub url: String,
    #[serde(flatten)]
    pub extra: JsonObject,
}

/// The current SkyBlock mayor and election state from `resources/skyblock/election`.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct ElectionResource {
    #[serde(default)]
    pub mayor: Option<Value>,
    #[serde(default)]
    pub current: Option<Value>,
}

#[derive(Debug, Clone, Deserialize)]
pub(crate) struct GamesResponse {
    #[serde(default)]
    pub games: HashMap<String, Game>,
}

#[derive(Debug, Clone, Deserialize)]
pub(crate) struct ItemsResponse {
    #[serde(default)]
    pub items: Vec<SkyBlockItem>,
}

#[derive(Debug, Clone, Deserialize)]
pub(crate) struct PacksResponse {
    #[serde(default)]
    pub packs: Vec<ResourcePack>,
}