character-wizard-cli 0.6.0

Native level-1 SRD character creation CLI
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

//! Validated runtime rule records supplied by external data packs.

use serde::{Deserialize, Serialize};

use crate::domain::Size;

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
#[serde(deny_unknown_fields)]
pub struct PackSpecies {
    pub id: String,
    pub name: String,
    pub sizes: Vec<Size>,
    pub speed: u8,
    #[serde(default)]
    pub darkvision_range: Option<u8>,
    #[serde(default)]
    pub traits: Vec<String>,
}

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
#[serde(deny_unknown_fields)]
pub struct PackBackground {
    pub id: String,
    pub name: String,
    pub abilities: Vec<String>,
    pub skills: Vec<String>,
    pub feat: String,
    pub tool: String,
    #[serde(default)]
    pub magic_initiate_list: Option<String>,
    pub equipment: Vec<PackEquipmentGrant>,
    #[serde(default)]
    pub equipment_gold: u16,
    #[serde(default = "default_background_gold_alternative")]
    pub gold_alternative: u16,
}

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
#[serde(deny_unknown_fields)]
pub struct PackClass {
    pub id: String,
    pub name: String,
    pub hit_die: u8,
    pub saving_throws: Vec<String>,
    pub skill_count: usize,
    pub skills: Vec<String>,
    #[serde(default)]
    pub armor_training: Vec<String>,
    #[serde(default)]
    pub weapon_training: Vec<String>,
    pub equipment: Vec<PackEquipmentGrant>,
    #[serde(default)]
    pub equipment_gold: u16,
    pub starting_gold: u16,
    pub features: Vec<String>,
    #[serde(default)]
    pub weapon_mastery_count: usize,
    #[serde(default)]
    pub choices: Vec<PackClassChoice>,
    #[serde(default)]
    pub resources: Vec<PackClassResource>,
    #[serde(default)]
    pub spellcasting: Option<PackClassSpellcasting>,
}

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
#[serde(deny_unknown_fields)]
pub struct PackClassChoice {
    pub id: String,
    pub label: String,
    pub count: usize,
    pub options: Vec<PackClassChoiceOption>,
}

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
#[serde(deny_unknown_fields)]
pub struct PackClassChoiceOption {
    pub id: String,
    pub name: String,
    #[serde(default)]
    pub description: Option<String>,
}

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
#[serde(deny_unknown_fields)]
pub struct PackClassResource {
    pub name: String,
    pub maximum: i16,
    pub unit: String,
    pub recovery: String,
    #[serde(default)]
    pub detail: Option<String>,
}

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
#[serde(deny_unknown_fields)]
pub struct PackClassSpellcasting {
    pub ability: String,
    pub spell_list: String,
    #[serde(default)]
    pub cantrip_count: usize,
    #[serde(default)]
    pub prepared_spell_count: usize,
    #[serde(default)]
    pub spell_slots: u8,
    pub slot_recovery: String,
}

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
#[serde(deny_unknown_fields)]
pub struct PackEquipmentGrant {
    #[serde(default)]
    pub name: Option<String>,
    #[serde(default)]
    pub equipment_id: Option<String>,
    #[serde(default = "default_equipment_quantity")]
    pub quantity: u16,
}

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
#[serde(deny_unknown_fields)]
pub struct PackEquipment {
    pub id: String,
    pub name: String,
    pub kind: PackEquipmentKind,
}

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
#[serde(tag = "type", rename_all = "snake_case", deny_unknown_fields)]
pub enum PackEquipmentKind {
    Gear,
    Ammunition,
    Shield {
        armor_class_bonus: i16,
    },
    Armor {
        category: String,
        base_ac: i16,
        #[serde(default)]
        dexterity_cap: Option<i16>,
        #[serde(default)]
        strength_requirement: Option<u8>,
    },
    Weapon {
        category: String,
        kind: String,
        #[serde(default)]
        properties: Vec<String>,
        mastery: String,
        damage: String,
        damage_type: String,
        normal_range: u16,
        #[serde(default)]
        long_range: Option<u16>,
        #[serde(default)]
        versatile_damage: Option<String>,
    },
}

#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
#[serde(deny_unknown_fields)]
pub struct PackSpell {
    pub id: String,
    pub name: String,
    pub level: u8,
    pub school: String,
    pub lists: Vec<String>,
    pub casting_time: String,
    pub range: String,
    pub components: Vec<String>,
    #[serde(default)]
    pub material: Option<String>,
    #[serde(default)]
    pub concentration: bool,
    #[serde(default)]
    pub ritual: bool,
    pub notes: String,
    #[serde(default)]
    pub tags: Vec<String>,
}

const fn default_equipment_quantity() -> u16 {
    1
}

const fn default_background_gold_alternative() -> u16 {
    50
}