Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Resolving issues #1, #2, and #4 #3

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 35 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,47 @@
# Net Worth
The Net Worth data file consists of two types of entries. Entries are some value in the player's profile that will contribure to their net worth. Direct entries are values that will be directly added (ie coins). Tiered entries have a value associated per tier and accumulate from all previous values. Tiered entries also have an offset that will be added to the value read from the location. The value will be mapped to the index in the array. In the event the index is out of bounds, the sum will stand as all previous values up until there is no more data.
The Net Worth data file consists of three types of entries. Entries are some value in the player's profile that will contribute to their net worth. Direct entries are values that will be directly added (ie coins). Tiered entries have a value associated per tier and accumulate from all previous values. Tiered entries also have an offset that will be added to the value read from the location. The value will be mapped to the index in the array. In the event the index is out of bounds, the sum will stand as all previous values up until there is no more data. Single purchase entries are entries that can be purchase one time for a set amount of coins.

## Naming
All entries for each type are named beginning with `stats`, followed by the name of the game, followed by the category the entry belongs to in the hypixel shop menu (If it is a part of 2 categories like "Kits & Perks" and "Normal Kits" for the Armorer kit in skywars, only use the most relevant category. It would be "Normal Kits" in this case.), finally followed by the name of the entry. (everything is lower case)
Here are some examples: `stats.hungergames.advancedkits.astronaut`, `stats.skywars.normalkits.armorer`, `stats.bedwars.victorydances.dragonrider`.

## Contributing
If you would like to contribute, please add entries and open a pull request.

## Example
Example for each type of entry:
```
{
"direct": [
"stats.Arcade.coins"
"stats.arcade.coins"
],
"tiered": {
"stats.HungerGames.astronaut": {
"offset": 1,
"values": [
0,
80,
400,
1000,
3000,
12000,
50000,
100000,
250000,
1000000
]
}
"hungergames": {
"advancedkits": {
"astronaut": {
"offset": 1,
"values": [
0,
80,
400,
1000,
3000,
12000,
50000,
100000,
250000,
1000000
]
}
}
}
},
"single": {
"bedwars": {
"projectiletrails": {
"firework": 25000
}
}
}
}
```
Expand Down
43 changes: 27 additions & 16 deletions data.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,32 @@
"stats.BuildBattle.coins",
"stats.Duels.coins"
],
"tiered": {
"stats.HungerGames.astronaut": {
"offset": 1,
"values": [
0,
80,
400,
1000,
3000,
12000,
50000,
100000,
250000,
1000000
]
"tiered": {
"hungergames": {
"advancedkits": {
"astronaut": {
"offset": 1,
"values": [
0,
80,
400,
1000,
3000,
12000,
50000,
100000,
250000,
1000000
]
}
}
}
},
"single": {
"bedwars": {
"projectiletrails": {
"firework": 25000
}
}
}
}
}