schema.json

{
    "$schema": "http://json-schema.org/draft-06/schema",
    "$id": "https://github.com/StardustD2/Destiny-2-Character-Stats/blob/main/schema.json",
    "definitions": {
        "CharacterStats": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "Mobility": {
                    "$ref": "#/definitions/Mobility"
                },
                "Resilience": {
                    "$ref": "#/definitions/Resilience"
                },
                "Recovery": {
                    "$ref": "#/definitions/Recovery"
                },
                "Discipline": {
                    "$ref": "#/definitions/Generic"
                },
                "Intellect": {
                    "$ref": "#/definitions/Intellect"
                },
                "Strength": {
                    "$ref": "#/definitions/Generic"
                }
            },
            "required": [
                "Discipline",
                "Intellect",
                "Mobility",
                "Recovery",
                "Resilience",
                "Strength"
            ],
            "title": "CharacterStats"
        },
        "Description": {
            "type": "string",
            "description": "Contains a locale ID that you can use to grab the description for the item in your selected language. The ID is provided in a [key].[value] format where there can be an arbitrary number of keys (though it'll be 2-3 at most). Then you can use these keys and values to query the <./locale/[language code].json> files for the desired description. These descriptions are intended to be surfaced to users of apps using the data in this repository and provide crucial context to the values shown to them."
        },
        "Ability": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "Hash": {
                    "type": "integer",
                    "description": "D2 Manifest inventoryItem hash"
                },
                "Name": {
                    "type": "string",
                    "description": "For organization purposes only. Does not necessarily match the inventoryItem entry name from the D2 Manifest."
                },
                "Cooldowns": {
                    "type": "array",
                    "items": {
                        "type": "number"
                    },
                    "minItems": 11,
                    "maxItems": 11,
                    "description": "Array index represents the Character Stat tier. Cooldowns are in seconds. Rounded to 2 decimal points. Note: Rounding to 2 decimal places is solely for improving math precision when combined with Override objects. When displaying these cooldown times, it is strongly recommended to round them to an integer."
                },
                "ChunkEnergyScalar": {
                    "type": "number",
                    "description": "Abilities receive different amounts of 'chunk energy' from things like mods and other sources depending on their base cooldown. So let's say an armor mod gives you 10% grenade energy when popping your class ability — you'd multiply that 10% by the number listed here to arrive at the final amount you'll actually receive. An user-facing explanation of this property is available at the top level of the CharacterStat object under <ChunkEnergyScalarDescription>."
                },
                "ChargeBasedScaling": {
                    "type": "array",
                    "items": {
                        "type": "number"
                    },
                    "minItems": 1,
                    "description": "Represents the behavior of certain abilities possessing additional scaling on their cooldown depending on the number of stored ability charges. The array's length represents the number of charges an ability has intrinsically. Numbers at every array index represent the Charge Rate scalar for the ability with [index] number of stored ability charges. As this is a Charge Rate scalar, cooldown times can be calculated by dividing the times in the <Cooldowns> member of <Ability> objects by the scalars in this array. Do note that this is not a required member of Ability objects and will only be present if an ability has multiple charges. (Therefore, if this property is absent, it is to be assumed that the ability only has a single charge by default) An user-facing explanation of this property is available at the top level of the CharacterStat object under <ChargeBasedScalingDescription>."
                }
            },
            "required": [
                "Hash",
                "Name",
                "Cooldowns",
                "ChunkEnergyScalar"
            ],
            "title": "Ability"
        },
        "Override": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "Hash": {
                    "type": "integer",
                    "description": "D2 Manifest inventoryItem hash"
                },
                "Name": {
                    "type": "string",
                    "description": "For organization purposes only. Does not necessarily match the inventoryItem entry name from the D2 Manifest."
                },
                "Requirements": {
                    "type": "array",
                    "items": {
                        "type": "integer"
                    },
                    "minItems": 1,
                    "description": "The inventoryItem hash of each ability that is required to trigger the effects of this <Override>. Only overrides <Abilities> under the same Character Stat as the <Override>. Any one of these will trigger its effect defined in the other <Override> properties. Wildcards: if the requirements array only contains 1 item and it's a 0, any ability tied to this Character Stat will have its cooldown overwritten. Negative numbers in the array indicate filters, these will be the inventoryItem hashes of subclasses multiplied by -1. Any abilities tied to the given subclass will have their cooldowns overwritten."
                },
                "CooldownOverride": {
                    "type": "array",
                    "items": {
                        "type": "number"
                    },
                    "minItems": 11,
                    "maxItems": 11,
                    "description": "Array index represents the Character Stat tier. Cooldowns are in seconds. Rounded to 2 decimal points. Overrides the cooldowns of the items listed in the <Requirements> array before the scalar is applied. Identical to the <Cooldowns> array of the <Ability> object."
                },
                "Scalar": {
                    "type": "array",
                    "items": {
                        "type": "number"
                    },
                    "minItems": 1,
                    "description": "Length of the array is equal to the length of the <Requirements> array. Each item represents a multiplier to the cooldown time of the abilities (of a subclass) listed in the <Requirements> array at the same array index. Multiple scalars can stack with each other if their requirements are met (eg. Bastion Aspect and Citan's Ramparts Exotic Gauntlets). If <CooldownOverride> property is specified: <Scalar>s are factored in after <CooldownOverride>s."
                },
                "ChunkEnergyOverride": {
                    "type": "array",
                    "items": {
                        "type": "number"
                    },
                    "minItems": 1,
                    "description": "Length of the array is equal to the length of the <Requirements> array. Each item represents an override of the <ChunkEnergyScalar> property of the abilities (of a subclass) listed in the <Requirements> array at the same array index."
                }
            },
            "anyOf": [
                {"required": ["Hash", "Name", "Requirements", "CooldownOverride"]},
                {"required": ["Hash", "Name", "Requirements", "Scalar"]},
                {"required": ["Hash", "Name", "Requirements", "ChunkEnergyOverride"]}
            ],
            "title": "Override"
        },
        "Generic": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "Description": {
                    "$ref": "#/definitions/Description"
                },
                "Abilities": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Ability"
                    }
                },
                "Overrides": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Override"
                    }
                },
                "ChunkEnergyScalarDescription": {
                    "$ref": "#/definitions/Description",
                    "description": "Contains a description of what Chunk Energy Scalars are. This is only a one part of the whole as the actual <ChunkEnergyScalar> numbers are tied to the <Ability> objects in the <Abilities> array. It's just that the description itself is stored at a higher level to show it's the same for each <Ability>."
                },
                "ChargeBasedScalingDescription": {
                    "$ref": "#/definitions/Description",
                    "description": "Contains a description of what Charge-based Scaling is for abilities. This is only a one part of the whole as the actual <ChargeBasedScaling> numbers are tied to the <Ability> objects in the <Abilities> array. It's just that the description itself is stored at a higher level to show it's the same for each <Ability>."
                }
            },
            "required": [
                "Abilities",
                "Overrides",
                "Description",
                "ChunkEnergyScalarDescription",
                "ChargeBasedScalingDescription"
            ],
            "title": "Generic"
        },
        "SuperAbility":{
            "Hash": {
                "type": "integer",
                "description": "D2 Manifest inventoryItem hash"
            },
            "Name": {
                "type": "string",
                "description": "For organization purposes only. Does not necessarily match the inventoryItem entry name from the D2 Manifest."
            },
            "Cooldowns": {
                "type": "array",
                "items": {
                    "type": "number"
                },
                "minItems": 11,
                "maxItems": 11,
                "description": "Array index represents the Intellect tier. Cooldowns are in seconds. Rounded to 2 decimal places. Note: Rounding to 2 decimal places is solely for improving math precision when combined with Override objects. When displaying these cooldown times, it is STRONGLY recommended to round them to an integer."
            },
            "SuperTier": {
                "type": "integer",
                "description": "This number represents the tier of the super ability and ranges from 1 to 5. Tier 1 recharges the slowest while Tier 5 recharges the fastest. Super tiers are a one-to-one translation of the base cooldowns of a super ability. This is mostly useless for all intents and purposes but does serve the purpose of influencing how much Super Energy you gain from active regen sources. It's an entirely optional value to surface for users but I thought it would be worth including alongside the ActiveRegenScalar property below — which is much more meaningful."
            },
            "ActiveRegenScalar": {
                "type": "number",
                "description": "This number represents the scalar for how much benefit you get from active super regeneration with your super ability. This ranges from 0.8 for a Tier 1 super to 1.2 for a Tier 5 super. Active Regen refers to any source of super energy that isn't just passively waiting for it to recharge. So aside from the normal passive regen and other effects that are 'additional base super regen', these influence everything. Be it collecting orbs of power, killing enemies (including assists), taking and dealing damage, armor mods, this covers everything else."
            },
            "required": [
                "Hash",
                "Name",
                "Cooldowns",
                "SuperTier",
                "ActiveRegenScalar"
            ],
            "title": "SuperAbility"
        },
        "Intellect": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "Description": {
                    "$ref": "#/definitions/Description"
                },
                "SuperAbilities": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/SuperAbility"
                    }
                },
                "Overrides": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Override"
                    }
                },
                "SuperTierDescription": {
                    "$ref": "#/definitions/Description",
                    "description": "Contains a description of what Super Tiers are in case you wish to surface this info to users. This is only a one part of the whole as the actual <SuperTier> numbers are tied to the <SuperAbility> objects in the <SuperAbilities> array. It's just that the description itself is stored at a higher level to show it's the same for each <SuperAbility>."
                },
                "ActiveRegenScalarDescription": {
                    "$ref": "#/definitions/Description",
                    "description": "Contains a description of what Active Super Regen Scalar are. This is only a one part of the whole as the actual <ActiveRegenScalar> numbers are tied to the <SuperAbility> objects in the <SuperAbilities> array. It's just that the description itself is stored at a higher level to show it's the same for each <SuperAbility>."
                }
            },
            "required": [
                "SuperAbilities",
                "Overrides",
                "Description",
                "SuperTierDescription",
                "ActiveRegenScalarDescription"
            ],
            "title": "Intellect"
        },
        "Mobility": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "Description": {
                    "$ref": "#/definitions/Description"
                },
                "WalkSpeed": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "Description": {
                            "$ref": "#/definitions/Description"
                        },
                        "Array": {
                            "type": "array",
                            "items": {
                                "type": "number",
                                "minItems": 11,
                                "maxItems": 11
                            },
                            "description": "Represents how fast you can walk (not sprint) forward in meters per second. Array index represents the Mobility tier. Rounding beyond 2 decimal places is not recommended."
                        }
                    }
                },
                "StrafeSpeed": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "Description": {
                            "$ref": "#/definitions/Description"
                        },
                        "Array": {
                            "type": "array",
                            "items": {
                                "type": "number",
                                "minItems": 11,
                                "maxItems": 11
                            },
                            "description": "Represents how fast you can walk side-to-side and backwards in meters per second (85% of Walking Speed). Array index represents the Mobility tier. Rounding beyond 2 decimal places is not recommended."
                        }
                    }
                },
                "CrouchSpeed": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "Description": {
                            "$ref": "#/definitions/Description"
                        },
                        "Array": {
                            "type": "array",
                            "items": {
                                "type": "number",
                                "minItems": 11,
                                "maxItems": 11
                            },
                            "description": "Represents how fast you can move while crouching in meters per second (55% of Walking Speed). Array index represents the Mobility tier. The speeds are represented in meters per second. Rounding beyond 2 decimal places is not recommended."
                        }
                    }
                },
                "Abilities": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Ability"
                    }
                },
                "Overrides": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Override"
                    }
                },
                "ChunkEnergyScalarDescription": {
                    "$ref": "#/definitions/Description",
                    "description": "Contains a description of what Chunk Energy Scalars are. This is only a one part of the whole as the actual <ChunkEnergyScalar> numbers are tied to the <Ability> objects in the <Abilities> array. It's just that the description itself is stored at a higher level to show it's the same for each <Ability>."
                },
                "ChargeBasedScalingDescription": {
                    "$ref": "#/definitions/Description",
                    "description": "Contains a description of what Charge-based Scaling is for abilities. This is only a one part of the whole as the actual <ChargeBasedScaling> numbers are tied to the <Ability> objects in the <Abilities> array. It's just that the description itself is stored at a higher level to show it's the same for each <Ability>."
                }
            },
            "required": [
                "Abilities",
                "Overrides",
                "CrouchSpeed",
                "StrafeSpeed",
                "WalkSpeed",
                "Description",
                "ChunkEnergyScalarDescription",
                "ChargeBasedScalingDescription"
            ],
            "title": "Mobility"
        },
        "Recovery": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "Description": {
                    "$ref": "#/definitions/Description"
                },
                "TotalRegenTime": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "Description": {
                            "$ref": "#/definitions/Description"
                        },
                        "Array": {
                            "type": "array",
                            "items": {
                                "type": "number",
                                "minItems": 11,
                                "maxItems": 11
                            },
                            "description": "Array index represents the Recovery tier. The numbers represent how many seconds it takes to heal from 0 to full HP. Rounding is not recommended."
                        }
                    }
                },
                "HealthRegenDelay": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "Description": {
                            "$ref": "#/definitions/Description"
                        },
                        "Array": {
                            "type": "array",
                            "items": {
                                "type": "number",
                                "minItems": 11,
                                "maxItems": 11
                            },
                            "description": "Array index represents the Recovery tier. The numbers representhow many seconds after taking damage Health Regeneration starts. Rounding is not recommended. Good to know: <Health> is a fixed 70 HP portion of your Total HP alongside <Shields> which are a 115-130 HP portion of Total HP determined by Resilience."
                        }
                    }
                },
                "HealthRegenSpeed": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "Description": {
                            "$ref": "#/definitions/Description"
                        },
                        "Array": {
                            "type": "array",
                            "items": {
                                "type": "number",
                                "minItems": 11,
                                "maxItems": 11
                            },
                            "description": "Array index represents the Recovery tier. The numbers represent how fast your <Health> regens after the delay. The numbers are provided in % of total <Health> per second (total <Health> is a fixed 70HP). Rounding beyond 1-2 decimal places is not recommended. For all intents and purposes, you can divide the numbers by 100, multiply by 70, and display it as HP/second."
                        }
                    }
                },
                "ShieldRegenDelay": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "Description": {
                            "$ref": "#/definitions/Description"
                        },
                        "Array": {
                            "type": "array",
                            "items": {
                                "type": "number",
                                "minItems": 11,
                                "maxItems": 11
                            },
                            "description": "Array index represents the Recovery tier. The numbers represent how many seconds after taking damage Shield Regeneration starts. Rounding is not recommended. Good to know: Shield health is a 115-130 HP portion of Total HP and is determined by Resilience."
                        }
                    }
                },
                "ShieldRegenSpeed": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "Description": {
                            "$ref": "#/definitions/Description"
                        },
                        "Array": {
                            "type": "array",
                            "items": {
                                "type": "number",
                                "minItems": 11,
                                "maxItems": 11
                            },
                            "description": "Array index represents the Recovery tier. The numbers represent how fast your shields regen after the delay. The numbers are provided in % of total shield health per second (shield health is a 115-130 HP portion of Total HP and is determined by Resilience). Rounding beyond 1-2 decimal places is not recommended. For all intents and purposes, you can take the TotalHP value at a specified Resilience tier and subtract 70 to get the shield health. After that, you can divide the ShieldRegenSpeed numbers by 100, multiply it by the selected shield health, and display it as HP/second. (Though it's probably better to leave it in % to avoid potentially causing confusion for users)"
                        }
                    }
                },
                "Abilities": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Ability"
                    }
                },
                "Overrides": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Override"
                    }
                },
                "ChunkEnergyScalarDescription": {
                    "$ref": "#/definitions/Description",
                    "description": "Contains a description of what Chunk Energy Scalars are. This is only a one part of the whole as the actual <ChunkEnergyScalar> numbers are tied to the <Ability> objects in the <Abilities> array. It's just that the description itself is stored at a higher level to show it's the same for each <Ability>."
                },
                "ChargeBasedScalingDescription": {
                    "$ref": "#/definitions/Description",
                    "description": "Contains a description of what Charge-based Scaling is for abilities. This is only a one part of the whole as the actual <ChargeBasedScaling> numbers are tied to the <Ability> objects in the <Abilities> array. It's just that the description itself is stored at a higher level to show it's the same for each <Ability>."
                }
            },
            "required": [
                "Abilities",
                "Overrides",
                "TotalRegenTime",
                "HealthRegenDelay",
                "HealthRegenTime",
                "ShieldRegenDelay",
                "ShieldRegenTime",
                "Description",
                "ChunkEnergyScalarDescription",
                "ChargeBasedScalingDescription"
            ],
            "title": "Recovery"
        },
        "Resilience": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "Description": {
                    "$ref": "#/definitions/Description"
                },
                "ShieldHP": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "Description": {
                            "$ref": "#/definitions/Description"
                        },
                        "Array": {
                            "type": "array",
                            "items": {
                                "type": "number",
                                "minItems": 11,
                                "maxItems": 11
                            },
                            "description": "Array index represents the Resilience tier. The numbers represent how much HP your <Shields> have at each tier. <Shields> are the 115 to 130 HP 'right-side portion' of your Total HP alongside <Health>. The amount of <Health> you have depends on the activity: 100 HP in most Crucible playlists (excluding Momentum Control and Mayhem) and 70 HP everywhere else."
                        }
                    }
                },
                "PvEDamageResistance": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "Description": {
                            "$ref": "#/definitions/Description"
                        },
                        "Array": {
                            "type": "array",
                            "items": {
                                "type": "number",
                                "minItems": 11,
                                "maxItems": 11
                            },
                            "description": "Array index represents the Resilience tier. The numbers represent the percentage damage resistance granted IN PVE at each tier."
                        }
                    }
                },
                "FlinchResistance": {
                    "type": "object",
                    "additionalProperties": false,
                    "properties": {
                        "Description": {
                            "$ref": "#/definitions/Description"
                        },
                        "Array": {
                            "type": "array",
                            "items": {
                                "type": "number",
                                "minItems": 11,
                                "maxItems": 11
                            },
                            "description": "Array index represents the Resilience tier. The numbers represent the percentage flinch resistance granted at each tier."
                        }
                    }
                },
                "Abilities": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Ability"
                    }
                },
                "Overrides": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Override"
                    }
                },
                "ChunkEnergyScalarDescription": {
                    "$ref": "#/definitions/Description",
                    "description": "Contains a description of what Chunk Energy Scalars are. This is only a one part of the whole as the actual <ChunkEnergyScalar> numbers are tied to the <Ability> objects in the <Abilities> array. It's just that the description itself is stored at a higher level to show it's the same for each <Ability>."
                },
                "ChargeBasedScalingDescription": {
                    "$ref": "#/definitions/Description",
                    "description": "Contains a description of what Charge-based Scaling is for abilities. This is only a one part of the whole as the actual <ChargeBasedScaling> numbers are tied to the <Ability> objects in the <Abilities> array. It's just that the description itself is stored at a higher level to show it's the same for each <Ability>."
                }
            },
            "required": [
                "Description",
                "ShieldHP",
                "PvEDamageResistance",
                "FlinchResistance",
                "Abilities",
                "Overrides",
                "ChunkEnergyScalarDescription",
                "ChargeBasedScalingDescription"
            ],
            "title": "Resilience"
        }
    }
}