ds4/src/module/config.ts

export const DS4 = {
    // ASCII Artwork
    ASCII: String.raw`_____________________________________________________________________________________________
 ____  _   _ _   _  ____ _____ ___  _   _ ____  _        _ __   _______ ____  ____    _  _
|  _ \| | | | \ | |/ ___| ____/ _ \| \ | / ___|| |      / \\ \ / / ____|  _ \/ ___|  | || |
| | | | | | |  \| | |  _|  _|| | | |  \| \___ \| |     / _ \\ V /|  _| | |_) \___ \  | || |_
| |_| | |_| | |\  | |_| | |__| |_| | |\  |___) | |___ / ___ \| | | |___|  _ < ___) | |__   _|
|____/ \___/|_| \_|\____|_____\___/|_| \_|____/|_____/_/   \_\_| |_____|_| \_\____/     |_|
=============================================================================================`,

    /**
     * A dictionary of dictionaries each mapping keys to localized strings.
     * To be filled with the localizations derived from i18nKeys.
     */
    i18n: {
        // to be filled with the localized mappings from i18nKeys
    },
    /**
     * A dictionary of dictionaries each mapping keys to localization keys.
     */
    i18nKeys: {
        /**
         * Define the set of acttack types that can be performed with weapon items
         */
        attackTypes: {
            melee: "DS4.AttackTypeMelee",
            ranged: "DS4.AttackTypeRanged",
            meleeRanged: "DS4.AttackTypeMeleeRanged",
        },

        /**
         * Define the set of item availabilties
         */
        itemAvailabilities: {
            unset: "DS4.ItemAvailabilityUnset",
            hamlet: "DS4.ItemAvailabilityHamlet",
            village: "DS4.ItemAvailabilityVilage",
            city: "DS4.ItemAvailabilityCity",
            elves: "DS4.ItemAvailabilityElves",
            dwarves: "DS4.ItemAvailabilityDwarves",
            nowhere: "DS4.ItemAvailabilityNowhere",
        },

        /**
         * Define the set of item types
         */
        itemTypes: {
            weapon: "DS4.ItemTypeWeapon",
            armor: "DS4.ItemTypeArmor",
            shield: "DS4.ItemTypeShield",
            spell: "DS4.ItemTypeSpell",
            trinket: "DS4.ItemTypeTrinket",
            equipment: "DS4.ItemTypeEquipment",
            talent: "DS4.ItemTypeTalent",
            racialAbility: "DS4.ItemTypeRacialAbility",
            language: "DS4.ItemTypeLanguage",
            alphabet: "DS4.ItemTypeAlphabet",
            specialCreatureAbility: "DS4.ItemTypeSpecialCreatureAbility",
        },

        /**
         * Define the set of armor types, a character may only wear one item of each at any given time
         */
        armorTypes: {
            body: "DS4.ArmorTypeBody",
            helmet: "DS4.ArmorTypeHelmet",
            vambrace: "DS4.ArmorTypeVambrace",
            greaves: "DS4.ArmorTypeGreaves",
            vambraceGreaves: "DS4.ArmorTypeVambraceGreaves",
        },

        /**
         * Define abbreviations for the armor types
         */
        armorTypesAbbr: {
            body: "DS4.ArmorTypeBodyAbbr",
            helmet: "DS4.ArmorTypeHelmetAbbr",
            vambrace: "DS4.ArmorTypeVambraceAbbr",
            greaves: "DS4.ArmorTypeGreavesAbbr",
            vambraceGreaves: "DS4.ArmorTypeVambraceGreavesAbbr",
        },

        /**
         * Define the set of armor materials, used to determine if a characer may wear the armor without additional penalties
         */
        armorMaterialTypes: {
            cloth: "DS4.ArmorMaterialTypeCloth",
            leather: "DS4.ArmorMaterialTypeLeather",
            chain: "DS4.ArmorMaterialTypeChain",
            plate: "DS4.ArmorMaterialTypePlate",
        },

        /**
         * Define the abbreviations of armor materials
         */
        armorMaterialTypesAbbr: {
            cloth: "DS4.ArmorMaterialTypeClothAbbr",
            leather: "DS4.ArmorMaterialTypeLeatherAbbr",
            chain: "DS4.ArmorMaterialTypeChainAbbr",
            plate: "DS4.ArmorMaterialTypePlateAbbr",
        },

        spellTypes: {
            spellcasting: "DS4.SpellTypeSpellcasting",
            targetedSpellcasting: "DS4.SpellTypeTargetedSpellcasting",
        },

        spellCategories: {
            healing: "DS4.SpellCategoryHealing",
            fire: "DS4.SpellCategoryFire",
            ice: "DS4.SpellCategoryIce",
            light: "DS4.SpellCategoryLight",
            darkness: "DS4.SpellCategoryDarkness",
            mindAffecting: "DS4.SpellCategoryMindAffecting",
            electricity: "DS4.SpellCategoryElectricity",
            none: "DS4.SpellCategoryNone",
            unset: "DS4.SpellCategoryUnset",
        },

        /**
         * Define the set of actor types
         */
        actorTypes: {
            character: "DS4.ActorTypeCharacter",
            creature: "DS4.ActorTypeCreature",
        },

        /**
         * Define the set of attributes an actor has
         */
        attributes: {
            body: "DS4.AttributeBody",
            mobility: "DS4.AttributeMobility",
            mind: "DS4.AttributeMind",
        },

        /**
         * Define the set of traits an actor has
         */
        traits: {
            strength: "DS4.TraitStrength",
            agility: "DS4.TraitAgility",
            intellect: "DS4.TraitIntellect",
            constitution: "DS4.TraitConstitution",
            dexterity: "DS4.TraitDexterity",
            aura: "DS4.TraitAura",
        },

        /**
         * Define the set of combat values an actor has
         */
        combatValues: {
            hitPoints: "DS4.CombatValuesHitPoints",
            defense: "DS4.CombatValuesDefense",
            initiative: "DS4.CombatValuesInitiative",
            movement: "DS4.CombatValuesMovement",
            meleeAttack: "DS4.CombatValuesMeleeAttack",
            rangedAttack: "DS4.CombatValuesRangedAttack",
            spellcasting: "DS4.CombatValuesSpellcasting",
            targetedSpellcasting: "DS4.CombatValuesTargetedSpellcasting",
        },

        /**
         * Define the base info of a character
         */
        characterBaseInfo: {
            race: "DS4.CharacterBaseInfoRace",
            class: "DS4.CharacterBaseInfoClass",
            heroClass: "DS4.CharacterBaseInfoHeroClass",
            culture: "DS4.CharacterBaseInfoCulture",
        },

        /**
         * Define the progression info of a character
         */
        characterProgression: {
            level: "DS4.CharacterProgressionLevel",
            experiencePoints: "DS4.CharacterProgressionExperiencePoints",
            talentPoints: "DS4.CharacterProgressionTalentPoints",
            progressPoints: "DS4.CharacterProgressionProgressPoints",
        },

        /**
         * Define the language info of a character
         */
        characterLanguage: {
            languages: "DS4.CharacterLanguageLanguages",
            alphabets: "DS4.CharacterLanguageAlphabets",
        },

        /**
         * Define the profile info of a character
         */
        characterProfile: {
            biography: "DS4.CharacterProfileBiography",
            gender: "DS4.CharacterProfileGender",
            birthday: "DS4.CharacterProfileBirthday",
            birthplace: "DS4.CharacterProfileBirthplace",
            age: "DS4.CharacterProfileAge",
            height: "DS4.CharacterProfileHeight",
            hairColor: "DS4.CharacterProfileHairColor",
            weight: "DS4.CharacterProfileWeight",
            eyeColor: "DS4.CharacterProfileEyeColor",
            specialCharacteristics: "DS4.CharacterProfileSpecialCharacteristics",
        },
        /**
         * Define currency elements of a character
         */
        characterCurrency: {
            gold: "DS4.CharacterCurrencyGold",
            silver: "DS4.CharacterCurrencySilver",
            copper: "DS4.CharacterCurrencyCopper",
        },

        /**
         * Define the different creature types a creature can be
         */
        creatureTypes: {
            animal: "DS4.CreatureTypeAnimal",
            construct: "DS4.CreatureTypeConstruct",
            humanoid: "DS4.CreatureTypeHumanoid",
            magicalEntity: "DS4.CreatureTypeMagicalEntity",
            plantBeing: "DS4.CreatureTypePlantBeing",
            undead: "DS4.CreatureTypeUndead",
        },

        /**
         * Define the different size categories creatures fall into
         */
        creatureSizeCategories: {
            tiny: "DS4.CreatureSizeCategoryTiny",
            small: "DS4.CreatureSizeCategorySmall",
            normal: "DS4.CreatureSizeCategoryNormal",
            large: "DS4.CreatureSizeCategoryLarge",
            huge: "DS4.CreatureSizeCategoryHuge",
            colossal: "DS4.CreatureSizeCategoryColossal",
        },

        /**
         * Define the base info of a creature
         */
        creatureBaseInfo: {
            loot: "DS4.CreatureBaseInfoLoot",
            foeFactor: "DS4.CreatureBaseInfoFoeFactor",
            creatureType: "DS4.CreatureBaseInfoCreatureType",
            sizeCategory: "DS4.CreatureBaseInfoSizeCategory",
            experiencePoints: "DS4.CreatureBaseInfoExperiencePoints",
            description: "DS4.CreatureBaseInfoDescription",
        },

        /**
         * Define translations for available distance units
         */
        distanceUnits: {
            meter: "DS4.UnitMeters",
            kilometer: "DS4.UnitKilometers",
            custom: "DS4.UnitCustom",
        },
        /**
         * Define abbreviations for available distance units
         */
        distanceUnitsAbbr: {
            meter: "DS4.UnitMetersAbbr",
            kilometer: "DS4.UnitKilometersAbbr",
            custom: "DS4.UnitCustomAbbr",
        },

        /**
         * Define translations for available distance units
         */
        temporalUnits: {
            rounds: "DS4.UnitRounds",
            minutes: "DS4.UnitMinutes",
            hours: "DS4.UnitHours",
            days: "DS4.UnitDays",
            custom: "DS4.UnitCustom",
        },

        /**
         * Define abbreviations for available units
         */
        temporalUnitsAbbr: {
            rounds: "DS4.UnitRoundsAbbr",
            minutes: "DS4.UnitMinutesAbbr",
            hours: "DS4.UnitHoursAbbr",
            days: "DS4.UnitDaysAbbr",
            custom: "DS4.UnitCustomAbbr",
        },

        /**
         * Define localization strings for Chat Visibility
         */
        chatVisibilities: {
            roll: "DS4.ChatVisibilityRoll",
            gmroll: "DS4.ChatVisibilityGmRoll",
            blindroll: "DS4.ChatVisibilityBlindRoll",
            selfroll: "DS4.ChatVisibilitySelfRoll",
        },
    },

    /**
     * A dictionary of dictionaries mapping keys to icon file paths.
     */
    icons: {
        /**
         * Define the file paths to icon images
         */
        attackTypes: {
            melee: "systems/ds4/assets/icons/official/combat-values/melee-attack.png",
            meleeRanged: "systems/ds4/assets/icons/official/combat-values/melee-ranged-attack.png",
            ranged: "systems/ds4/assets/icons/official/combat-values/ranged-attack.png",
        },

        /**
         * Define the file paths to icon images
         */
        spellTypes: {
            spellcasting: "systems/ds4/assets/icons/official/combat-values/spellcasting.png",
            targetedSpellcasting: "systems/ds4/assets/icons/official/combat-values/targeted-spellcasting.png",
        },
    },

    /**
     * Define the profile info types for handlebars of a character
     */
    characterProfileDTypes: {
        biography: "String",
        gender: "String",
        birthday: "String",
        birthplace: "String",
        age: "Number",
        height: "Number",
        hairColor: "String",
        weight: "Number",
        eyeColor: "String",
        specialCharacteristics: "String",
    },
};