minecraft-renderer 0.1.62 → 0.1.64

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "minecraft-renderer",
-  "version": "0.1.62",
+  "version": "0.1.64",
   "description": "The most Modular Minecraft world renderer with Three.js WebGL backend",
   "type": "module",
   "main": "./dist/index.js",

package/src/graphicsBackend/config.ts

@@ -117,8 +117,8 @@ export const getDefaultRendererState = (): {
   return {
     reactive: proxy({
       world: {
-        chunksLoaded: new Set<string>(),
-        heightmaps: new Map<string, Int16Array>(),
+        chunksLoaded: {},
+        heightmaps: {},
         allChunksLoaded: false,
         mesherWork: false,
         instabilityFactors: defaultPerformanceInstabilityFactors(),
@@ -132,7 +132,7 @@ export const getDefaultRendererState = (): {
       worstRenderTime: 0,
       avgRenderTime: 0,
       world: {
-        chunksLoaded: new Set(),
+        chunksLoadedCount: 0,
         chunksTotalNumber: 0,
         chunksFullInfo: '-'
       },

package/src/graphicsBackend/rendererDefaultOptions.ts

@@ -1,12 +1,12 @@
 //@ts-nocheck
 import {
-  FUTURISTIC_CAMERA_IDS,
-  FUTURISTIC_CAMERA_LABELS,
-  FUTURISTIC_SCENE_IDS,
-  FUTURISTIC_SCENE_LABELS,
+  V2_CAMERA_IDS,
+  V2_CAMERA_LABELS,
+  V2_SCENE_IDS,
+  V2_SCENE_LABELS,
   MINECRAFT_BLOCK_GROUP_IDS,
   MINECRAFT_BLOCK_GROUP_LABELS
-} from '../three/menuBackground/futuristicMeta'
+} from '../three/menuBackground/v2Meta'
 import { MENU_BACKGROUND_OPTION_DEFAULTS } from '../three/menuBackground/config'
 import type { RendererGpuPreference } from '../three/menuBackground/gpuPreference'
 
@@ -54,11 +54,11 @@ export const RENDERER_DEFAULT_OPTIONS = {
   defaultSkybox: true as boolean,
   menuBackgroundMode: MB.mode,
   menuBackgroundMinecraftTextures: MB.minecraftTextures as boolean,
-  menuBackgroundFuturisticScene: MB.futuristicScene,
-  menuBackgroundFuturisticCamera: MB.futuristicCamera,
-  menuBackgroundFuturisticBlockGroup: MB.futuristicBlockGroup,
-  menuBackgroundFuturisticCameraSpeed: MB.futuristicCameraSpeedPercent,
-  menuBackgroundFuturisticBlockSpeed: MB.futuristicBlockSpeedPercent,
+  menuBackgroundV2Scene: MB.v2Scene,
+  menuBackgroundV2Camera: MB.v2Camera,
+  menuBackgroundV2BlockGroup: MB.v2BlockGroup,
+  menuBackgroundV2CameraSpeed: MB.v2CameraSpeedPercent,
+  menuBackgroundV2BlockSpeed: MB.v2BlockSpeedPercent,
   rendererFuturisticReveal: false as boolean,
   rendererPerfDebugOverlay: false as boolean,
   disableBlockEntityTextures: false as boolean,
@@ -110,37 +110,54 @@ export function migrateRendererOptions(saved: Record<string, unknown>): void {
   }
   delete saved.wasmExperimentalMesher
   delete saved.rendererWasmMesher
+
+  if (saved.menuBackgroundMode === 'futuristic') {
+    saved.menuBackgroundMode = 'v2'
+  }
+  const futuristicToV2: Array<[string, string]> = [
+    ['menuBackgroundFuturisticScene', 'menuBackgroundV2Scene'],
+    ['menuBackgroundFuturisticCamera', 'menuBackgroundV2Camera'],
+    ['menuBackgroundFuturisticBlockGroup', 'menuBackgroundV2BlockGroup'],
+    ['menuBackgroundFuturisticCameraSpeed', 'menuBackgroundV2CameraSpeed'],
+    ['menuBackgroundFuturisticBlockSpeed', 'menuBackgroundV2BlockSpeed'],
+  ]
+  for (const [oldKey, newKey] of futuristicToV2) {
+    if (saved[oldKey] !== undefined && saved[newKey] === undefined) {
+      saved[newKey] = saved[oldKey]
+    }
+    delete saved[oldKey]
+  }
 }
 
 /** Settings UI metadata for {@link RENDERER_DEFAULT_OPTIONS} keys. */
 export const RENDERER_OPTIONS_META: Partial<Record<RendererDefaultOptionKey, RendererOptionMeta>> = {
   menuBackgroundMode: {
-    possibleValues: [['classic', 'Classic'], ['futuristic', 'Futuristic']],
+    possibleValues: [['classic', 'Classic'], ['v2', 'V2']],
     requiresRestart: true
   },
   menuBackgroundMinecraftTextures: {
     text: 'Minecraft block textures',
-    tooltip: 'Use block atlas on futuristic menu cubes (loads assets on menu)'
+    tooltip: 'Use block atlas on V2 menu cubes (loads assets on menu)'
   },
-  menuBackgroundFuturisticScene: {
-    possibleValues: FUTURISTIC_SCENE_IDS.map(id => [id, FUTURISTIC_SCENE_LABELS[id]] as [string, string])
+  menuBackgroundV2Scene: {
+    possibleValues: V2_SCENE_IDS.map(id => [id, V2_SCENE_LABELS[id]] as [string, string])
   },
-  menuBackgroundFuturisticCamera: {
-    possibleValues: FUTURISTIC_CAMERA_IDS.map(id => [id, FUTURISTIC_CAMERA_LABELS[id]] as [string, string])
+  menuBackgroundV2Camera: {
+    possibleValues: V2_CAMERA_IDS.map(id => [id, V2_CAMERA_LABELS[id]] as [string, string])
   },
-  menuBackgroundFuturisticBlockGroup: {
+  menuBackgroundV2BlockGroup: {
     possibleValues: MINECRAFT_BLOCK_GROUP_IDS.map(id => [id, MINECRAFT_BLOCK_GROUP_LABELS[id]] as [string, string]),
     text: 'Block pool',
     tooltip: 'Block set for textured menu cubes (requires Minecraft textures)'
   },
-  menuBackgroundFuturisticCameraSpeed: {
+  menuBackgroundV2CameraSpeed: {
     text: 'Camera speed',
     tooltip: 'Orbit / fly-through camera path speed. 0 freezes the path; mouse parallax still works.',
     min: 0,
     max: 200,
     unit: '%'
   },
-  menuBackgroundFuturisticBlockSpeed: {
+  menuBackgroundV2BlockSpeed: {
     text: 'Block speed',
     tooltip: 'Floating blocks and sky rotation. Independent of camera path speed.',
     min: 0,
@@ -315,11 +332,11 @@ export const RENDERER_RENDER_GUI_SECTIONS: ReadonlyArray<{
       keys: [
         'menuBackgroundMode',
         'menuBackgroundMinecraftTextures',
-        'menuBackgroundFuturisticScene',
-        'menuBackgroundFuturisticCamera',
-        'menuBackgroundFuturisticBlockGroup',
-        'menuBackgroundFuturisticCameraSpeed',
-        'menuBackgroundFuturisticBlockSpeed'
+        'menuBackgroundV2Scene',
+        'menuBackgroundV2Camera',
+        'menuBackgroundV2BlockGroup',
+        'menuBackgroundV2CameraSpeed',
+        'menuBackgroundV2BlockSpeed'
       ]
     },
     {

package/src/graphicsBackend/rendererOptionsSync.ts

@@ -11,7 +11,7 @@ import { rendererShaderCubeDebugModeToValue } from './rendererDefaultOptions'
 import type { MenuBackgroundOptions } from '../three/menuBackground/types'
 import type { MenuBackgroundRenderer } from '../three/menuBackground/renderer'
 import { menuBackgroundSpeedToMultiplier } from '../three/menuBackground/config'
-import type { FuturisticCameraId, FuturisticSceneId, MinecraftBlockGroupId } from '../three/menuBackground/futuristic'
+import type { V2CameraId, V2SceneId, MinecraftBlockGroupId } from '../three/menuBackground/v2'
 import { setSkinsConfig } from '../lib/utils/skins'
 
 export type { RendererStorageOptions } from './rendererDefaultOptions'
@@ -37,20 +37,20 @@ export function menuBackgroundOptionsFromStorage(o: Pick<
   RendererStorageOptions,
   | 'menuBackgroundMode'
   | 'menuBackgroundMinecraftTextures'
-  | 'menuBackgroundFuturisticScene'
-  | 'menuBackgroundFuturisticCamera'
-  | 'menuBackgroundFuturisticBlockGroup'
-  | 'menuBackgroundFuturisticCameraSpeed'
-  | 'menuBackgroundFuturisticBlockSpeed'
+  | 'menuBackgroundV2Scene'
+  | 'menuBackgroundV2Camera'
+  | 'menuBackgroundV2BlockGroup'
+  | 'menuBackgroundV2CameraSpeed'
+  | 'menuBackgroundV2BlockSpeed'
 >): MenuBackgroundOptions {
   return {
     mode: o.menuBackgroundMode as MenuBackgroundOptions['mode'],
     useMinecraftTextures: o.menuBackgroundMinecraftTextures,
-    futuristicScene: o.menuBackgroundFuturisticScene as FuturisticSceneId,
-    futuristicCamera: o.menuBackgroundFuturisticCamera as FuturisticCameraId,
-    futuristicBlockGroup: o.menuBackgroundFuturisticBlockGroup as MinecraftBlockGroupId,
-    futuristicCameraSpeed: menuBackgroundSpeedToMultiplier(o.menuBackgroundFuturisticCameraSpeed),
-    futuristicBlockSpeed: menuBackgroundSpeedToMultiplier(o.menuBackgroundFuturisticBlockSpeed),
+    v2Scene: o.menuBackgroundV2Scene as V2SceneId,
+    v2Camera: o.menuBackgroundV2Camera as V2CameraId,
+    v2BlockGroup: o.menuBackgroundV2BlockGroup as MinecraftBlockGroupId,
+    v2CameraSpeed: menuBackgroundSpeedToMultiplier(o.menuBackgroundV2CameraSpeed),
+    v2BlockSpeed: menuBackgroundSpeedToMultiplier(o.menuBackgroundV2BlockSpeed),
   }
 }
 
@@ -58,20 +58,20 @@ export function applyMenuBackgroundLiveOptions(
   menu: MenuBackgroundRenderer,
   o: Pick<
     RendererStorageOptions,
-    | 'menuBackgroundFuturisticScene'
-    | 'menuBackgroundFuturisticCamera'
-    | 'menuBackgroundFuturisticBlockGroup'
-    | 'menuBackgroundFuturisticCameraSpeed'
-    | 'menuBackgroundFuturisticBlockSpeed'
+    | 'menuBackgroundV2Scene'
+    | 'menuBackgroundV2Camera'
+    | 'menuBackgroundV2BlockGroup'
+    | 'menuBackgroundV2CameraSpeed'
+    | 'menuBackgroundV2BlockSpeed'
   >
 ): void {
-  const futuristic = menu.futuristic
-  if (!futuristic) return
-  futuristic.setScene?.(o.menuBackgroundFuturisticScene)
-  futuristic.setCamera?.(o.menuBackgroundFuturisticCamera)
-  void futuristic.setBlockGroup?.(o.menuBackgroundFuturisticBlockGroup)
-  futuristic.setCameraSpeed?.(menuBackgroundSpeedToMultiplier(o.menuBackgroundFuturisticCameraSpeed))
-  futuristic.setBlockSpeed?.(menuBackgroundSpeedToMultiplier(o.menuBackgroundFuturisticBlockSpeed))
+  const v2 = menu.v2
+  if (!v2) return
+  v2.setScene?.(o.menuBackgroundV2Scene)
+  v2.setCamera?.(o.menuBackgroundV2Camera)
+  void v2.setBlockGroup?.(o.menuBackgroundV2BlockGroup)
+  v2.setCameraSpeed?.(menuBackgroundSpeedToMultiplier(o.menuBackgroundV2CameraSpeed))
+  v2.setBlockSpeed?.(menuBackgroundSpeedToMultiplier(o.menuBackgroundV2BlockSpeed))
 }
 
 function resolveWasmMesherActive(o: RendererStorageOptions): boolean {

package/src/graphicsBackend/types.ts

@@ -58,7 +58,7 @@ export interface NonReactiveState {
   worstRenderTime: number
   avgRenderTime: number
   world: {
-    chunksLoaded: Set<string>
+    chunksLoadedCount: number
     chunksTotalNumber: number
     chunksFullInfo: string
     allChunksLoaded?: boolean
@@ -75,8 +75,8 @@ export interface NonReactiveState {
 /** Renderer reactive state */
 export interface RendererReactiveState {
   world: {
-    chunksLoaded: Set<string>
-    heightmaps: Map<string, Int16Array>
+    chunksLoaded: Record<string, true>
+    heightmaps: Record<string, Int16Array>
     allChunksLoaded: boolean
     mesherWork: boolean
     /** Low-FPS / render instability factors (see `performanceMonitor`). */

package/src/index.ts

@@ -85,21 +85,21 @@ export type {
   MenuBackgroundMode,
   MenuBackgroundOptions,
   MenuBackgroundView,
-  FuturisticSceneId,
-  FuturisticCameraId,
-  FuturisticMenuBackgroundOptions,
+  V2SceneId,
+  V2CameraId,
+  V2MenuBackgroundOptions,
   MinecraftBlockGroupId
 } from './three/menuBackground'
 export {
   MenuBackgroundRenderer,
   ClassicMenuBackground,
-  FuturisticMenuBackground,
+  V2MenuBackground,
   WorldBlocksMenuBackground,
   MENU_BACKGROUND_MC_VERSION,
-  FUTURISTIC_SCENE_IDS,
-  FUTURISTIC_CAMERA_IDS,
-  FUTURISTIC_SCENE_LABELS,
-  FUTURISTIC_CAMERA_LABELS,
+  V2_SCENE_IDS,
+  V2_CAMERA_IDS,
+  V2_SCENE_LABELS,
+  V2_CAMERA_LABELS,
   MINECRAFT_BLOCK_GROUPS,
   MINECRAFT_BLOCK_GROUP_IDS,
   MINECRAFT_BLOCK_GROUP_LABELS,

package/src/lib/bindAbortableListener.test.ts

@@ -0,0 +1,65 @@
+//@ts-nocheck
+import { EventEmitter } from 'events'
+import { describe, expect, it } from 'vitest'
+import { bindAbortableEmitterListener, bindAbortableListener } from './bindAbortableListener'
+import { WorldViewWorker } from '../worldView'
+
+describe('bindAbortableListener', () => {
+  it('removes handler on abort', () => {
+    const emitter = new WorldViewWorker()
+    const controller = new AbortController()
+    let calls = 0
+    bindAbortableListener(emitter, 'renderDistance', () => {
+      calls++
+    }, controller.signal)
+
+    emitter.emit('renderDistance', 8)
+    expect(calls).toBe(1)
+
+    controller.abort()
+    emitter.emit('renderDistance', 12)
+    expect(calls).toBe(1)
+  })
+
+  it('abort removes only the bound handler on a shared emitter', () => {
+    const emitter = new WorldViewWorker()
+    const controllerA = new AbortController()
+    const controllerB = new AbortController()
+    let callsA = 0
+    let callsB = 0
+
+    bindAbortableListener(emitter, 'renderDistance', () => {
+      callsA++
+    }, controllerA.signal)
+    bindAbortableListener(emitter, 'renderDistance', () => {
+      callsB++
+    }, controllerB.signal)
+
+    emitter.emit('renderDistance', 4)
+    expect(callsA).toBe(1)
+    expect(callsB).toBe(1)
+
+    controllerA.abort()
+    emitter.emit('renderDistance', 6)
+    expect(callsA).toBe(1)
+    expect(callsB).toBe(2)
+  })
+})
+
+describe('bindAbortableEmitterListener', () => {
+  it('removes handler on abort', () => {
+    const emitter = new EventEmitter()
+    const controller = new AbortController()
+    let calls = 0
+    bindAbortableEmitterListener(emitter, 'test', () => {
+      calls++
+    }, controller.signal)
+
+    emitter.emit('test')
+    expect(calls).toBe(1)
+
+    controller.abort()
+    emitter.emit('test')
+    expect(calls).toBe(1)
+  })
+})

package/src/lib/bindAbortableListener.ts

@@ -0,0 +1,41 @@
+//@ts-nocheck
+import type { EventEmitter } from 'events'
+import type { WorldViewEvents } from '../worldView/types'
+import type { WorldViewWorker } from '../worldView'
+
+/**
+ * Register an EventEmitter listener removed when `signal` aborts.
+ * Safe for shared emitters (e.g. worldView) — only removes this handler.
+ */
+export function bindAbortableListener<E extends keyof WorldViewEvents>(
+  emitter: Pick<WorldViewWorker, 'on' | 'off'>,
+  event: E,
+  handler: (...args: WorldViewEvents[E]) => void,
+  signal: AbortSignal
+): void {
+  emitter.on(event, handler as (...args: any[]) => void)
+  if (signal.aborted) {
+    emitter.off(event, handler as (...args: any[]) => void)
+    return
+  }
+  signal.addEventListener('abort', () => {
+    emitter.off(event, handler as (...args: any[]) => void)
+  }, { once: true })
+}
+
+/** Same pattern for plain EventEmitters (e.g. resourcesManager). */
+export function bindAbortableEmitterListener(
+  emitter: Pick<EventEmitter, 'on' | 'off'>,
+  event: string,
+  handler: (...args: any[]) => void,
+  signal: AbortSignal
+): void {
+  emitter.on(event, handler)
+  if (signal.aborted) {
+    emitter.off(event, handler)
+    return
+  }
+  signal.addEventListener('abort', () => {
+    emitter.off(event, handler)
+  }, { once: true })
+}