diff --git a/api.md b/api.md index 4cced85..e6fc82e 100644 --- a/api.md +++ b/api.md @@ -14,6 +14,8 @@ For example https://enka.network/u/700378769/__data.json ### playerInfo +For any additional info, check the [Characters Data](https://github.com/Dimbreath/GenshinData/blob/master/ExcelBinOutput/AvatarExcelConfigData.json), includes IDs and other stuff. + | Name | Description | | :--- | :--------- | | nickname | Player Nickname | @@ -23,28 +25,31 @@ For example https://enka.network/u/700378769/__data.json | finishAchievementNum | Number of Completed Achievements | | towerFloorIndex | Abyss Floor | | towerLevelIndex | Abyss Floor's Level | -| [showAvatarInfoList](#showavatarinfolist) | List of Character IDs and Levels | +| [showAvatarInfoList](#showavatarinfolist-showavatarinfo) | List of Character IDs and Levels | | showNameCardIdList | List of Namecard IDs | | profilePicture.avatarID | Character ID of Profile Picture | -#### showAvatarInfoList +#### showAvatarInfoList - ShowAvatarInfo | Name | Description | | :--- | :--------- | | avatarId | Character ID | | level | Character Level | -### avatarInfoList +### avatarInfoList - AvatarInfo | Name | Description | | :--- | :---------- | | avatarID | Character ID | | [propMap](#propmap) | Character Info Properties List | -| fightPropMap | Map of Character's Combat Properties `{id: value}`. [Definitions for IDs](#fightprop)| -| skillDepotId | Charater Skill Set ID. [Additional Data](https://github.com/Dimbreath/GenshinData/blob/master/ExcelBinOutput/AvatarSkillDepotExcelConfigData.json) -> `"id"`| -| inherentProudSkillList | List of Unlocked Skill Ids. [Additional Data](https://github.com/Dimbreath/GenshinData/blob/master/ExcelBinOutput/AvatarSkillDepotExcelConfigData.json) -> `"inherentProudSkillOpens"` | +| fightPropMap -> `{id: value}` | Map of Character's Combat Properties.
Check the [Definitions for IDs](#fightprop)| +| skillDepotId | Character Skill Set ID
[Skills Data](https://github.com/Dimbreath/GenshinData/blob/master/ExcelBinOutput/AvatarSkillDepotExcelConfigData.json) -> `"id"`| +| inherentProudSkillList | List of Unlocked Skill Ids
[Skills Data](https://github.com/Dimbreath/GenshinData/blob/master/ExcelBinOutput/AvatarSkillDepotExcelConfigData.json) -> `"inherentProudSkillOpens"` | +| skillLevelMap -> `{skill_id: level}`| Map of Skill Levels
[Skills Data](https://github.com/Dimbreath/GenshinData/blob/master/ExcelBinOutput/AvatarSkillDepotExcelConfigData.json) -> `"inherentProudSkillOpens"` | +| [equipList](#equiplist-equip) | List of Equipments: Weapon, Ariftacts | +| fetterInfo.expLevel | Character Friendship Level | -### propMap +#### propMap | Name | Description | | :--- | :--------- | @@ -52,6 +57,55 @@ For example https://enka.network/u/700378769/__data.json | ival | Ignore it | | val | Value of Property | +#### equipList - Equip + +| Name | Description | +| :--- | :--------- | +| itemId | Equipment ID
[Equipments Data](https://raw.githubusercontent.com/Dimbreath/GenshinData/master/ExcelBinOutput/GadgetExcelConfigData.json) -> `"id"` | +| [weapon](#weapon) `[Weapon Only]` | Weapon Base Info | +| [reliquary](#reliquary) `[Artifact Only]` | Artifact Base Info | +| [flat](#flat) | Detailed Info of Equipment | + +#### weapon + +| Name | Description | +| :--- | :---------- | +| level | Weapon Level | +| promoteLevel | Weapon Ascension Level | +| affixMap | Weapon Refinement Level `[0-4]` | + + +#### reliquary + +| Name | Description | +| :--- | :---------- | +| level | Artifact Level `[1-21]` | +| mainPropId | Artifact Main Stat ID
[MainProps Data](https://github.com/Dimbreath/GenshinData/blob/master/ExcelBinOutput/ReliquaryMainPropExcelConfigData.json) | + +#### flat + +For any additional info about names, descriptions and etc, check the [TextMap Data](https://github.com/Dimbreath/GenshinData/tree/master/TextMap), includes any languages supported by game. + +| Name | Description | +| :--- | :---------- | +| nameTextHashMap | Hash for Equipment Name | +| setNameTextHashMap `[Artifact Only]`| Hash for Artifact Set Name | +| rankLevel | Rarity Level of Equipment | +| [reliquaryMainstat](#reliquarymainstat-reliquarysubstats-weaponstats) `[Artifact Only]` | Artifact Main Stat | +| [reliquarySubstats](#reliquarymainstat-reliquarysubstats-weaponstats) `[Artifact Only]` | List of Artifact Substats | +| [weaponStats](#reliquarymainstat-reliquarysubstats-weaponstats) `[Weapon Only]`| List of Weapon Stat: Base ATK, Substat | +| [itemType](#itemtype) | Equipment Type: Weapon or Artifact| +| icon | Equipment Icon Name | +| [equipType](#equiptype) `[Artifact Only]` | Artifact Type | + +#### reliquaryMainstat, reliquarySubstats, weaponStats + +| Name | Description | +| :--- | :---------- | +| mainPropId / appendPropID | Equipment Append Property Name. Check the [Definitions for Names](#appendprop)| +| propValue | Property Value | + + ## Definitions ### Prop @@ -99,4 +153,45 @@ For example https://enka.network/u/700378769/__data.json | 76 | Geo Energy Cost | | 2000 | Max HP | | 2001 | ATK | -| 2002 | DEF | \ No newline at end of file +| 2002 | DEF | + +### ItemType + +| Name | Description | +| :--- | :---------- | +| ITEM_WEAPON | Weapon | +| ITEM_RELIQUARY | Artifact | + +### EquipType + +| Name | Description | +| :--- | :---------- | +| EQUIP_BRACER | Flower | +| EQUIP_NECKLACE | Feather | +| EQUIP_SHOES | Sands | +| EQUIP_RING | Goblet | +| EQUIP_DRESS | Circlet | + +### AppendProp + +| Name | Description | +| :--- | :---------- | +| FIGHT_PROP_BASE_ATTACK `[Weapon]` | Base ATK | +| FIGHT_PROP_HP | Flat HP | +| FIGHT_PROP_ATTACK | Flat ATK | +| FIGHT_PROP_DEFENSE | Flat DEF | +| FIGHT_PROP_HP_PERCENT | HP% | +| FIGHT_PROP_ATTACK_PERCENT | ATK% | +| FIGHT_PROP_DEFENSE_PERCENT | DEF% | +| FIGHT_PROP_CRITICAL | Crit RATE | +| FIGHT_PROP_CRITICAL_HURT | Crit DMG | +| FIGHT_PROP_CHARGE_EFFICIENCY | Energy Recharge | +| FIGHT_PROP_HEAL_ADD | Healing Bonus | +| FIGHT_PROP_ELEMENT_MASTERY | Elemental Mastery | +| FIGHT_PROP_PHYSICAL_ADD_HURT | Physical DMG Bonus | +| FIGHT_PROP_FIRE_ADD_HURT | Pyro DMG Bonus | +| FIGHT_PROP_ELEC_ADD_HURT | Electro DMG Bonus | +| FIGHT_PROP_WATER_ADD_HURT | Hydro DMG Bonus | +| FIGHT_PROP_WIND_ADD_HURT | Anemo DMG Bonus | +| FIGHT_PROP_ICE_ADD_HURT | Cryo DMG Bonus | +| FIGHT_PROP_ROCK_ADD_HURT | Geo DMG Bonus | \ No newline at end of file