minecraft-renderer 0.1.106 → 0.1.108

package/package.json

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

package/src/bundler/bundlePrepare.test.ts

@@ -0,0 +1,25 @@
+//@ts-nocheck
+import { mkdtemp, readFile, writeFile } from 'node:fs/promises'
+import { tmpdir } from 'node:os'
+import { join } from 'node:path'
+import { describe, expect, it } from 'vitest'
+import { bundlePrepareMesherWorkers, MESHER_DIST_FILES } from './bundlePrepare'
+
+describe('MESHER_DIST_FILES', () => {
+  it('is the source of truth for lightOwnerWorker.js', () => {
+    expect(MESHER_DIST_FILES).toContain('lightOwnerWorker.js')
+    expect(MESHER_DIST_FILES).toContain('lightOwnerWorker.js.map')
+  })
+
+  it('copies lightOwnerWorker.js from renderer dist', async () => {
+    const mesherDistDir = await mkdtemp(join(tmpdir(), 'renderer-dist-'))
+    const outDir = await mkdtemp(join(tmpdir(), 'app-dist-'))
+    for (const name of MESHER_DIST_FILES) {
+      await writeFile(join(mesherDistDir, name), `asset:${name}`)
+    }
+
+    const copied = await bundlePrepareMesherWorkers({ cwd: outDir, mesherDistDir, outDir })
+    expect(copied.some(path => path.endsWith('lightOwnerWorker.js'))).toBe(true)
+    expect(await readFile(join(outDir, 'lightOwnerWorker.js'), 'utf8')).toBe('asset:lightOwnerWorker.js')
+  })
+})

package/src/bundler/bundlePrepare.ts

@@ -4,7 +4,7 @@ import { createRequire } from 'node:module'
 import path from 'node:path'
 
 /** Worker-related basenames inside `minecraft-renderer`/`dist`; skipped if missing. */
-export const MESHER_DIST_FILES = ['mesher.js', 'mesher.js.map', 'mesherWasm.js', 'mesherWasm.js.map'] as const
+export const MESHER_DIST_FILES = ['mesher.js', 'mesher.js.map', 'mesherWasm.js', 'mesherWasm.js.map', 'lightOwnerWorker.js', 'lightOwnerWorker.js.map'] as const
 
 export type BundlePrepareMesherOptions = {
   cwd?: string

package/src/graphicsBackend/appViewer.ts

@@ -25,6 +25,7 @@ import type {
 import { WorldView, WorldProvider, WorldViewWorker } from '../worldView'
 import { getInitialPlayerState } from './playerState'
 import { defaultWorldRendererConfig, defaultGraphicsBackendConfig, getDefaultRendererState, WorldRendererConfig } from './config'
+import { maybeEnableClientLightTraceFromLocation } from '../lighting/debug/clientLightTrace'
 import { PlayerStateReactive } from '../playerState/playerState'
 import { ResourcesManager, ResourcesManagerTransferred } from '../resourcesManager'
 import { preloadMesherWorkerScript } from './preloadWorkers'
@@ -102,6 +103,20 @@ export class AppViewer {
       ...defaultWorldRendererConfig,
       ...options.rendererConfig
     })
+    // Manual live-test hatch: `?clientLight=1` sets `enableClientLightOwner`. Spawn still
+    // requires session version 1.17.1 (`shouldSpawnClientLightOwner`); other versions keep
+    // server light. An explicit code override always wins; without a browser location this
+    // is a no-op (unit tests keep testing the default).
+    if (options.rendererConfig?.enableClientLightOwner === undefined && typeof location !== 'undefined') {
+      try {
+        if (new URLSearchParams(location.search).get('clientLight') === '1') {
+          this.inWorldRenderingConfig.enableClientLightOwner = true
+        }
+      } catch {
+        // ignore malformed URL in non-browser runtimes
+      }
+    }
+    maybeEnableClientLightTraceFromLocation()
 
     const defaultState = getDefaultRendererState()
     this.rendererState = defaultState.reactive

package/src/graphicsBackend/config.ts

@@ -43,6 +43,11 @@ export const defaultWorldRendererConfig = {
    * remeshing (change worker). When true, initial chunk meshing is
    * distributed only across workers[0 .. n-2]. */
   dedicatedChangeWorker: false,
+  /**
+   * Dedicated WASM light-owner worker. Default OFF: wiring exists so a
+   * human can flip this for live 1.17.1 runs. Do not enable for players.
+   */
+  enableClientLightOwner: false,
 
   // Rendering engine settings
   /** Face shading: vanilla Minecraft vs higher-contrast client look */
@@ -54,6 +59,9 @@ export const defaultWorldRendererConfig = {
   enableLighting: true,
   starfield: true,
   defaultSkybox: true,
+  clouds: true,
+  /** World Y of the cloud layer (vanilla overworld: 192 since 1.18, 128 before). */
+  cloudHeight: 192,
   renderEntities: true,
   extraBlockRenderers: true,
   foreground: true,

package/src/graphicsBackend/rendererDefaultOptions.test.ts

@@ -0,0 +1,51 @@
+//@ts-nocheck
+import { describe, expect, it } from 'vitest'
+import { migrateRendererOptions, RENDERER_DEFAULT_OPTIONS, resolveEnableLighting } from './rendererDefaultOptions'
+
+describe('migrateRendererOptions', () => {
+  it('drops the leaked migration flag so it is not a user option', () => {
+    const saved: Record<string, unknown> = {
+      newVersionsLighting: false,
+      migratedNewVersionsLightingDefault: true
+    }
+    migrateRendererOptions(saved)
+    expect(saved.newVersionsLighting).toBe(false)
+    expect(saved).not.toHaveProperty('migratedNewVersionsLightingDefault')
+  })
+})
+
+describe('newer-version lighting defaults', () => {
+  it('keeps lighting opt-in on 1.13+', () => {
+    expect(RENDERER_DEFAULT_OPTIONS.newVersionsLighting).toBe(false)
+    expect(resolveEnableLighting(RENDERER_DEFAULT_OPTIONS.newVersionsLighting, true)).toBe(false)
+  })
+
+  it.each([false, true])('preserves a saved lighting preference (%s)', value => {
+    const saved: Record<string, unknown> = { newVersionsLighting: value }
+    migrateRendererOptions(saved)
+    expect(saved.newVersionsLighting).toBe(value)
+  })
+
+  it('does not invent a stored value when the key was never saved', () => {
+    const saved: Record<string, unknown> = {}
+    migrateRendererOptions(saved)
+    expect(saved).not.toHaveProperty('newVersionsLighting')
+  })
+})
+
+describe('resolveEnableLighting', () => {
+  it('follows the option on 1.13+ (blockStateId)', () => {
+    expect(resolveEnableLighting(true, true)).toBe(true)
+    expect(resolveEnableLighting(false, true)).toBe(false)
+  })
+
+  it('always enables lighting on pre-1.13', () => {
+    expect(resolveEnableLighting(false, false)).toBe(true)
+    expect(resolveEnableLighting(true, false)).toBe(true)
+  })
+
+  it('treats a missing protocol probe as pre-1.13 so a menu toggle cannot throw', () => {
+    expect(resolveEnableLighting(false, undefined)).toBe(true)
+    expect(resolveEnableLighting(true, undefined)).toBe(true)
+  })
+})

package/src/graphicsBackend/rendererDefaultOptions.ts

@@ -46,6 +46,7 @@ export const RENDERER_DEFAULT_OPTIONS = {
   rendererWorldPerformance: 'normal' as 'low-energy' | 'normal' | 'maximum',
   rendererMeshersCountOverride: null as number | null,
   starfieldRendering: true as boolean,
+  cloudsRendering: true as boolean,
   defaultSkybox: true as boolean,
   menuBackgroundMode: MB.mode,
   menuBackgroundMinecraftTextures: MB.minecraftTextures as boolean,
@@ -122,6 +123,17 @@ export function migrateRendererOptions(saved: Record<string, unknown>): void {
     }
     delete saved[oldKey]
   }
+
+  // Internal one-shot flag from an earlier lighting-default migration. Never a user option.
+  delete saved.migratedNewVersionsLightingDefault
+}
+
+/**
+ * Runtime `enableLighting` from the stored option and protocol.
+ * Pre-1.13 (no blockStateId) always lights. Missing protocol (menu, no bot) must not throw.
+ */
+export function resolveEnableLighting(newVersionsLighting: boolean, blockStateIdSupported: boolean | undefined): boolean {
+  return blockStateIdSupported !== true || newVersionsLighting
 }
 
 /** Settings UI metadata for {@link RENDERER_DEFAULT_OPTIONS} keys. */
@@ -175,6 +187,9 @@ export const RENDERER_OPTIONS_META: Partial<Record<RendererDefaultOptionKey, Ren
   starfieldRendering: {
     text: 'Starfield'
   },
+  cloudsRendering: {
+    text: 'Clouds'
+  },
   defaultSkybox: {
     text: 'Default skybox'
   },
@@ -236,7 +251,8 @@ export const RENDERER_OPTIONS_META: Partial<Record<RendererDefaultOptionKey, Ren
   },
   smoothLighting: {},
   newVersionsLighting: {
-    text: 'Lighting in newer versions'
+    text: 'Lighting in newer versions',
+    tooltip: 'Block, sky, and entity lighting for 1.13+. Off renders the world fullbright.'
   },
   vrSupport: {
     text: 'VR support',
@@ -298,6 +314,7 @@ export const RENDERER_RENDER_GUI_SECTIONS: ReadonlyArray<{
     keys: [
       'rendererWorldPerformance',
       'starfieldRendering',
+      'cloudsRendering',
       'defaultSkybox',
       'disableBlockEntityTextures',
       'showChunkBorders',

package/src/graphicsBackend/rendererOptionsSync.ts

@@ -7,7 +7,7 @@
 import { subscribe } from 'valtio/vanilla'
 import type { AppViewer } from './appViewer'
 import type { RendererStorageOptions } from './rendererDefaultOptions'
-import { rendererShaderCubeDebugModeToValue } from './rendererDefaultOptions'
+import { rendererShaderCubeDebugModeToValue, resolveEnableLighting } from './rendererDefaultOptions'
 import type { MenuBackgroundOptions } from '../three/menuBackground/types'
 import type { MenuBackgroundRenderer } from '../three/menuBackground/renderer'
 import { menuBackgroundSpeedToMultiplier } from '../three/menuBackground/config'
@@ -153,6 +153,7 @@ export function applyRendererOptions(appViewer: AppViewer, o: RendererStorageOpt
   cfg.smoothLighting = o.smoothLighting
   cfg.shadingTheme = o.vanillaLook ? 'vanilla' : 'high-contrast'
   cfg.starfield = o.starfieldRendering
+  cfg.clouds = o.cloudsRendering
   cfg.defaultSkybox = o.defaultSkybox
   cfg.fov = o.fov
   cfg.shaderCubeDebugMode = rendererShaderCubeDebugModeToValue(o.rendererShaderCubeDebugMode)
@@ -216,6 +217,6 @@ export function subscribeRendererOptions<T extends RendererStorageOptions>(
 }
 
 /** Call when mineflayer bot is created (lighting depends on protocol features). */
-export function applyRendererEnableLighting(appViewer: AppViewer, newVersionsLighting: boolean, blockStateIdSupported: boolean): void {
-  appViewer.inWorldRenderingConfig.enableLighting = !blockStateIdSupported || newVersionsLighting
+export function applyRendererEnableLighting(appViewer: AppViewer, newVersionsLighting: boolean, blockStateIdSupported: boolean | undefined): void {
+  appViewer.inWorldRenderingConfig.enableLighting = resolveEnableLighting(newVersionsLighting, blockStateIdSupported)
 }

package/src/lib/blockEntityLightRegistry.ts

@@ -41,6 +41,10 @@ export class BlockEntityLightRegistry {
     return this.skyLevel
   }
 
+  getLightmapParams(): BlockLightmapParams {
+    return { ...this.lightmapParams }
+  }
+
   private refreshAll(): void {
     for (const entry of this.entries) {
       this.applyBrightness(entry)

package/src/lib/skyLight.ts

@@ -29,6 +29,23 @@ export const getCelestialAngle = (timeOfDay: number): number => {
   return smoothedAngle
 }
 
+/**
+ * Vanilla `DimensionType.timeOfDay`: 0 = noon (sun overhead), 0.25 = sunset, 0.5 = midnight,
+ * ~0.78 at tick 0 (sunrise). Drives sun/moon placement and sky/cloud brightness.
+ */
+export const vanillaCelestialAngle = (timeOfDay: number): number => {
+  const t = timeOfDay / 24_000 - 0.25
+  const d = t - Math.floor(t)
+  const e = 0.5 - Math.cos(d * Math.PI) / 2
+  return (d * 2 + e) / 3
+}
+
+/** Vanilla daylight factor (0 at night, 1 at day) used to tint clouds and celestial bodies. */
+export const vanillaDayBrightness = (celestialAngle: number): number => {
+  const b = Math.cos(celestialAngle * Math.PI * 2) * 2 + 0.5
+  return Math.max(0, Math.min(1, b))
+}
+
 /**
  * Calculate sky light level (0-15) based on time of day in ticks.
  * Matches Minecraft vanilla behavior.