@threedog/terrain-noise 0.1.0 → 0.5.0

package/README.md

@@ -0,0 +1,20 @@
+# @threedog/terrain-noise
+
+Optional terrain generator for [threedog](https://www.npmjs.com/package/threedog): noise hills, `island`, `canyon` or `plain` shapes, rivers and a biome rule table. It decides the shape of the world only; ground colors belong to the game's style (keyed by the biome names). Without it the engine's ground is flat.
+
+```sh
+npm install @threedog/terrain-noise@0.5
+```
+
+This describes 0.5.0: `npm install @threedog/terrain-noise@0.5` (games made in the [repository](https://github.com/penstic123-code/ThreeDog.js-Game-Engine) already have it).
+
+```js
+import { openWorld } from 'threedog';
+import { terrainPreset } from '@threedog/terrain-noise';
+
+engine.use(openWorld({ seed: 7, camera: 'follow', terrain: terrainPreset({ shape: 'island' }) }));
+```
+
+Also exported: `riverAt(x, z, n)`, `BIOMES` (the default rule table) and `terrainStrings`. Types are in `index.d.ts`. The height and ground-type functions run in terrain workers, so a game's own replacements must be pure (read only their parameters and `Math`).
+
+Docs ship with the engine: `node_modules/threedog/docs/AI.md` and `docs/recipes/`. Peer dependency: `threedog`. MIT license.

package/index.js

@@ -3,9 +3,9 @@
 // ground; a game passes this preset (or its own height / groundType functions) explicitly:
 //   import { terrainPreset } from '@threedog/terrain-noise';
 //   engine.use(openWorld({ seed: 7, camera: 'follow', terrain: terrainPreset({ shape: 'island' }) }));
-// Why its own package and not part of a style pack: the shape of the world (where hills, rivers and forests are) is gameplay, and a style
-// pack holds looks only (packages/engine/docs/recipes/09-style-pack.md). Swapping the look must never move a river. The colors of these ground types belong
-// to whichever style pack the game uses (lowpoly: style.terrain.biomeColors, keyed by the names below).
+// Why its own package and not part of a style: the shape of the world (where hills, rivers and forests are) is gameplay, and a style
+// pack holds looks only (packages/engine/docs/recipes/09-style.md). Swapping the look must never move a river. The colors of these ground types belong
+// to whichever style the game uses (e.g. style.terrain.biomeColors, keyed by the names below).
 // height and groundType run in terrain workers, so they are pure: they read only their parameters (n.params is the options below) and Math.
 // The ground type names are plain strings that vegetation rules, style colors and a game's footstep map match by name.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@threedog/terrain-noise",
-  "version": "0.1.0",
+  "version": "0.5.0",
   "description": "Optional terrain generator for threedog: noise hills, island, canyon or plain shapes, rivers and a biome rule table (world shape only, no colors)",
   "license": "MIT",
   "repository": {
@@ -10,6 +10,9 @@
   },
   "homepage": "https://github.com/penstic123-code/ThreeDog.js-Game-Engine#readme",
   "type": "module",
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {
@@ -24,6 +27,6 @@
     "*.d.ts"
   ],
   "peerDependencies": {
-    "threedog": "^0.1.0"
+    "threedog": "^0.5.0"
   }
 }