Skip to content
This repository has been archived by the owner on Nov 1, 2024. It is now read-only.

Commit

Permalink
Merge pull request #32 from CubeEdge-Studios/stats-update
Browse files Browse the repository at this point in the history 
Update hive-bedrock-data and docs
  • Loading branch information
@UCDFiddes
UCDFiddes authored Apr 20, 2024
2 parents c799df3 + f462c13 commit 9026199
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 48 deletions.
76 changes: 50 additions & 26 deletions docs/API.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -264,32 +264,36 @@ const { data, error } = await getPlayerInformation("player");

PlayerInfo object structure

| Field | Type | Description |
| -------------------------- | ---------------- | ----------------------------------------------------------- |
| UUID | `string` | The player's UUID |
| xuid | `number` | The player's XUID (Xbox User ID) |
| username | `string` | The player's username |
| username_cc | `string` | The player's correctly capitalised username |
| rank | `Rank` | The player's [rank](API.md#player-ranks) |
| first_played | `number` | The unix timestamp when the player first played on The Hive |
| daily_login_streak | `number` | The player's current daily login streak |
| longest_daily_login_streak | `number` | The player's longest daily login streak |
| hub_title_count | `number` | How many hub titles the player currently owns |
| hub_title_unlocked | `string[]` | All of the player's owned hub titles |
| costume_count | `number` | How many costumes the player currently owns |
| costume_unlocked | `string[]` | All of the player's owned costumes' names |
| avatar_count | `number` | How many avatars the player currently owns |
| avatar_unlocked | `Avatar[]` | All of the player's owned [avatars](API.md#avatar) |
| friend_count | `number` | How many friends the player has got on the server |
| equipped_hub_title | `string \| null` | The player's currently equipped hub title |
| equipped_costume | `string \| null` | The player's currently equipped costume's name |
| equipped_avatar | `AVATAR \| null` | The player's currently equipped [avatar](API.md#avatar) |
| quest_count | `number` | How many quests the player has ever completed |
| paid_ranks | `Avatar[]` | All of the player's paid [ranks](API.md#player-ranks) |
| pets | `string[]` | All of the player's owned pets' names |
| mounts | `string[]` | All of the player's owned mounts' names |
| hats | `string[]` | All of the player's owned hats' names |
| backblings | `string[]` | All of the player's owned backblings' names |
| Field | Type | Description |
| -------------------------- | --------------------- | ------------------------------------------------------------- |
| UUID | `string` | The player's UUID |
| xuid | `number` | The player's XUID (Xbox User ID) |
| username | `string` | The player's username |
| username_cc | `string` | The player's correctly capitalised username |
| rank | `Rank` | The player's [rank](API.md#player-ranks) |
| first_played | `number` | The unix timestamp when the player first played on The Hive |
| daily_login_streak | `number` | The player's current daily login streak |
| longest_daily_login_streak | `number` | The player's longest daily login streak |
| friend_count | `number` | How many friends the player has got on the server |
| quest_count | `number` | How many quests the player has ever completed |
| paid_ranks | `Avatar[]` | All of the player's paid [ranks](API.md#player-ranks) |
| pets | `string[]` | All of the player's owned pets' names |
| mounts | `string[]` | All of the player's owned mounts' names |
| hub_title_count | `number` | How many hub titles the player currently owns |
| hub_title_unlocked | `string[]` | All of the player's owned hub titles |
| equipped_hub_title | `string \| null` | The player's currently equipped hub title |
| costume_count | `number` | How many costumes the player currently owns |
| costume_unlocked | `string[]` | All of the player's owned costumes' names |
| equipped_costume | `string \| null` | The player's currently equipped costume's name |
| avatar_count | `number` | How many avatars the player currently owns |
| avatar_unlocked | `Avatar[]` | All of the player's owned [avatars](API.md#avatar) |
| equipped_avatar | `Avatar \| null` | The player's currently equipped [avatar](API.md#avatar) |
| hat_count | `number` | How many hats the player currently owns |
| hat_unlocked | `Hat[] \| null` | All of the player's owned [hats](API.md#hat) |
| equipped_hat | `Hat \| null` | The player's currently equipped [hat](API.md#hat) |
| backbling_count | `number` | How many backblings the player currently owns |
| cosmetic.backbling | `Backbling[] \| null` | All of the player's owned [backblings](API.md#backbling) |
| equipped_backbling | `Backbling \| null` | The player's currently equipped [backbling](API.md#backbling) |

## Avatar

Expand All @@ -300,6 +304,26 @@ The structure of the avatar object.
| name | `string` | The name of the avatar |
| url | `string` | The URL of the avatar's image |

## Backbling

The structure of the backbling object.

| Field | Type | Description |
| ------ | -------- | -------------------------------- |
| name | `string` | The name of the backbling |
| icon | `string` | The URL of the backbling's image |
| rarity | `string` | The URL of the backbling's image |

## Hat

The structure of the hat object.

| Field | Type | Description |
| ------ | -------- | -------------------------- |
| name | `string` | The name of the hat |
| icon | `string` | The URL of the hat's image |
| rarity | `string` | The URL of the hat's image |

## Game Metadata

Infomation about level and prestige data.
Expand Down
43 changes: 23 additions & 20 deletions docs/GAMES.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,26 +117,29 @@ Fields which are only present in _All-Time statistics_, _Monthly statistics_, or

## Survival Games

| Field | Type | Description |
| -------------- | -------- | ----------------------------------------------------------------------------------------------- |
| UUID | `string` | _Only when getting all-time stats or leaderboards_ - The UUID of the player |
| index | `number` | _Only when getting monthly stats or leaderboards_ - The index |
| human_index | `number` | _Only when getting monthly stats or leaderboards_ - The human index |
| username | `string` | _Only when getting monthly stats or leaderboards_ - The player's correctly capitalised username |
| id | `string` | The ID of the game (`sg` in this case) |
| xp | `number` | Total XP of the player |
| level | `number` | Current level (calculated by the wrapper) |
| played | `number` | How many times the player has played this game |
| first_played | `number` | _Only when getting all-time stats_ - The unix timestamp the player first played this game |
| victories | `number` | The number of times the player has won this game |
| losses | `number` | The number of times the player has lost this game |
| win_percentage | `number` | The percentage of wins to total amount of games played |
| kdr | `number` | Ratio of kills to deaths |
| deaths | `number` | How many times the player has died in this game |
| kills | `number` | How many other players the player has killed in this game |
| crates | `number` | How many crates the player has opened |
| deathmatches | `number` | How many deathmatches the player has reached |
| cows | `number` | How many cache cows the player has found |
| Field | Type | Description |
| ---------------- | -------- | ----------------------------------------------------------------------------------------------- |
| UUID | `string` | _Only when getting all-time stats or leaderboards_ - The UUID of the player |
| index | `number` | _Only when getting monthly stats or leaderboards_ - The index |
| human_index | `number` | _Only when getting monthly stats or leaderboards_ - The human index |
| username | `string` | _Only when getting monthly stats or leaderboards_ - The player's correctly capitalised username |
| id | `string` | The ID of the game (`sg` in this case) |
| xp | `number` | Total XP of the player |
| level | `number` | Current level (calculated by the wrapper) |
| played | `number` | How many times the player has played this game |
| first_played | `number` | _Only when getting all-time stats_ - The unix timestamp the player first played this game |
| victories | `number` | The number of times the player has won this game |
| losses | `number` | The number of times the player has lost this game |
| win_percentage | `number` | The percentage of wins to total amount of games played |
| kdr | `number` | Ratio of kills to deaths |
| deaths | `number` | How many times the player has died in this game |
| kills | `number` | How many other players the player has killed in this game |
| crates | `number` | How many crates the player has opened |
| deathmatches | `number` | How many deathmatches the player has reached |
| cows | `number` | How many cache cows the player has found |
| teleporters_used | `number` | How many teleporters the player has used |
| flares_used | `number` | How many flares the player has used |
| launchpads_used | `number` | How many launchpads the player has used |

## Skywars

Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "hive-bedrock-api",
"version": "2.0.2",
"version": "2.0.3",
"description": "An API wrapper for the Hive Minecraft Bedrock Edition server.",
"main": "lib/index.js",
"types": "lib/index.d.ts",
Expand All @@ -11,7 +11,7 @@
"license": "MIT",
"author": "Cubeedge Studios",
"dependencies": {
"hive-bedrock-data": "1.1.9"
"hive-bedrock-data": "^1.1.12"
},
"scripts": {
"prepack": "yarn build",
Expand Down

0 comments on commit 9026199

Please sign in to comment.