mr-ice / maptool-macros

place for maptool macros
2 stars 3 forks source link

Need to read additional character data #290

Open trey-kirk-sp opened 3 years ago

trey-kirk-sp commented 3 years ago

New fangled character sheet will have places to fill in additional character data, like proficiencies and background. DNDBeyond should try to populate those on the token where it can. While I'm working on the CharSheet, this will be a running tally of what to add.

[h: PROP_BACKGROUND = "dnd5e.token.background"]
[h: PROP_SUBCLASS = "dnd5e.token.subclass"]
[h: PROP_ALIGNMENT = "dnd5e.token.alignment"]
[h: PROP_EXPERIENCE_POINTS = "dnd5e.token.experiencePoints"]
[h: PROP_INSPIRATION = "dnd5e.token.inspiration"]
[h: PROP_ARMOR_PROF = "dnd5e.token.armorProficiencies"]
[h: PROP_WEAPON_PROF = "dnd5e.token.weaponProficiencies"]
[h: PROP_TOOL_PROF = "dnd5e.token.toolProficiencies"]
[h: PROP_EQUIPEMENT = "dnd5e.token.equipment"]
[h: PROP_CURRENCY = "dnd5e.token.currency"]
trey-kirk-sp commented 3 years ago

dnd5e.token.currency: Will be an object with each key being the abbreviations and each entry using gold as the standard. This format is compatible with the Equipment object.

{
    "PP": {
        "name": "Platinum",
        "quantity": 52,
        "value": 10,
        "weight": 0.02,
        "container": "" (This can be empty or the key of any other item in the Equipment object)
    }, "EP"..., "GP"..., "SP"..., "CP"...
}

dnd5e.token.equipment: As already mentioned, the Currency object is a compatible format to the Equipement object. Equipment may have additional fields, as required.

{
    "Lantern": {
        "name": "Lantern",  (Name will likely always match the field)
        "quantity": 1,
        "value": 5,
        "weight": 3,
        "container": "Backpack",
        "description": "Shows the stuff you wanna be looking at",
        "type": "Gear" (Could be 'Armor', 'Weapon', 'Shield', 'PMD', 'Potion'; whatever),
        "slot": "" (Nullable; for things that care about slots),
        "equippped": 0, (Only items that are equippable would be)
        "carried": 1,  (Use 'false' for items that are claimed but not carried, like Melma)
        "attuned": 0
    }
}

Weapons and armor may have additional fields. Will likely define a sub-class for them.

trey-kirk-sp commented 3 years ago

Use this issue to also shore up dnd5e Constants and standardize where we should use them. For instance, "attackExpressionJSON" should be a constant and various places throughout DNDBeyond, D&D, and CharSheet should be updated to call the constant.

This will be fun!