minerender 2.1.0-alpha.28 → 2.1.0-alpha.29

package/dist/browser/index.d.mts

@@ -623,6 +623,12 @@ declare enum AssetParser {
 declare abstract class AssetSource {
     protected constructor();
     abstract get<T extends MinecraftAsset>(key: AssetKey, parser: AssetParser | string): Promise<Maybe<T>>;
+    /**
+     * Identifies this source's content across sessions for persistent caching. Sources that
+     * cannot tell whether their content changed (an unnamed archive, for example) return
+     * undefined, which keeps their results out of long-lived caches.
+     */
+    get cacheId(): Maybe<string>;
 }
 /** A source failed to load or parse an asset; cause retains the original failure. */
 declare class AssetLoadError extends Error {
@@ -636,8 +642,18 @@ declare class AssetLoadError extends Error {
 declare class AssetLoader {
     static ROOT: string;
     private static _SOURCES;
+    /** Used when a registered source cannot identify its content, so nothing persists past this session. */
+    private static readonly SESSION_SCOPE;
     static get version(): string;
     static setVersion(version: string): void;
+    /**
+     * Scope for persistent cache keys. Empty with only the default vanilla sources, so their
+     * entries stay valid across sessions; otherwise it names every added source (resource packs,
+     * mirrors) so their results never masquerade as vanilla assets after a reload.
+     */
+    static get persistentScope(): string;
+    /** Prefixes a persistent cache key with the current source scope. */
+    static persistentKey(key: string): string;
     static addSource(key: string, source: AssetSource, override?: boolean): void;
     static removeSource(key: string): Maybe<AssetSource>;
     static getAll<T extends MinecraftAsset>(key: AssetKey, parser: AssetParser | string): Promise<T[]>;
@@ -903,12 +919,14 @@ declare class SkinObject extends SceneObject {
     private skinTextureSrc?;
     private skinMaterial?;
     private skinLoad;
-    private capeTextureSrc?;
+    private capeLoad;
     constructor(options?: DeepPartial<SkinObjectOptions>);
     init(): Promise<void>;
     protected removeMeshes(): void;
     protected createMeshes(): void;
     setSkinTexture(src: string): Promise<void>;
+    /** Load a vanilla cape texture, or pass undefined to remove the cape. */
+    setCapeTexture(src?: string): Promise<void>;
     /** Select the arm model, or pass undefined to use texture detection. */
     setSlim(slim?: boolean): void;
     private updateSlim;
@@ -1186,6 +1204,7 @@ declare class HostedAssetSource extends AssetSource {
     private readonly _options;
     constructor(root: string, options?: Partial<HostedAssetSourceOptions>);
     get root(): string;
+    get cacheId(): string;
     get options(): HostedAssetSourceOptions;
     get<T extends MinecraftAsset>(key: AssetKey, parser: AssetParser): Promise<Maybe<T>>;
 }
@@ -1200,6 +1219,8 @@ interface ArchiveEntry {
 }
 
 interface ArchiveProxy {
+    /** Identifies the archive's content across sessions; undefined when it cannot be identified. */
+    readonly id?: string;
     getEntries(): Promise<ArchiveEntry[]>;
 }
 
@@ -1207,6 +1228,7 @@ declare class ArchiveAssetSource extends AssetSource implements ArchiveProxy {
     readonly _archiveProxy: ArchiveProxy;
     constructor(archiveProxy: ArchiveProxy);
     static blob(blob: Blob): ArchiveAssetSource;
+    get cacheId(): Maybe<string>;
     getEntries(): Promise<ArchiveEntry[]>;
     getEntry(path: string): Promise<Maybe<ArchiveEntry>>;
     get<T extends MinecraftAsset>(key: AssetKey, parser: AssetParser | string): Promise<Maybe<T>>;
@@ -1217,7 +1239,8 @@ declare class ArchiveAssetSource extends AssetSource implements ArchiveProxy {
 declare class BrowserArchiveProxy implements ArchiveProxy {
     readonly _blob: Blob;
     readonly _reader: ZipReader<Blob>;
-    constructor(blob: Blob);
+    readonly id?: string;
+    constructor(blob: Blob, id?: string);
     getEntries(): Promise<ArchiveEntry[]>;
 }
 
@@ -1562,6 +1585,8 @@ interface SkinTexture {
 }
 declare class SkinTextures {
     static get(src: string, legacy?: boolean): Promise<SkinTexture>;
+    static getCape(src: string): Promise<MeshBasicMaterial>;
+    private static createMaterial;
     private static isSlim;
     private static normalizeLegacy;
 }

package/dist/browser/index.d.ts

@@ -623,6 +623,12 @@ declare enum AssetParser {
 declare abstract class AssetSource {
     protected constructor();
     abstract get<T extends MinecraftAsset>(key: AssetKey, parser: AssetParser | string): Promise<Maybe<T>>;
+    /**
+     * Identifies this source's content across sessions for persistent caching. Sources that
+     * cannot tell whether their content changed (an unnamed archive, for example) return
+     * undefined, which keeps their results out of long-lived caches.
+     */
+    get cacheId(): Maybe<string>;
 }
 /** A source failed to load or parse an asset; cause retains the original failure. */
 declare class AssetLoadError extends Error {
@@ -636,8 +642,18 @@ declare class AssetLoadError extends Error {
 declare class AssetLoader {
     static ROOT: string;
     private static _SOURCES;
+    /** Used when a registered source cannot identify its content, so nothing persists past this session. */
+    private static readonly SESSION_SCOPE;
     static get version(): string;
     static setVersion(version: string): void;
+    /**
+     * Scope for persistent cache keys. Empty with only the default vanilla sources, so their
+     * entries stay valid across sessions; otherwise it names every added source (resource packs,
+     * mirrors) so their results never masquerade as vanilla assets after a reload.
+     */
+    static get persistentScope(): string;
+    /** Prefixes a persistent cache key with the current source scope. */
+    static persistentKey(key: string): string;
     static addSource(key: string, source: AssetSource, override?: boolean): void;
     static removeSource(key: string): Maybe<AssetSource>;
     static getAll<T extends MinecraftAsset>(key: AssetKey, parser: AssetParser | string): Promise<T[]>;
@@ -903,12 +919,14 @@ declare class SkinObject extends SceneObject {
     private skinTextureSrc?;
     private skinMaterial?;
     private skinLoad;
-    private capeTextureSrc?;
+    private capeLoad;
     constructor(options?: DeepPartial<SkinObjectOptions>);
     init(): Promise<void>;
     protected removeMeshes(): void;
     protected createMeshes(): void;
     setSkinTexture(src: string): Promise<void>;
+    /** Load a vanilla cape texture, or pass undefined to remove the cape. */
+    setCapeTexture(src?: string): Promise<void>;
     /** Select the arm model, or pass undefined to use texture detection. */
     setSlim(slim?: boolean): void;
     private updateSlim;
@@ -1186,6 +1204,7 @@ declare class HostedAssetSource extends AssetSource {
     private readonly _options;
     constructor(root: string, options?: Partial<HostedAssetSourceOptions>);
     get root(): string;
+    get cacheId(): string;
     get options(): HostedAssetSourceOptions;
     get<T extends MinecraftAsset>(key: AssetKey, parser: AssetParser): Promise<Maybe<T>>;
 }
@@ -1200,6 +1219,8 @@ interface ArchiveEntry {
 }
 
 interface ArchiveProxy {
+    /** Identifies the archive's content across sessions; undefined when it cannot be identified. */
+    readonly id?: string;
     getEntries(): Promise<ArchiveEntry[]>;
 }
 
@@ -1207,6 +1228,7 @@ declare class ArchiveAssetSource extends AssetSource implements ArchiveProxy {
     readonly _archiveProxy: ArchiveProxy;
     constructor(archiveProxy: ArchiveProxy);
     static blob(blob: Blob): ArchiveAssetSource;
+    get cacheId(): Maybe<string>;
     getEntries(): Promise<ArchiveEntry[]>;
     getEntry(path: string): Promise<Maybe<ArchiveEntry>>;
     get<T extends MinecraftAsset>(key: AssetKey, parser: AssetParser | string): Promise<Maybe<T>>;
@@ -1217,7 +1239,8 @@ declare class ArchiveAssetSource extends AssetSource implements ArchiveProxy {
 declare class BrowserArchiveProxy implements ArchiveProxy {
     readonly _blob: Blob;
     readonly _reader: ZipReader<Blob>;
-    constructor(blob: Blob);
+    readonly id?: string;
+    constructor(blob: Blob, id?: string);
     getEntries(): Promise<ArchiveEntry[]>;
 }
 
@@ -1562,6 +1585,8 @@ interface SkinTexture {
 }
 declare class SkinTextures {
     static get(src: string, legacy?: boolean): Promise<SkinTexture>;
+    static getCape(src: string): Promise<MeshBasicMaterial>;
+    private static createMaterial;
     private static isSlim;
     private static normalizeLegacy;
 }

package/dist/browser/index.js

@@ -1468,7 +1468,7 @@ var Models = class _Models {
   }
   static async getItemModel(key) {
     const itemKey = new AssetKey(key.namespace, key.path, "items", void 0, key.rootType, ".json", key.root);
-    const model = await this.PERSISTENT_CACHE.getOrLoad(itemKey.serialize(), async () => {
+    const model = await this.PERSISTENT_CACHE.getOrLoad(AssetLoader.persistentKey(itemKey.serialize()), async () => {
       const result = await AssetLoader.getFirst([itemKey, key], "json" /* JSON */);
       if (!result) return void 0;
       if (result.key.assetType !== "items") return { ...result.asset, key };
@@ -1514,7 +1514,7 @@ var Models = class _Models {
     }
     const keyStr = key.serialize();
     return Caching.rawModelCache.get(keyStr, (k) => {
-      return this.PERSISTENT_CACHE.getOrLoad(keyStr, (k1) => {
+      return this.PERSISTENT_CACHE.getOrLoad(AssetLoader.persistentKey(keyStr), (k1) => {
         return AssetLoader.get(key, "model" /* MODEL */);
       });
     }).then((asset) => {
@@ -1586,7 +1586,7 @@ var BlockStates = class {
     }
     const keyStr = key.serialize();
     return Caching.blockStateCache.get(keyStr, (k) => {
-      return this.PERSISTENT_CACHE.getOrLoad(keyStr, (k1) => {
+      return this.PERSISTENT_CACHE.getOrLoad(AssetLoader.persistentKey(keyStr), (k1) => {
         return AssetLoader.get(key, "blockstate" /* BLOCKSTATE */);
       });
     }).then((asset) => {
@@ -1632,6 +1632,14 @@ var Assets = class {
 var AssetSource = class {
   constructor() {
   }
+  /**
+   * Identifies this source's content across sessions for persistent caching. Sources that
+   * cannot tell whether their content changed (an unnamed archive, for example) return
+   * undefined, which keeps their results out of long-lived caches.
+   */
+  get cacheId() {
+    return void 0;
+  }
 };
 var AssetLoadError = class extends Error {
   constructor(source, key, path, cause) {
@@ -1844,6 +1852,9 @@ var _HostedAssetSource = class _HostedAssetSource extends AssetSource {
   get root() {
     return this._root;
   }
+  get cacheId() {
+    return `hosted:${this._root}`;
+  }
   get options() {
     return this._options;
   }
@@ -1920,9 +1931,10 @@ var HostedAssetSource = _HostedAssetSource;
 // src/assets/source/archive/BrowserArchiveProxy.ts
 var import_zip = require("@zip.js/zip.js");
 var BrowserArchiveProxy = class {
-  constructor(blob) {
+  constructor(blob, id) {
     this._blob = blob;
     this._reader = new import_zip.ZipReader(new import_zip.BlobReader(this._blob));
+    this.id = id ?? (typeof File !== "undefined" && blob instanceof File ? `${blob.name}:${blob.size}:${blob.lastModified}` : void 0);
   }
   async getEntries() {
     return (await this._reader.getEntries()).map((e) => {
@@ -1947,6 +1959,10 @@ var ArchiveAssetSource = class _ArchiveAssetSource extends AssetSource {
   static blob(blob) {
     return new _ArchiveAssetSource(new BrowserArchiveProxy(blob));
   }
+  get cacheId() {
+    const id = this._archiveProxy.id;
+    return id === void 0 ? void 0 : `archive:${id}`;
+  }
   async getEntries() {
     return this._archiveProxy.getEntries();
   }
@@ -1989,6 +2005,7 @@ var ArchiveAssetSource = class _ArchiveAssetSource extends AssetSource {
 
 // src/assets/AssetLoader.ts
 var p4 = prefix("AssetLoader");
+var FALLBACK_ROOT = "https://raw.githubusercontent.com/InventivetalentDev/minerender-fallback-assets/master";
 var _AssetLoader = class _AssetLoader {
   static get version() {
     return this.ROOT.substring(this.ROOT.lastIndexOf("/") + 1);
@@ -2004,6 +2021,28 @@ var _AssetLoader = class _AssetLoader {
     }
     Caching.clear();
   }
+  /**
+   * Scope for persistent cache keys. Empty with only the default vanilla sources, so their
+   * entries stay valid across sessions; otherwise it names every added source (resource packs,
+   * mirrors) so their results never masquerade as vanilla assets after a reload.
+   */
+  static get persistentScope() {
+    const parts = [];
+    for (const { key, source } of this._SOURCES) {
+      const id = source.cacheId;
+      if (key === "mcassets" && id === `hosted:${this.ROOT}`) continue;
+      if (key === "mcassets-fallback" && id === `hosted:${FALLBACK_ROOT}`) continue;
+      if (id === void 0) return this.SESSION_SCOPE;
+      parts.push(`${key}=${id}`);
+    }
+    return parts.join("|");
+  }
+  /** Prefixes a persistent cache key with the current source scope. */
+  static persistentKey(key) {
+    const scope = this.persistentScope;
+    return scope ? `${scope}
+${key}` : key;
+  }
   static addSource(key, source, override = true) {
     if (override) {
       const existing = this.removeSource(key);
@@ -2065,7 +2104,9 @@ var _AssetLoader = class _AssetLoader {
 };
 _AssetLoader.ROOT = DEFAULT_ROOT;
 _AssetLoader._SOURCES = [];
-_AssetLoader.addSource("mcassets-fallback", new HostedAssetSource("https://raw.githubusercontent.com/InventivetalentDev/minerender-fallback-assets/master", { retryDefaults: false }));
+/** Used when a registered source cannot identify its content, so nothing persists past this session. */
+_AssetLoader.SESSION_SCOPE = `session:${Date.now().toString(36)}:${Math.random().toString(36).slice(2)}`;
+_AssetLoader.addSource("mcassets-fallback", new HostedAssetSource(FALLBACK_ROOT, { retryDefaults: false }));
 _AssetLoader.addSource("mcassets", new HostedAssetSource(_AssetLoader.ROOT, { retryDefaults: false }));
 var AssetLoader = _AssetLoader;
 
@@ -2108,7 +2149,7 @@ var ModelTextures = class {
     }
     const keyStr = key.serialize();
     return Caching.textureMetaCache.get(keyStr, (k) => {
-      return this.PERSISTENT_META_CACHE.getOrLoad(keyStr, (k1) => {
+      return this.PERSISTENT_META_CACHE.getOrLoad(AssetLoader.persistentKey(keyStr), (k1) => {
         return AssetLoader.get(key, "meta" /* META */).then((asset) => {
           if (asset)
             asset.key = key;
@@ -4755,7 +4796,9 @@ var _BlockObject = class _BlockObject extends SceneObject {
     if (typeof variant.y !== "undefined") {
       rotation.y = toRadians(clampRotationDegrees(typeof variant.x !== "undefined" ? variant.y : 360 - variant.y));
     }
-    const model = await Models.getMerged(AssetKey.parse("models", variant.model));
+    const modelKey = AssetKey.parse("models", variant.model);
+    modelKey.root = this.blockState.key?.root;
+    const model = await Models.getMerged(modelKey);
     const options = {
       ...this.options,
       tints: model ? await BlockTints.get(this.blockState.key, this.state, model, this.options.tints) : this.options.tints,
@@ -5551,56 +5594,12 @@ var baseSkinCoordinates = {
     }
   },
   cape: {
-    //TODO
-    east: {
-      uv: [
-        0,
-        36,
-        4,
-        48
-      ]
-    },
-    west: {
-      uv: [
-        8,
-        36,
-        12,
-        48
-      ]
-    },
-    north: {
-      uv: [
-        4,
-        36,
-        8,
-        48
-      ]
-    },
-    south: {
-      uv: [
-        12,
-        36,
-        16,
-        48
-      ]
-    },
-    up: {
-      uv: [
-        4,
-        32,
-        8,
-        36
-      ]
-    },
-    down: {
-      uv: [
-        8,
-        32,
-        12,
-        36
-      ],
-      rotation: 180
-    }
+    east: { uv: [0, 1, 1, 17] },
+    west: { uv: [11, 1, 12, 17] },
+    north: { uv: [1, 1, 11, 17] },
+    south: { uv: [12, 1, 22, 17] },
+    up: { uv: [11, 1, 1, 0] },
+    down: { uv: [21, 0, 11, 1] }
   }
 };
 var classicSkinTextureCoordinates = {
@@ -5699,14 +5698,27 @@ var SkinTextures = class {
     const key = `skin:${serializeImageKey({ src })}:${isLegacy}`;
     const material = Caching.materialCache.get(key, () => {
       const pixels = isLegacy ? this.normalizeLegacy(image, scale) : new Uint8Array(image.data);
-      const texture = Textures.initTextureProps(new import_three18.DataTexture(pixels, image.width, image.width));
-      texture.colorSpace = import_three18.SRGBColorSpace;
-      texture.flipY = true;
-      texture.needsUpdate = true;
-      return new import_three18.MeshBasicMaterial({ map: texture, transparent: true, side: import_three18.DoubleSide, alphaTest: 0.5 });
+      return this.createMaterial(pixels, image.width, image.width);
     });
     return { material, slim, legacy: isLegacy };
   }
+  static async getCape(src) {
+    const image = await ImageLoader.getData(src);
+    const scale = image.width / 64;
+    if (!Number.isInteger(scale) || scale < 1 || image.height !== image.width / 2) {
+      throw new MineRenderError(`Invalid cape dimensions ${image.width}x${image.height}; expected 64x32 or an integer-scaled equivalent`);
+    }
+    return Caching.materialCache.get(`cape:${serializeImageKey({ src })}`, () => {
+      return this.createMaterial(new Uint8Array(image.data), image.width, image.height, false);
+    });
+  }
+  static createMaterial(pixels, width, height, transparent = true) {
+    const texture = Textures.initTextureProps(new import_three18.DataTexture(pixels, width, height));
+    texture.colorSpace = import_three18.SRGBColorSpace;
+    texture.flipY = true;
+    texture.needsUpdate = true;
+    return new import_three18.MeshBasicMaterial({ map: texture, transparent, side: transparent ? import_three18.DoubleSide : import_three18.FrontSide, alphaTest: transparent ? 0.5 : 0 });
+  }
   static isSlim(image, scale) {
     for (const [x, y] of [[46, 52], [54, 20]]) {
       for (let row = y * scale; row < (y + 12) * scale; row++) {
@@ -5769,6 +5781,7 @@ var SkinObject = class extends SceneObject {
     this.slim = false;
     this.detectedSlim = false;
     this.skinLoad = 0;
+    this.capeLoad = 0;
     this.options = (0, import_ts_deepmerge7.default)({}, SceneObject.DEFAULT_OPTIONS, options ?? {});
     this.slim = this.options.slim ?? false;
   }
@@ -5838,6 +5851,7 @@ var SkinObject = class extends SceneObject {
     this.detectedSlim = texture.slim;
     this.updateSlim(this.options.slim ?? this.detectedSlim);
     for (const part of SKIN_PARTS) {
+      if (part === "cape" /* CAPE */) continue;
       const mesh = this.getMeshByName(part);
       if (mesh) {
         mesh.material = texture.material;
@@ -5845,7 +5859,34 @@ var SkinObject = class extends SceneObject {
     }
     this.notifyDirty();
   }
-  //TODO: cape
+  /** Load a vanilla cape texture, or pass undefined to remove the cape. */
+  async setCapeTexture(src) {
+    const load = ++this.capeLoad;
+    if (src === void 0) {
+      const group = this.getGroupByName("cape" /* CAPE */);
+      if (group) this.remove(group);
+      this.notifyDirty();
+      return;
+    }
+    const material = await SkinTextures.getCape(src);
+    if (load !== this.capeLoad) return;
+    const mesh = this.getMeshByName("cape" /* CAPE */);
+    if (mesh) {
+      mesh.material = material;
+    } else {
+      const group = this.createAndAddGroup("cape" /* CAPE */, 0, 24, 2);
+      group.rotation.set(toRadians(-6), Math.PI, 0);
+      const geometry = this._getBoxGeometryFromDimensions(
+        classicSkinGeometries.cape,
+        classicSkinTextureCoordinates.cape,
+        [64, 32],
+        [64, 32]
+      );
+      const cape = this.createAndAddMesh("cape" /* CAPE */, group, geometry, material);
+      cape.position.set(0, -8, -0.5);
+    }
+    this.notifyDirty();
+  }
   /** Select the arm model, or pass undefined to use texture detection. */
   setSlim(slim) {
     this.options.slim = slim;
@@ -5873,6 +5914,7 @@ var SkinObject = class extends SceneObject {
   }
   dispose() {
     this.skinLoad++;
+    this.capeLoad++;
     super.dispose();
   }
   //TODO: layer toggles