genshin-engine 4.3.1 → 4.4.0

package/README.md

@@ -9,10 +9,12 @@ An anime-style open-world engine for the browser on three.js's WebGPU renderer:
 
 It is an unofficial, non-commercial fan engine, not affiliated with HoYoverse. It ships no asset from any game: every mesh, texture, shader and sound is generated by its own code.
 
+Design notes live in [the specs](https://github.com/Esposter/Esposter/tree/main/openspec/specs/genshin).
+
 ## Table of Contents
 
 - 🚀 [Getting Started](#getting-started)
-- 📖 [Documentation](#documentation)
+- 🧩 [Key Exports](#key-exports)
 - ⚖️ [License](#license)
 
 ---
@@ -69,9 +71,22 @@ renderer.setAnimationLoop(() => renderPipeline.render());
 
 A web worker generating the ground imports its generators from the `genshin-engine/terrainWorker` subpath instead, `computeTerrainTile` and the height, paint and scatter functions it runs over, which reach three's math and none of the renderer, so the worker starts without loading it.
 
-## <a name="documentation">📖 Documentation</a>
-
-We highly recommend you take a look at the [documentation](https://github.com/Esposter/Esposter/tree/main/openspec/specs/genshin) to level up. The engine's design, from the order a frame runs in to each module's job, is its [architecture page](https://github.com/Esposter/Esposter/blob/main/openspec/specs/genshin/engine-architecture/design.md), and the look it draws is its [rendering style](https://github.com/Esposter/Esposter/blob/main/openspec/specs/genshin/rendering-style/design.md).
+## <a name="key-exports">🧩 Key Exports</a>
+
+| Export                   | Kind     | Purpose                                                                                             |
+| ------------------------ | -------- | --------------------------------------------------------------------------------------------------- |
+| `computeTerrainTile`     | function | Samples one terrain tile's grid, normals and colours from the region's heights                      |
+| `createFogUniforms`      | function | One set of fog uniforms per world, read by the fog pass                                             |
+| `createGenshinRenderer`  | function | A three.js WebGPU renderer, falling back to WebGL 2 where WebGPU is missing                         |
+| `createGodraysLight`     | function | A second, unlit sun whose one shadow map covers the view for the god rays to march through          |
+| `createGradeLutTexture`  | function | The colour grade's cube as a 3D texture the LUT pass samples                                        |
+| `createLightUniforms`    | function | One set of light uniforms per world, shared by every material                                       |
+| `createPostPipeline`     | function | Builds the frame's post chain over a scene, from outlines to grade and anti-aliasing                |
+| `createPostUniforms`     | function | The post chain's uniforms: outline colour and thickness, god-ray colour, grade and white balance    |
+| `createRampTexture`      | function | A one-row texture of the irradiance the toon lighting steps between                                 |
+| `createToonMaterial`     | function | The environment's toon material, stepping from shade to lit on the world's ramp, with the sky's rim |
+| `QualityTier`            | enum     | The three quality tiers a renderer's cost is set by                                                 |
+| `QualityTierSettingsMap` | const    | What each quality tier spends: shadow maps, cascades, god-ray steps, bloom and anti-aliasing        |
 
 ## <a name="license">⚖️ License</a>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "genshin-engine",
-  "version": "4.3.1",
+  "version": "4.4.0",
   "description": "An anime-style open-world engine for the browser on three.js WebGPU — toon materials, outlines, post-processing, streamed terrain, parametric world kits and a Web Audio synthesizer, as plain TypeScript and TSL modules.",
   "keywords": [
     "anime",
@@ -48,21 +48,21 @@
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
     "test": "vitest",
-    "typecheck": "tsc"
+    "typecheck": "tsrs --fast"
   },
   "dependencies": {
-    "three-mesh-bvh": "^0.9.16"
+    "three-mesh-bvh": "^0.9.17"
   },
   "devDependencies": {
-    "@esposter/configuration": "4.3.1",
-    "@esposter/shared-node": "4.3.1",
-    "@types/node": "^26.6.5",
+    "@esposter/configuration": "4.4.0",
+    "@esposter/shared-node": "4.4.0",
+    "@types/node": "^26.6.6",
     "@types/three": "^0.186.0",
-    "tsdown": "^0.23.1",
-    "vite": "^8.3.4"
+    "tsdown": "0.23.2",
+    "vite": "^8.3.5"
   },
   "peerDependencies": {
     "three": "^0.186.1"
   },
-  "gitHead": "777a39636b789c13af33ed13370246ccf6dbaf31"
+  "gitHead": "e1a416c4b91da69cc2aa259b50a4d656f204d272"
 }