@ignifx/2d 0.18.0 → 0.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ignifx/2d",
3
- "version": "0.18.0",
3
+ "version": "0.20.0",
4
4
  "description": "ignifx 2D toolkit: Camera2D, sprites, sprite animation, atlases, tilemaps, sorting layers, pixel-perfect, parallax.",
5
5
  "keywords": [
6
6
  "ignifx",
@@ -43,11 +43,11 @@
43
43
  "typedoc-plugin-markdown": "^4.13.0",
44
44
  "typescript-native": "npm:typescript@7.0.2",
45
45
  "vitest": "^5.0.0",
46
- "@ignifx/core": "0.18.0"
46
+ "@ignifx/core": "0.20.0"
47
47
  },
48
48
  "peerDependencies": {
49
49
  "@babylonjs/lite": "1.34.0",
50
- "@ignifx/core": "0.18.0"
50
+ "@ignifx/core": "0.20.0"
51
51
  },
52
52
  "ignifx": {
53
53
  "extension": true,
@@ -3,7 +3,7 @@ name: 2d
3
3
  description: Builds 2D games in ignifx with @ignifx/2d: Camera2D, SpriteRenderer, SpriteAnimator, texture atlases, Tilemap rendering and import, sorting layers and Y-sort, pixel-perfect cameras, parallax layers, sprite batches, and 2D picking. Use when adding or editing sprites, sprite animation, tilemaps, atlases, sorting layers, sprite batches, or a 2D camera in an ignifx project, or when the user mentions @ignifx/2d, Camera2D, SpriteRenderer, SpriteBatch, or Tilemap.
4
4
  license: Apache-2.0
5
5
  metadata:
6
- ignifx-version: "0.18.0"
6
+ ignifx-version: "0.20.0"
7
7
  ---
8
8
 
9
9
  # @ignifx/2d
@@ -21,7 +21,7 @@ parse, `SpriteAnimator` advances on the stepped clock. Only the pixels need a GP
21
21
 
22
22
  ## Environment
23
23
 
24
- - Engine: ignifx `0.18.0`; this package targets `@ignifx/core` `>=0.0.0 <1.0.0`.
24
+ - Engine: ignifx `0.20.0`; this package targets `@ignifx/core` `>=0.0.0 <1.0.0`.
25
25
  - WebGPU only, browser and Electron. Babylon Lite `1.34.0` is a peer dependency.
26
26
  - Register it like any extension; nothing happens at import time.
27
27
 
@@ -243,6 +243,58 @@ ignifx import tilemap assets/maps/cave.tmj --pixels-per-unit 16
243
243
  ignifx import tilemap assets/maps/world.ldtk assets/levels --pixels-per-unit 16
244
244
  ```
245
245
 
246
+ A tool that imports maps itself, such as an editor, calls the same conversion without the file
247
+ system: `convertTilemapSource` from `@ignifx/cli/tilemap` takes the map's text, its kind (`"tiled"` or
248
+ `"ldtk"`) and an async `read(path)` for the files the map references (`null` when absent), and
249
+ returns the documents to write (`{ path, kind, json, text }`) and the warnings. Paths are POSIX
250
+ paths relative to one base folder; `options.path` is the map's. It refuses a map past
251
+ `DEFAULT_TILEMAP_SOURCE_LIMITS` (map and layer cells, layers, tiles per tileset, levels, JSON
252
+ length) with `IGX-1408` before allocating for it; `options.limits` changes the caps.
253
+
254
+ ```ts ignore-check
255
+ import { convertTilemapSource } from "@ignifx/cli/tilemap";
256
+ import { readFile } from "node:fs/promises";
257
+
258
+ const text = await readFile("assets/maps/cave.tmj", "utf8");
259
+ const { documents, warnings } = await convertTilemapSource(
260
+ text,
261
+ "tiled",
262
+ async (path) => readFile(path, "utf8").catch(() => null),
263
+ { path: "assets/maps/cave.tmj", pixelsPerUnit: 16 },
264
+ );
265
+ // Each document's path is relative to the base folder, here the working directory.
266
+ ```
267
+
268
+ ### A map built in code
269
+
270
+ `createTilemapAsset(app, input, { address })` publishes a map generated at run time, in the same
271
+ shape a `.tilemap.json` holds, and checks it the way the loader does (a bad grid throws `IGX-1105`).
272
+ `address` is what the tilesets' `atlas` references resolve against; without it they are read as
273
+ project-root addresses. The handle is a `memory:` asset, so a scene saved with it writes `null`.
274
+
275
+ ```ts
276
+ import { createTilemapAsset, Tilemap, TilemapRenderer } from "ignifx";
277
+ import type { App, AssetHandle, SpriteAtlasAsset } from "ignifx";
278
+
279
+ /** A one-row strip of alternating tiles, for a generated level. */
280
+ export function buildStrip(app: App, atlas: AssetHandle<SpriteAtlasAsset>, width: number): void {
281
+ const tiles: number[] = [];
282
+ for (let x = 0; x < width; x += 1) {
283
+ tiles.push(1 + (x % 2));
284
+ }
285
+ const map = createTilemapAsset(app, {
286
+ tileWidth: 16,
287
+ width,
288
+ height: 1,
289
+ tilesets: [{ name: "terrain", atlas: "2d/terrain.atlas.json", firstId: 1, tiles: [] }],
290
+ layers: [{ name: "Ground", tiles, collision: true }],
291
+ });
292
+ const level = app.world.createEntity("Level");
293
+ level.addComponent(Tilemap).map = map;
294
+ level.addComponent(TilemapRenderer).atlas = atlas;
295
+ }
296
+ ```
297
+
246
298
  ### Picking a sprite under the pointer
247
299
 
248
300
  ```ts run