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

skyblockstats/skyblock-assets

Repository files navigation

SkyBlock assets

TypeScript library for getting urls (hosted on GitHub) to Hypixel SkyBlock item images from several resource packs.

To generate and optimize the texture packs, run npm run generate. This requires Oxipng to be installed. Optimization will take a few minutes.

Usage

First, import the packs that you want to use.

import vanilla from 'skyblock-assets/matchers/vanilla.json'
import packshq from 'skyblock-assets/matchers/packshq.json'

The reason you have to import the packs yourself is so the library uses less memory if you're not using every pack.

Then, you can use the getTextureUrl function to get the url of an item.

const itemTextureUrl = skyblockAssets.getTextureUrl({
	id: 'minecraft:nether_star',
	nbt: {
		ExtraAttributes: {
			id: 'SKYBLOCK_MENU'
		},
		display: {
			Name: 'SkyBlock Menu (Right Click)'
		}
	},
	packs: [ packshq, vanilla ],
})

The order in which you provide packs is the order in which they will be searched, so always put vanilla last.

Pack versions

Ectoplasm - Completionist's Update
Furfsky Reborn - v1.5.1
Furfsky - v1.7.1
PacksHQ - v13
RNBW - v0.7.0
Hypixel+ - v0.13.0
Worlds and Beyond - v1.5