@stowkit/three-loader 0.1.13 → 0.1.14

package/README.md

@@ -16,10 +16,10 @@ import { StowKitLoader } from '@stowkit/three-loader';
 // Load a pack (auto-initializes with defaults)
 const pack = await StowKitLoader.load('assets.stow');
 
-// Load assets by name - simple and clean!
-const mesh = await pack.loadMesh('models/character');
-const texture = await pack.loadTexture('textures/wood');
-const audio = await pack.loadAudio('sounds/bgm', audioListener);
+// Load assets by name
+const mesh = await pack.loadMesh('character');
+const texture = await pack.loadTexture('wood');
+const audio = await pack.loadAudio('bgm', audioListener);
 
 // Use in Three.js
 scene.add(mesh);
@@ -94,18 +94,19 @@ Once you have a pack loaded, use these methods to load assets:
 
 ### Loading Meshes
 
-#### `pack.loadMesh(assetPath: string): Promise<THREE.Group>`
+#### `pack.loadMesh(stringId: string): Promise<THREE.Group>`
 
-Load a mesh by its canonical path/name. Automatically loads and applies textures and materials.
+Load a mesh by its string ID (the canonical path used when packing). Automatically loads and applies textures and materials.
 
 ```typescript
-const character = await pack.loadMesh('models/character');
-const tree = await pack.loadMesh('models/tree');
-const building = await pack.loadMesh('models/building');
+// String IDs are whatever you used when packing the assets
+const cookingStation = await pack.loadMesh('restaurant_display_cooking_station');
+const door = await pack.loadMesh('restaurant_display_door');
+const physics = await pack.loadMesh('restaurant_physics');
 
-scene.add(character);
-scene.add(tree);
-scene.add(building);
+scene.add(cookingStation);
+scene.add(door);
+scene.add(physics);
 ```
 
 **What you get:**
@@ -117,32 +118,37 @@ scene.add(building);
 
 ### Loading Textures
 
-#### `pack.loadTexture(assetPath: string): Promise<THREE.CompressedTexture>`
+#### `pack.loadTexture(stringId: string): Promise<THREE.CompressedTexture>`
 
-Load a KTX2 texture by its canonical path/name.
+Load a KTX2 texture by its string ID (the canonical path used when packing).
 
 ```typescript
-const wood = await pack.loadTexture('textures/wood');
-const metal = await pack.loadTexture('textures/metal');
+const shadow = await pack.loadTexture('_shadow');
+const atlas = await pack.loadTexture('zy_Atlas');
 
-material.map = wood;
-material.roughnessMap = metal;
+shadowMaterial.map = shadow;
+particleMaterial.map = atlas;
 material.needsUpdate = true;
 ```
 
 ### Loading Audio
 
-#### `loadAudio(url: string, assetPath: string, listener: THREE.AudioListener, onLoad?, onProgress?, onError?): Promise<THREE.Audio>`
+#### `pack.loadAudio(stringId: string, listener: THREE.AudioListener): Promise<THREE.Audio>`
 
-Load an audio asset as a Three.js Audio object.
+Load audio by its string ID (the canonical path used when packing).
 
 ```typescript
 const listener = new THREE.AudioListener();
 camera.add(listener);
 
-const audio = await loader.loadAudio('', 'sounds/bgm.ogg', listener);
-audio.setLoop(true);
-audio.play();
+const bgm = await pack.loadAudio('track_01', listener);
+bgm.setLoop(true);
+bgm.setVolume(0.5);
+bgm.play();
+
+// More audio
+const click = await pack.loadAudio('click', listener);
+const cashRegister = await pack.loadAudio('cash register', listener);
 ```
 
 #### `createAudioPreview(index: number): Promise<HTMLAudioElement>`
@@ -388,15 +394,15 @@ const mesh = await loader.loadMesh('', 'models/character.mesh');
 // Load pack once
 const pack = await StowKitLoader.load('assets.stow');
 
-// Load many assets by name
-const char1 = await pack.loadMesh('models/char1');
-const char2 = await pack.loadMesh('models/char2');
-const tex1 = await pack.loadTexture('textures/diffuse');
-const tex2 = await pack.loadTexture('textures/normal');
-const bgm = await pack.loadAudio('sounds/bgm', listener);
+// Load many assets (using whatever string IDs you assigned when packing)
+const station = await pack.loadMesh('restaurant_display_cooking_station');
+const door = await pack.loadMesh('restaurant_display_door');
+const shadow = await pack.loadTexture('_shadow');
+const atlas = await pack.loadTexture('zy_Atlas');
+const music = await pack.loadAudio('track_01', listener);
 
-scene.add(char1);
-scene.add(char2);
+scene.add(station);
+scene.add(door);
 ```
 
 ### Inspect Before Loading

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stowkit/three-loader",
-  "version": "0.1.13",
+  "version": "0.1.14",
   "description": "Three.js loader for StowKit asset packs",
   "main": "dist/stowkit-three-loader.js",
   "module": "dist/stowkit-three-loader.esm.js",