gear-rarity v1.0.5

Rarity levels for Loot items.

How are the rarity levels determined?

The rarity level of any given item is deducted from its number of occurrences in the total number of Loot items.

Installation

npm i --save gear-rarity # npm
yarn add gear-rarity # yarn
pnpm add gear-rarity # pnpm

API

Types

// RarityLevel goes from 1 (common) to 6 (mythic). See table above for more info.
type RarityLevel = 1 | 2 | 3 | 4 | 5 | 6;

// ColorFn allows to override a color in different places.
type ColorFn = (colorParameters: {
  level: RarityLevel; // the rarity level
  color: string; // the base color you can override
  itemName?: string; // in certain cases the item name will be present
}) => string | void | null; // return a string to override the color

itemRarity()

function itemRarity(itemName: string): RarityLevel;

This function returns the rarity level of an item, given its name.

Example:

let rarity = itemRarity('"Golem Roar" Studded Leather Belt of Fury');

console.log(rarity); // 6

rarityColor()

function rarityColor(
  itemOrRarityLevel: string | RarityLevel,
  options?: { colorFn: ColorFn }
): string;

This function returns the color of a rarity level, given an item name or a rarity level.

Example:

let color = rarityColor("Ornate Belt of Perfection");

console.log(color); // "#c13cff"

rarityDescription()

function rarityDescription(itemOrRarityLevel: string | RarityLevel): string;

This function returns the description of a rarity level, given an item name or a rarity level.

Example:

let levelA = rarityDescription(1);
let levelB = rarityDescription("Studded Leather Boots of Rage");

console.log(levelA); // "Common"
console.log(levelB); // "Legendary"

rarityImage()

function rarityImage(
  imageOrItems: string | string[],
  options?: { colorFn?: ColorFn; displayLevels?: Boolean }
): Promise<string>;

This function generates an image with added rarity levels.

It accepts any of the following:

• SVG source of a Loot image.
• Data URI representing a Loot image (e.g. as returned by the tokenURI() method of the Loot contract).
• HTTP URL pointing to a Loot image.

• Array of items.

• The displayLevels option allows to add levels to the items list.

• The colorFn option allows to override the color of a particular item.

Example with React, use-nft to load the image, and swr to handle the async function:

import { rarityImage } from "gear-rarity";
import { useNft } from "use-nft";
import useSWR from "swr";

function Loot({ tokenId }) {
  const { nft } = useNft(LOOT, id);
  const { data: image } = useSWR(nft?.image, rarityImage);
  return image ? <img src={image} /> : <div>Loading…</div>;
}

The resulting images could look like this:

rarityImageFromItems()

function rarityImageFromItems(
  items: string[],
  options: { colorFn?: ColorFn; displayLevels?: Boolean }
): string;

This function is similar to rarityImage, except it only accepts an array of items. It is useful when you already have a list of items, because it returns a string directly (while rarityImage() returns a Promise resolving to a string).

• The displayLevels option allows to add levels to the items list.
• The colorFn option allows to override the color of a particular item.

Example:

import { rarityImageFromItems } from "gear-rarity";

const bag = [
  "Grimoire",
  '"Woe Bite" Ornate Chestplate of the Fox +1',
  "Silk Hood",
  "Heavy Belt of Fury",
  "Shoes",
  "Silk Gloves",
  '"Rune Glow" Amulet of Rage',
  "Silver Ring",
];

document.body.innerHTML = `
  <img src=${rarityImageFromItems(bag)} />
`;

Demo

Have a look at the demo app on CodeSandbox to see how it works.

You can also run it from this repository:

# Build gear-rarity
yarn
yarn build

# Run the demo app
cd demo
yarn
yarn dev

Thanks

• @scotato for github.com/bpierre/loot-rarity, the original implementation.
• @scotato for github.com/scotato/inventory, loot-rarity was heavily inspired by it.
• @Anish-Agnihotri for the data he extracted from Loot and that loot-rarity is using.

License

MIT