dfraw_json_parser 0.17.5

Library which parses Dwarf Fortress raw files into JSON
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

use serde::{Deserialize, Serialize};

/// The tokens for the tree parser
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, Default, specta::Type)]
pub enum TreeToken {
    /// A tree
    Tree,
    /// The name of the tree
    TrunkName,
    /// The maximum height of the trunk
    MaxTrunkHeight,
    /// The maximum diameter of the trunk
    MaxTrunkDiameter,
    /// The period of the trunk
    TrunkPeriod,
    /// The period of the trunk width
    TrunkWidthPeriod,
    /// The name of the branches
    BranchName,
    /// The density of the branches
    BranchDensity,
    /// The radius of the branches
    BranchRadius,
    /// The name of the heavy branches
    HeavyBranchesName,
    /// The density of the heavy branches
    HeavyBranchDensity,
    /// The radius of the heavy branches
    HeavyBranchRadius,
    /// The branching of the heavy branches
    TrunkBranching,
    /// The name of the roots
    RootName,
    /// The density of the roots
    RootDensity,
    /// The radius of the roots
    RootRadius,
    /// The name of the twigs
    TwigsName,
    /// Twigs are placed on the side of the branches
    TwigsSideBranches,
    /// Twigs are placed above the branches
    TwigsAboveBranches,
    /// Twigs are placed below the branches
    TwigsBelowBranches,
    /// Twigs are placed on the side of heavy branches
    TwigsSideHeavyBranches,
    /// Twigs are placed above heavy branches
    TwigsAboveHeavyBranches,
    /// Twigs are placed below heavy branches
    TwigsBelowHeavyBranches,
    /// Twigs are placed on the side of the trunk
    TwigsSideTrunk,
    /// Twigs are placed above the trunk
    TwigsAboveTrunk,
    /// Twigs are placed below the trunk
    TwigsBelowTrunk,
    /// The name of the tree canopy
    CapName,
    /// The period of the tree canopy
    CapPeriod,
    /// The radius of the tree canopy
    CapRadius,
    /// The tile to use for the tree
    TreeTile,
    /// The tile to use for a dead tree
    DeadTreeTile,
    /// The tile to use for a sapling
    SaplingTile,
    /// The tile to use for a dead sapling
    DeadSaplingTile,
    /// The color of the tree
    TreeColor,
    /// The color of a dead tree
    DeadTreeColor,
    /// The color of a sapling
    SaplingColor,
    /// The color of a dead sapling
    DeadSaplingColor,
    /// The level at which the spling will drown (in water)
    SaplingDrownLevel,
    /// The level at which the tree will drown (in water)
    TreeDrownLevel,
    // Actual Tags
    /// The tree has a rounded cap-hood like a giant mushroom. This severely stunts a tree's maximum height (known bug)
    TreeHasMushroomCap,
    /// Uses the standard names for the tree components (roots, trunk, branches, etc.)
    StandardTileNames,
    /// Makes young versions of the tree be called "[tree name] sapling"; otherwise, they are called "young [tree name]".
    Sapling,
    /// An unknown tree token
    #[default]
    Unknown,
}

/// The placement of twigs on a tree
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, Default, specta::Type)]
pub enum TwigPlacement {
    /// Twigs are placed on the side of the tree
    SideBranches,
    /// Twigs are placed above the tree
    AboveBranches,
    /// Twigs are placed below the tree
    BelowBranches,
    /// Twigs are placed on the side of heavy branches
    SideHeavyBranches,
    /// Twigs are placed above heavy branches
    AboveHeavyBranches,
    /// Twigs are placed below heavy branches
    BelowHeavyBranches,
    /// Twigs are placed on the side of the trunk
    SideTrunk,
    /// Twigs are placed above the trunk
    AboveTrunk,
    /// Twigs are placed below the trunk
    BelowTrunk,
    /// An unknown twig placement
    #[default]
    Unknown,
}