skyhelper-networth v1.18.7

SkyHelper-Networth

About

SkyHelper's Networth Calculation as a Node.js module to calculate a player's SkyBlock networth by using their profile data provided by the Hypixel API.

Installation

npm install skyhelper-networth

Networth Calculation

The following list shows how much each modifier counts towards an item's worth

Items:

• Enrichments: 50%
• Farming for Dummies: 50%
• Wood Singularity: 50%
• Art of War: 60%
• Fuming Potato Books: 60%
• Gemstone Slot Unlocks (only crimson armor): 60%
• Popular Runes: 60%
  • Music, Enchanting, and Grand Searing Runes only
• Transmission Tuners: 70%
• Essence: 75%
• Silex: 75%
• Art of Peace: 80%
• Jalapeno Book: 80%
• Mana Disintegrator: 80%
• Recombobulators: 80%
  • Bonemerangs: 40%
• Thunder In A Bottle: 80%
• Enchantments: 85%
  • Counter Strike: 20%
  • Big Brain, Inferno, Overload, and Soul Eater: 35%
  • Fatal Tempo: 65%
• Shen's Auction Price Paid: 85%
• Dyes: 90%
• Gemstone Chambers: 90%
• Attributes: 100%
  • Based off the corresponding attribute shard's price
  • Lava Fishing rods and Crimson Hunter set use their base item's price instead
  • Kuudra Armor sets use the average sale value of all types with the same attribute
• Drill Upgrades: 100%
• Etherwarp Conduit: 100%
• Dungeon Master Stars: 100%
• Gemstones: 100%
• Hot Potato Books: 100%
• Necron Blade Scrolls: 100%
• Prestige Item: 100%
• Reforges: 100%
• Winning Bid: 100%

Pets:

• Pet Item: 100%
• Pet Candied: -35%
  • Except Ender Dragon, Golden Dragon, and Scatha

Functions

getNetworth()

Returns the networth of a profile

Arguments

getPreDecodedNetworth()

Returns the networth of a profile using pre-decoded items (used to save resources if you already have decoded the profile's inventories)

Arguments

options

getItemNetworth()

Returns the networth of an item

Arguments

options

getPrices()

Returns the prices used in the networth calculation, optimally this can be cached and used when calling getNetworth

Example Usage

Calculate Networth:

const { getNetworth } = require('skyhelper-networth');

const profile = // Retrieved from the Hypixel API with the /v2/skyblock/profiles endpoint: profiles[index]
const museumData = // Retrieved from the Hypixel API with the /v2/skyblock/museum endpoint: museum.members[uuid]

const profileData = profile.members['<UUID HERE>'];
const bankBalance = profile.banking?.balance;

const networth = await getNetworth(profileData, bankBalance, { v2Endpoint: true, museumData });
console.log(networth);

Calculate Networth using pre-decoded items:

const { getPreDecodedNetworth } = require('skyhelper-networth');

const profile = // Retrieved from the Hypixel API with the /v2/skyblock/profiles endpoint: profiles[index]
const museumData = // Retrieved from the Hypixel API with the /v2/skyblock/museum endpoint: museum.members[uuid]

const profileData = profile.members['<UUID HERE>'];
const bankBalance = profile.banking?.balance;

const parsedInventoryExample = NBT.simplify(await NBT.parse(Buffer.from(profileData.inventory.inv_contents, 'base64')));
const items = { inventory: parsedInventoryExample, ... }; // Parsed inventories see ./examples/items.json for object format and required keys

const networth = await getPreDecodedNetworth(profileData, items, bankBalance, { v2Endpoint: true });
console.log(networth);

Retrieve prices and calculate Networth: Note: Prices are cached for 5 minutes by default. Retrieving prices before is not needed for most users

const { getNetworth, getPrices } = require('skyhelper-networth');

let prices = await getPrices();
setInterval(async () => {
	prices = await getPrices();
}, 1000 * 60 * 5); // Retrieve prices every 5 minutes

const profile = // Retrieved from the Hypixel API with the /v2/skyblock/profiles endpoint: profiles[index]
const museumData = // Retrieved from the Hypixel API with the /v2/skyblock/museum endpoint: museum.members[uuid]

const profileData = profile.members['<UUID HERE>'];
const bankBalance = profile.banking?.balance;

const networth = await getNetworth(profileData, bankBalance, { v2Endpoint: true, prices, museumData });
console.log(networth);