mc-assets 0.1.0

package/LICENSE

@@ -0,0 +1,9 @@
+# The MIT License
+
+Copyright 2024 Vitaly Turovsky, contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.MD

@@ -0,0 +1,23 @@
+# MC Assets
+
+![banner](./assets/mc-assets.png)
+
+```bash
+npm i mc-assets
+```
+
+**NEXT-GEN Minecraft Assets Library**
+
+## Features
+
+- **Automatic Updates** - This library is automatically updated and published to npm.
+- **Fully Typed** - Today is nothing can be done without TypeScript. We ship best type definitions possible.
+- **Early Access** - It always includes the latest pre and rc (release candidate) version.
+- **Version Accurate** - Includes all released versions starting from 1.7.10.
+- **Memory Efficient** - Small installation size, for the fastest download & loading time.
+- **Simple & Complete API** - Works in browsers out of the box and provides parsers for all the data this library provides.
+
+This module was originally designed as standalone package for [https://mcraft.fun](mcraft.fun) (repo) project so it is easier to maintain, but now it became a library that I think can cover any use case where you need to work with minecraft assets. Minecraft assets means block states, models info and texture contents, it doesn't cover minecraft data use cases.
+
+> Bundled modules & block states are version-accurate starting from 1.13.0 (post-flattening) version.
+> Tested on Node.js 18 and above.

package/dist/allAtlases.d.ts

@@ -0,0 +1,4 @@
+import { AtlasParser } from './atlasParser';
+export declare const itemsAtlasParser: AtlasParser;
+export declare const blocksAtlasParser: AtlasParser;
+export declare const particlesAtlasParser: AtlasParser;

package/dist/allAtlases.js

@@ -0,0 +1,22 @@
+import { AtlasParser } from './atlasParser';
+//@ts-ignore
+import itemsAtlases from '../../dist/itemsAtlases.json';
+//@ts-ignore
+import itemsAtlasLatest from '../../dist/itemsAtlasLatest.png';
+//@ts-ignore
+import itemsAtlasLegacy from '../../dist/itemsAtlasLegacy.png';
+//@ts-ignore
+import blocksAtlases from '../../dist/blocksAtlases.json';
+//@ts-ignore
+import blocksAtlasLatest from '../../dist/blocksAtlasLatest.png';
+//@ts-ignore
+import blocksAtlasLegacy from '../../dist/blocksAtlasLegacy.png';
+//@ts-ignore
+import particlesAtlases from '../../dist/particlesAtlases.json';
+//@ts-ignore
+import particlesAtlasLatest from '../../dist/particlesAtlasLatest.png';
+//@ts-ignore
+import particlesAtlasLegacy from '../../dist/particlesAtlasLegacy.png';
+export const itemsAtlasParser = new AtlasParser(itemsAtlases, itemsAtlasLatest, itemsAtlasLegacy);
+export const blocksAtlasParser = new AtlasParser(blocksAtlases, blocksAtlasLatest, blocksAtlasLegacy);
+export const particlesAtlasParser = new AtlasParser(particlesAtlases, particlesAtlasLatest, particlesAtlasLegacy);

package/dist/atlasCreator.d.ts

@@ -0,0 +1,37 @@
+export declare const getAtlasSize: (numberOfTiles: number, tileSize: number) => {
+    width: number;
+    height: number;
+};
+export type JsonAtlas = {
+    suSv: number;
+    tileSize: number;
+    width: number;
+    height: number;
+    textures: {
+        [file: string]: {
+            u: number;
+            v: number;
+        };
+    };
+};
+export type AtlasCreatorOptions = {
+    input: string[];
+    getLoadedImage: (name: any) => {
+        contents?: string;
+        image?: HTMLImageElement;
+        tileWidthMult?: number;
+        useOriginalSize?: boolean;
+        renderWidth?: number;
+        renderHeight?: number;
+        renderSourceStartX?: number;
+        renderSourceStartY?: number;
+        renderSourceWidth?: number;
+        renderSourceHeight?: number;
+    };
+    format?: 'uv' | 'index';
+    tileSize?: number;
+    getCanvas?: (imgSize: number) => HTMLCanvasElement;
+};
+export declare const makeTextureAtlas: ({ input, getLoadedImage, tileSize, getCanvas, }: AtlasCreatorOptions) => {
+    json: JsonAtlas;
+};

package/dist/atlasCreator.js

@@ -0,0 +1,111 @@
+function nextPowerOfTwo(n) {
+    if (n === 0)
+        return 1;
+    n--;
+    n |= n >> 1;
+    n |= n >> 2;
+    n |= n >> 4;
+    n |= n >> 8;
+    n |= n >> 16;
+    return n + 1;
+}
+export const getAtlasSize = (numberOfTiles, tileSize) => {
+    const size = nextPowerOfTwo(Math.ceil(Math.sqrt(numberOfTiles)));
+    return {
+        width: size * tileSize,
+        height: size * tileSize
+    };
+};
+export const makeTextureAtlas = ({ input, getLoadedImage, tileSize = 16, getCanvas = () => document.createElement('canvas'), }) => {
+    const tilesCount = input.length;
+    const imgSize = getAtlasSize(tilesCount, tileSize).width;
+    const canvas = getCanvas(imgSize);
+    canvas.width = imgSize;
+    canvas.height = imgSize;
+    const g = canvas.getContext('2d');
+    g.imageSmoothingEnabled = false;
+    const texturesIndex = {};
+    let nextX = 0;
+    let nextY = 0;
+    let rowMaxY = 0;
+    const goToNextRow = () => {
+        nextX = 0;
+        nextY += Math.ceil(rowMaxY / tileSize) * tileSize;
+        rowMaxY = 0;
+    };
+    const suSv = tileSize / imgSize;
+    const tilesPerRow = Math.ceil(imgSize / tileSize);
+    for (const i in input) {
+        const keyValue = input[i];
+        const inputData = getLoadedImage(keyValue);
+        let img;
+        if (inputData.image) {
+            img = inputData.image;
+        }
+        else if (inputData.contents) {
+            img = new Image();
+            img.src = inputData.contents;
+        }
+        else {
+            throw new Error('No image or contents');
+        }
+        let su = suSv;
+        let sv = suSv;
+        let renderWidth = tileSize * (inputData.tileWidthMult ?? 1);
+        let renderHeight = tileSize;
+        if (inputData.useOriginalSize || inputData.renderWidth || inputData.renderHeight) {
+            // todo check have enough space
+            renderWidth = Math.ceil((inputData.renderWidth ?? img.width) / tileSize) * tileSize;
+            renderHeight = Math.ceil((inputData.renderHeight ?? img.height) / tileSize) * tileSize;
+            su = renderWidth / imgSize;
+            sv = renderHeight / imgSize;
+            if (renderHeight > imgSize || renderWidth > imgSize) {
+                throw new Error('Texture ' + keyValue + ' is too big');
+            }
+        }
+        if (nextX + renderWidth > imgSize) {
+            goToNextRow();
+        }
+        const x = nextX;
+        const y = nextY;
+        const yIndex = y / tileSize;
+        const xIndex = x / tileSize;
+        const tileIndex = yIndex * tilesPerRow + xIndex;
+        nextX += renderWidth;
+        rowMaxY = Math.max(rowMaxY, renderHeight);
+        if (nextX >= imgSize) {
+            goToNextRow();
+        }
+        const renderSourceDefaultSize = Math.min(img.width, img.height);
+        const renderSourceWidth = inputData.renderSourceWidth ?? renderSourceDefaultSize;
+        const renderSourceHeight = inputData.renderSourceHeight ?? renderSourceDefaultSize;
+        try {
+            g.drawImage(img, inputData.renderSourceStartX ?? 0, inputData.renderSourceStartY ?? 0, renderSourceWidth, renderSourceHeight, x, y, renderWidth, renderHeight);
+        }
+        catch (err) {
+            throw new Error(`Error drawing ${keyValue}: ${err}`);
+        }
+        // remove the extension eg .png
+        const cleanName = keyValue.split('.').slice(0, -1).join('.') || keyValue;
+        texturesIndex[cleanName] = {
+            u: x / imgSize,
+            v: y / imgSize,
+            tileIndex,
+            ...su == suSv && sv == suSv ? {} : {
+                su,
+                sv,
+                width: renderWidth,
+                height: renderHeight
+            }
+        };
+    }
+    return {
+        json: {
+            suSv,
+            tileSize,
+            width: imgSize,
+            height: imgSize,
+            textures: texturesIndex
+        }
+    };
+};

package/dist/atlasParser.d.ts

@@ -0,0 +1,49 @@
+import { VersionedStore } from './versionedStore';
+type Texture = {
+    u: number;
+    v: number;
+    su?: number;
+    sv?: number;
+};
+/**
+ * @unstable
+ */
+export interface ItemsAtlasesOutputJson {
+    textures: Record<string, Texture>;
+    width: number;
+    height: number;
+    tileSize: number;
+    suSv: number;
+}
+interface ItemsAtlases {
+    latest: ItemsAtlasesOutputJson;
+    legacy?: ItemsAtlasesOutputJson;
+}
+type StoreType = Texture & {
+    imageName: string;
+    version: string;
+};
+type DataUrl = string;
+export declare class AtlasParser {
+    atlasJson: any;
+    latestImage: string;
+    legacyImage?: string | undefined;
+    atlasStore: VersionedStore<StoreType>;
+    itemsCanvas: any;
+    atlasHasLegacyImage: boolean;
+    constructor(atlasJson: any, latestImage: string, legacyImage?: string | undefined);
+    get atlas(): ItemsAtlases;
+    getTextureInfo(version: string, itemName: string): {
+        su: number;
+        sv: number;
+        u: number;
+        v: number;
+        imageName: string;
+        version: string;
+    } | undefined;
+    makeNewAtlas(version: string, getCustomImage?: (itemName: string) => DataUrl | HTMLImageElement | boolean | void, tileSize?: number): Promise<{
+        canvas: HTMLCanvasElement;
+        atlas: import("./atlasCreator").JsonAtlas;
+    }>;
+}
+export {};

package/dist/atlasParser.js

@@ -0,0 +1,120 @@
+import { VersionedStore } from './versionedStore';
+import { makeTextureAtlas } from './atlasCreator';
+export class AtlasParser {
+    atlasJson;
+    latestImage;
+    legacyImage;
+    atlasStore;
+    itemsCanvas;
+    atlasHasLegacyImage;
+    constructor(atlasJson, latestImage, legacyImage) {
+        this.atlasJson = atlasJson;
+        this.latestImage = latestImage;
+        this.legacyImage = legacyImage;
+        this.atlasStore = new VersionedStore();
+        this.atlasStore.inclusive = false;
+        const itemsAtlases = atlasJson;
+        const addByVersion = (store, version, textures, imageKey) => {
+            for (const [key, path] of Object.entries(textures)) {
+                store.push(version, key, { ...path, version, imageName: imageKey });
+            }
+        };
+        addByVersion(this.atlasStore, 'latest', itemsAtlases.latest.textures, 'latest');
+        this.atlasHasLegacyImage = !!itemsAtlases.legacy;
+        if (legacyImage && itemsAtlases.legacy) {
+            for (const key of Object.keys(itemsAtlases.legacy.textures)) {
+                const [version, name] = key.split('/');
+                addByVersion(this.atlasStore, version, { [name]: itemsAtlases.legacy.textures[key] }, 'legacy');
+            }
+        }
+    }
+    get atlas() {
+        return this.atlasJson;
+    }
+    getTextureInfo(version, itemName) {
+        const info = this.atlasStore.get(version, itemName);
+        if (!info)
+            return;
+        const defaultSuSv = (info?.imageName === 'latest' ? this.atlas.latest : this.atlas.legacy).suSv;
+        return {
+            ...info,
+            su: info?.su ?? defaultSuSv,
+            sv: info?.sv ?? defaultSuSv,
+        };
+    }
+    async makeNewAtlas(version, getCustomImage, tileSize = this.atlas.latest.tileSize) {
+        const itemsAtlases = this.atlasJson;
+        const newTextures = {};
+        const legacyImg = this.atlasHasLegacyImage ? await getLoadedImage(this.legacyImage) : null;
+        const latestImg = await getLoadedImage(this.latestImage);
+        for (const [itemName, texture] of Object.entries(itemsAtlases.latest.textures)) {
+            const customImage = getCustomImage?.(itemName);
+            if (customImage === false)
+                continue;
+            if (customImage && customImage !== true) {
+                const img = typeof customImage === 'string' ? await getLoadedImage(customImage) : customImage;
+                newTextures[itemName] = {
+                    u: 0,
+                    v: 0,
+                    su: 1,
+                    sv: 1,
+                    img
+                };
+                continue;
+            }
+            const info = this.getTextureInfo(version, itemName);
+            if (!info)
+                throw new Error(`Missing texture info for ${itemName}`);
+            const { u, v, su, sv } = info;
+            const atlas = info.version === 'latest' ? itemsAtlases.latest : itemsAtlases.legacy;
+            const image = info.imageName === 'latest' ? latestImg : legacyImg;
+            if (!image)
+                throw new Error(`Missing image for ${itemName}`);
+            newTextures[itemName] = {
+                u,
+                v,
+                su: su ?? atlas.suSv,
+                sv: sv ?? atlas.suSv,
+                img: image
+            };
+        }
+        let canvas;
+        const { json } = makeTextureAtlas({
+            input: Object.keys(newTextures),
+            getCanvas() {
+                canvas = document.createElement('canvas');
+                return canvas;
+            },
+            getLoadedImage: (name) => {
+                const texture = newTextures[name];
+                const image = texture.img;
+                const imgSize = image.width;
+                //@ts-ignore we no longer need the image, remove from atlas
+                delete texture.img;
+                return {
+                    image,
+                    // renderWidth: texture.su * imgSize,
+                    // renderHeight: texture.sv * imgSize,
+                    renderSourceStartX: texture.u * imgSize,
+                    renderSourceStartY: texture.v * imgSize,
+                    renderSourceWidth: texture.su * imgSize,
+                    renderSourceHeight: texture.sv * imgSize,
+                };
+            },
+            tileSize: this.atlas.latest.tileSize,
+        });
+        return {
+            canvas,
+            atlas: json
+        };
+    }
+}
+const getLoadedImage = async (url) => {
+    const img = new Image();
+    img.src = url;
+    await new Promise((resolve, reject) => {
+        img.onload = resolve;
+        img.onerror = reject;
+    });
+    return img;
+};