An enum that'll let you you get a hex color code for a specific Minecraft color formatting sequence.

An enum describing color names and their Minecraft format variants.

An array of the prestiges in SkyWars, listed in order of lowest to highest.

Calculates the BedWars prestige and level of a player and returns a BedwarsLevelInfo interface.

Calculates the total EXP required for a specific network level.

Calculates the guild level and returns a GuildLevel interface.

Calculates the network level and returns a NetworkLevel interface.

Get an PlayerRank object describing the player's rank in more detail without the need to figure out how to parse it yourself.

This helper takes a profile and scans all of it's member's to get the most accurate collection information possible. Returns false is none of the members of the profile had their collections API enabled.

This helper takes a profile member and converts raw skill EXP to skill levels using the skills resources. Returns false is none of the profile member does not have their skills API enabled.

Get SkyWars level information from a Components.Schemas.Player object or raw experience value.

Returns a SkyWarsPrestige object for the level you supplied.

This helper will take a string and remove any of Minecraft's formatting sequence. Useful when parsing item lore or similar elements.

Quick helper function that will help you convert a number to a roman numeral for display purposes.

Returns the total amount of exp it takes to get to a certain level.

This helper will transform NBT data into a typed object using prismarine-nbt. It will also transform any backpacks/bags with item data so you can explore those as well.

This helper will loop over all the possible inventories on a profile and run the transformSkyBlockItemData helper on them, returning the member object with the transformed properties.

If you want built in caching, implementing these methods (or utilitizing an library that includes these methods) is a must. Refer to the cache guide.

Describes the results of the getBedwarsLevelInfo helper.

Possible meta options returned on the meta variable.

Describes the results of the getGuildLevel output object.

Generally shows up on SkyBlock unique potions.

An extremely common NBTTag property containing the name and lore that show up when you hover over the item.

Basic enchantment information for the inventory item.

Extra attributes that appear on extraAttributes property of the NBTTag property. Commonly used to describe items in more detail and their underlying settings.

If the inventory item is a potion, this property will describe the effects of that potion.

The NBT information for a slot in the inventory you are reading.

If the NBTInventoryItem is a skull type this will describe it's skull information.

If an inventory slot contains tag data, this interface describes possible values commonly seen in observations of the inventory data.

Describes the results from a getNetworkLevel function call.

Describes the results from the getPlayerRank helper.

Interface describing an individual collection.

Interface that describes a collection category, e.g. "Farming"

Interface used in the SkyBlockProfileMemberWithTransformedInventories intersection to describe the intellisense for the inventory after being transformed.

Interface describing the results from the getSkyWarsLevelInfo function.

This interface is returned by getSkyWarsLevelInfo if you passed true as the second parameter.

Describes the properties of a Prestige object returned by getSkyWarsPrestigeForLevel.

Array of inventory slots. If that slot is empty it will be null, otherwise it will be an object containing the data.

This type is a intersection type omitting the default inventory types and including the transformed inventory types.