dnd-character 0.18.1

A Dungeons and Dragons character generator
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
#[cfg(feature = "api")]
pub mod api;

pub mod abilities;
pub mod classes;

use abilities::AbilityScore;
use anyhow::bail;
use lazy_static::lazy_static;
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
use std::cmp::Ordering;
use std::collections::HashMap;
use std::fmt;
use std::sync::{Arc, Mutex};

use crate::abilities::Abilities;
use crate::classes::Classes;

#[cfg(feature = "serde")]
mod abilities_score_serde {
    use crate::abilities::Abilities;
    use serde::{Deserialize, Deserializer, Serialize, Serializer};
    use std::sync::{Arc, Mutex};

    pub fn serialize<S>(abilities: &Arc<Mutex<Abilities>>, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        abilities.lock().unwrap().serialize(serializer)
    }

    pub fn deserialize<'de, D>(deserializer: D) -> Result<Arc<Mutex<Abilities>>, D::Error>
    where
        D: Deserializer<'de>,
    {
        let abilities = Abilities::deserialize(deserializer)?;
        Ok(Arc::new(Mutex::new(abilities)))
    }
}

#[cfg(feature = "serde")]
mod classes_serde {
    use crate::abilities::Abilities;
    use crate::classes::Classes;
    use serde::de::Error;
    use serde::{Deserialize, Deserializer, Serialize, Serializer};
    use std::sync::{Arc, Mutex};

    pub fn serialize<S>(classes: &Classes, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        classes.serialize(serializer)
    }

    pub fn deserialize<'de, D>(
        deserializer: D,
        abilities_ref: &Arc<Mutex<Abilities>>,
    ) -> Result<Classes, D::Error>
    where
        D: Deserializer<'de>,
    {
        // First deserialize into a serde_json::Value
        let value = serde_json::Value::deserialize(deserializer)
            .map_err(|e| D::Error::custom(format!("Failed to deserialize classes: {}", e)))?;

        // Use the custom deserializer that takes the shared abilities reference
        Classes::deserialize_with_abilities(value, abilities_ref.clone())
            .map_err(|e| D::Error::custom(format!("Failed to deserialize with abilities: {}", e)))
    }
}

lazy_static! {
    pub static ref GRAPHQL_API_URL: String = std::env::var("DND_GRAPHQL_API_URL")
        .unwrap_or_else(|_| "https://www.dnd5eapi.co/graphql/2014".to_string());
}

#[derive(Debug)]
pub struct UnexpectedAbility;

impl fmt::Display for UnexpectedAbility {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "The ability isn't present in the character's abilities")
    }
}

impl std::error::Error for UnexpectedAbility {}

#[derive(Debug)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
#[cfg_attr(feature = "serde", serde(from = "CharacterDeserializeHelper"))]
pub struct Character {
    /// Indexes from https://www.dnd5eapi.co/api/classes/
    pub classes: Classes,
    pub name: String,
    pub age: u16,
    /// Index from https://www.dnd5eapi.co/api/races/
    pub race_index: String,
    /// Index from https://www.dnd5eapi.co/api/subraces/
    pub subrace_index: String,
    /// Index from https://www.dnd5eapi.co/api/alignments/
    pub alignment_index: String,
    /// Physical description
    pub description: String,
    /// Index from https://www.dnd5eapi.co/api/backgrounds/
    pub background_index: String,
    /// Background description
    pub background_description: String,

    experience_points: u32,

    pub money: u32,

    #[cfg_attr(feature = "serde", serde(with = "abilities_score_serde"))]
    #[cfg_attr(feature = "utoipa", schema(value_type = Abilities))]
    pub abilities_score: Arc<Mutex<Abilities>>,

    //Health related stuff
    pub hp: u16,
    #[serde(default = "default_hit_dice")]
    pub hit_dice_result: u16,

    pub inventory: HashMap<String, u16>,

    pub other: Vec<String>,
}

/// For parsing legacy support
fn default_hit_dice() -> u16 {
    12
}

#[cfg(feature = "serde")]
#[derive(Deserialize)]
#[serde(rename_all = "camelCase")]
struct CharacterDeserializeHelper {
    name: String,
    age: u16,
    race_index: String,
    subrace_index: String,
    alignment_index: String,
    description: String,
    background_index: String,
    background_description: String,
    experience_points: u32,
    money: u32,
    abilities_score: Abilities,
    hp: u16,
    #[serde(default = "default_hit_dice")]
    hit_dice_result: u16,
    inventory: HashMap<String, u16>,
    other: Vec<String>,
    #[serde(default)]
    classes: serde_json::Value,
}

#[cfg(feature = "serde")]
impl From<CharacterDeserializeHelper> for Character {
    fn from(helper: CharacterDeserializeHelper) -> Self {
        // Create the shared abilities reference
        let abilities_score = Arc::new(Mutex::new(helper.abilities_score));

        // Deserialize classes with the shared abilities reference
        let classes =
            match Classes::deserialize_with_abilities(helper.classes, abilities_score.clone()) {
                Ok(classes) => classes,
                Err(_) => Classes::default(),
            };

        Self {
            classes,
            name: helper.name,
            age: helper.age,
            race_index: helper.race_index,
            subrace_index: helper.subrace_index,
            alignment_index: helper.alignment_index,
            description: helper.description,
            background_index: helper.background_index,
            background_description: helper.background_description,
            experience_points: helper.experience_points,
            money: helper.money,
            abilities_score,
            hp: helper.hp,
            hit_dice_result: helper.hit_dice_result,
            inventory: helper.inventory,
            other: helper.other,
        }
    }
}

#[cfg(feature = "utoipa")]
pub mod utoipa_addon {
    use utoipa::openapi::OpenApi;
    use utoipa::{Modify, PartialSchema, ToSchema};

    pub struct ApiDocDndCharacterAddon;

    impl Modify for ApiDocDndCharacterAddon {
        fn modify(&self, openapi: &mut OpenApi) {
            if let Some(components) = openapi.components.as_mut() {
                components.schemas.insert(
                    super::classes::ClassProperties::name().to_string(),
                    super::classes::ClassProperties::schema(),
                );
                components.schemas.insert(
                    super::classes::ClassSpellCasting::name().to_string(),
                    super::classes::ClassSpellCasting::schema(),
                );
                components.schemas.insert(
                    super::classes::Class::name().to_string(),
                    super::classes::Class::schema(),
                );
                components
                    .schemas
                    .insert(super::Classes::name().to_string(), super::Classes::schema());
                components.schemas.insert(
                    super::classes::UsableSlots::name().to_string(),
                    super::classes::UsableSlots::schema(),
                );
                components.schemas.insert(
                    super::Abilities::name().to_string(),
                    super::Abilities::schema(),
                );
                components.schemas.insert(
                    super::abilities::AbilityScore::name().to_string(),
                    super::abilities::AbilityScore::schema(),
                );
                components.schemas.insert(
                    super::Character::name().to_string(),
                    super::Character::schema(),
                );
            }
        }
    }
}

const LEVELS: [u32; 19] = [
    300, 900, 2_700, 6_500, 14_000, 23_000, 34_000, 48_000, 64_000, 85_000, 100_000, 120_000,
    140_000, 165_000, 195_000, 225_000, 265_000, 305_000, 355_000,
];

impl Character {
    pub fn new(
        main_class: String,
        name: String,
        age: u16,
        race_index: String,
        subrace_index: String,
        alignment_index: String,
        description: String,
        background_index: String,
        background_description: String,
    ) -> Self {
        // Create the shared abilities reference
        let abilities_score = Arc::new(Mutex::new(Abilities::default()));

        // Create classes with the default implementation
        let mut classes = Classes::new(main_class);

        // Update all class properties to use the shared abilities reference
        for class in classes.0.values_mut() {
            class.1.abilities = abilities_score.clone();
        }

        Self {
            classes,
            name,
            age,
            race_index,
            subrace_index,
            alignment_index,
            description,
            background_index,
            background_description,
            experience_points: 0,
            money: 20,
            inventory: HashMap::new(),

            abilities_score,
            hp: 0,
            hit_dice_result: 0,
            other: vec![],
        }
    }

    pub fn class_armor(&self) -> i8 {
        // Get the first class and its name
        let first_class = self.classes.0.iter().next().unwrap();
        let class_name = first_class.0.as_str();

        let abilities_score = self.abilities_score.lock().unwrap();

        // Calculate the base armor class based on the class type
        let mut base = match class_name {
            "monk" => {
                10 + abilities_score.dexterity.modifier(0) + abilities_score.wisdom.modifier(0)
            }
            "sorcerer" => 13 + abilities_score.dexterity.modifier(0),
            "barbarian" => {
                10 + abilities_score.dexterity.modifier(0)
                    + abilities_score.constitution.modifier(0)
            }
            _ => 10 + abilities_score.dexterity.modifier(0),
        };

        // Check if the character has the "Fighting Style: Defense" feature
        let has_defense_style = first_class
            .1
            .1
            .fighting_style
            .as_ref()
            .map(|s| s.contains("defense"))
            .unwrap_or(false)
            || first_class
                .1
                .1
                .additional_fighting_style
                .as_ref()
                .map(|s| s.contains("defense"))
                .unwrap_or(false);

        // Add bonus if the character has the defense fighting style
        if has_defense_style {
            base += 1;
        }

        base
    }

    /// Return current level of the character
    pub fn level(&self) -> u8 {
        LEVELS
            .iter()
            .filter(|&&x| x <= self.experience_points)
            .count() as u8
            + 1
    }

    /// Returns the experience points of the character
    pub fn experience_points(&self) -> u32 {
        self.experience_points
    }

    /// Returns the number of levels the character has earned
    /// this means that you should add the returned value to a class level (this must be done manually to permit multiclassing)
    /// # Arguments
    /// * `experience` - The experience points to add to the character
    pub fn add_experience(&mut self, experience: u32) -> u8 {
        //Save the level before adding experience
        let previous_level = self.level();

        // Limit the experience gotten to the experience needed to reach the next level
        let experience_to_add = LEVELS
            .get(self.level() as usize - 1)
            .map_or(experience, |&next_level_points| {
                (next_level_points - self.experience_points).min(experience)
            });

        //Add the experience
        self.experience_points += experience_to_add;

        //Save the level after adding experience
        let current_level = self.level();

        //Return the number of levels earned
        current_level - previous_level
    }

    pub fn remove_item(
        &mut self,
        item: &str,
        amount: Option<u16>,
    ) -> anyhow::Result<(), anyhow::Error> {
        if let Some(quantity) = self.inventory.get_mut(item) {
            let quantity_to_remove = amount.unwrap_or(*quantity);

            if *quantity <= quantity_to_remove {
                self.inventory.remove(item);
            } else {
                *quantity -= quantity_to_remove;
            }
        } else {
            bail!("Item not found")
        }

        Ok(())
    }

    pub fn add_item(&mut self, item: &str, amount: u16) {
        if let Some(quantity) = self.inventory.get_mut(item) {
            *quantity += amount;
        } else {
            self.inventory.insert(item.to_string(), amount);
        }
    }

    pub fn alter_item_quantity(&mut self, item: &str, amount: i32) -> anyhow::Result<()> {
        match amount.cmp(&0) {
            Ordering::Greater => {
                self.add_item(item, amount as u16);
                Ok(())
            }
            Ordering::Less => self.remove_item(item, Some(amount.unsigned_abs() as u16)),
            Ordering::Equal => {
                bail!("Cannot alter quantity to 0")
            }
        }
    }

    /// Calculate the maximum HP of the character based on constitution modifier and hit dice result
    pub fn max_hp(&self) -> u16 {
        let constitution_modifier = self
            .abilities_score
            .lock()
            .unwrap()
            .constitution
            .modifier(0);

        (constitution_modifier as i32)
            .saturating_mul(self.level().into())
            .saturating_add(self.hit_dice_result.into())
            .max(0) as u16
    }
}