@flare-engine/tilemap

中文文档
0.4.12发布于 2026/11/13Apache-2.0TypeScriptESM + CJS构建来源已验证近 30 天下载 2128

Tiled/LDtk parser, culled tilemap renderer

原始使用文档
文档目录4 节
  1. Install
  2. Usage
  3. Animated tiles
  4. License

@flare-engine/tilemap

Tiled .tmj and LDtk parsing + culled rendering + collider extraction. parseTiled / parseLDtk return a normalized TilemapData; TilemapRenderer owns its own SpriteBatch and only queues tiles inside the camera bounds; drawInto(camera, batch, opts?) queues into a caller-owned batch for single-flush z-ordering with sprites, honouring each layer's opacity and taking an optional shared effect / alphaScale; extractColliders produces collision shapes for @flare-engine/physics; getTileAt / setTileAt read and write one cell of a tile layer, bounds-checked.

Install

bun add @flare-engine/tilemap

Usage

import { parseTiled, TilemapRenderer, extractColliders } from '@flare-engine/tilemap';
import type { SkImageLike } from '@flare-engine/assets';
import { Camera2D } from '@flare-engine/render';

declare const rawMap: unknown;
declare const tilesetImage: SkImageLike;

const data = parseTiled(rawMap);

// renderer takes only the map; images are registered per tileset name
const renderer = new TilemapRenderer(data);
renderer.setTilesetImage('terrain', tilesetImage);

const camera = new Camera2D();
camera.setViewport(800, 600);

// draw culls to camera bounds; flush owns the actual draw calls
renderer.draw(camera, (batch) =>
  batch.flush((image, commands) => {
    // hand off image + commands to your Skia drawAtlas bridge
  }),
);

const colliders = extractColliders(data);

See API spec.

Animated tiles

Tiled per-tile animations are parsed onto TilesetRef.animations (local tile id → TileAnimation with frames, cumulative ends in seconds and duration). They play when you pass time in seconds — e.g. your clock's elapsed — in the drawInto / draw opts; without it every tile draws as authored. LDtk has no tile animation. Colliders and getTileAt always see the authored tile.

import type { Camera2D, SpriteBatch } from '@flare-engine/render';
import type { TilemapRenderer } from '@flare-engine/tilemap';

declare const renderer: TilemapRenderer;
declare const camera: Camera2D;
declare const batch: SpriteBatch;
declare const elapsed: number; // seconds since the scene started, advanced by your game clock

renderer.drawInto(camera, batch, { time: elapsed });

License

Apache-2.0

版本与发布记录

@flare-engine/tilemap 共发布 17 个版本,首次发布于 2026/06/10;过去 12 个月发布了 17 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.4.12latest2026/11/133 天前
0.4.112026/11/123 天前
0.4.102026/11/087 天前
0.4.82026/11/0610 天前
0.4.72026/11/0411 天前
0.4.62026/10/3115 天前

关于 @flare-engine/tilemap 的常见问题

@flare-engine/tilemap 是什么?

Tiled/LDtk parser, culled tilemap renderer

如何安装 @flare-engine/tilemap?

在项目目录运行 npm install @flare-engine/tilemap,或使用 pnpm add / yarn add / bun add。

@flare-engine/tilemap 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@flare-engine/tilemap 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@flare-engine/tilemap 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@flare-engine/tilemap 可以商用吗?

@flare-engine/tilemap 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@flare-engine/tilemap 的下载量有多少?

根据 npm 官方下载统计,@flare-engine/tilemap 在 2026/10/15 – 2026/11/13 这 30 天内被下载 2,128 次,日均约 71 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@flare-engine/tilemap 还在维护吗?

最新版本 0.4.12 发布于 2026/11/13(3 天前);至今共发布 17 个版本,其中过去 12 个月发布了 17 个;首次发布于 2026/06/10。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。