From c0186cc9bf9e350410c2db3cc50476ea6304a344 Mon Sep 17 00:00:00 2001 From: ExLin Date: Mon, 6 Jun 2022 22:05:47 +0600 Subject: [PATCH 1/2] changed the structure; added showAvatarInfoList, avatarInfoList, propMap descriptions; --- api.md | 39 ++++++++++++++++++++++++++++++++------- 1 file changed, 32 insertions(+), 7 deletions(-) diff --git a/api.md b/api.md index 8649a73..4cced85 100644 --- a/api.md +++ b/api.md @@ -14,22 +14,47 @@ For example https://enka.network/u/700378769/__data.json ### playerInfo -| Name | Desciption | +| Name | Description | | :--- | :--------- | | nickname | Player Nickname | | signature | Profile Signature | | worldLevel | Player World Level | | namecardId | Profile Namecard ID | -| finishAchievementNum | Number of Completed Achievments | +| finishAchievementNum | Number of Completed Achievements | | towerFloorIndex | Abyss Floor | | towerLevelIndex | Abyss Floor's Level | -| showAvatarInfoList | List of Charaters ID and Level | -| showNameCardIdList | List of Namecards ID | -| profilePicture.avatarID | Charater ID of Profile Picture | +| [showAvatarInfoList](#showavatarinfolist) | List of Character IDs and Levels | +| showNameCardIdList | List of Namecard IDs | +| profilePicture.avatarID | Character ID of Profile Picture | + +#### showAvatarInfoList + +| Name | Description | +| :--- | :--------- | +| avatarId | Character ID | +| level | Character Level | + +### avatarInfoList + +| 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"` | + +### propMap + +| Name | Description | +| :--- | :--------- | +| type | ID of Property Type, Check the [Definitions for IDs](#prop) | +| ival | Ignore it | +| val | Value of Property | ## Definitions -### PropMap +### Prop | Type | Description | | :--: | :---------- | @@ -37,7 +62,7 @@ For example https://enka.network/u/700378769/__data.json | 1002 | Ascension | | 4001 | Level | -### FightPropMap +### FightProp | Type | Description | | :--: | :---------- | From 1ba0ef77a3de712e407310a05facb9f39253fda5 Mon Sep 17 00:00:00 2001 From: ExLin Date: Tue, 7 Jun 2022 00:16:37 +0600 Subject: [PATCH 2/2] some corrections; added equipList, weapon, reliquary, flat descriptions; --- api.md | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 56 insertions(+), 8 deletions(-) diff --git a/api.md b/api.md index 4cced85..387b17e 100644 --- a/api.md +++ b/api.md @@ -7,13 +7,15 @@ For example https://enka.network/u/700378769/__data.json ## Data Structure Info -| Name | Description | +| Name | Description | :--- | :---------- | | [playerInfo](#playerinfo) | Profile Info | | [avatarInfoList](#avatarinfolist) | List of detailed information for every character from showcase | ### playerInfo +For any additional info, check the [Characters Data](https://github.com/Dimbreath/GenshinData/blob/master/ExcelBinOutput/AvatarExcelConfigData.json) incuding IDs and other stuff. + | Name | Description | | :--- | :--------- | | nickname | Player Nickname | @@ -23,11 +25,11 @@ 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-avatarinfo) | List of Character IDs and Levels | | showNameCardIdList | List of Namecard IDs | | profilePicture.avatarID | Character ID of Profile Picture | -#### showAvatarInfoList +#### showAvatarInfoList - AvatarInfo | Name | Description | | :--- | :--------- | @@ -40,11 +42,14 @@ For example https://enka.network/u/700378769/__data.json | :--- | :---------- | | 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,47 @@ 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) including 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 | +| weaponStats `[Weapon Only]`| Weapon Stats | +| reliquaryMainstat `[Artifact Only]` | Artifact Main Stat | +| reliquarySubstats `[Artifact Only]` | Arifact Substats | +| itemType | Equipment Type: Weapon or Artifact| +| icon | Equipment Icon Name | +| [equipType](#equiptype) `[Artifact Only]` | Artifact Type | + ## Definitions ### Prop @@ -99,4 +145,6 @@ 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 | + +### EquipType