@debuffjp/tilemap

中文文档
0.33.0发布于 2026/11/11MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 8894

Tilemaps for debuff: culled batched rendering, tile collision, Tiled and LDtk import

原始使用文档
文档目录3 节
  1. Building maps
  2. Collision
  3. API

@debuffjp/tilemap

Tilemaps for debuff: culled, batched rendering through draw, tile collision, and importers for Tiled and LDtk.

import { fromTiled } from "@debuffjp/tilemap";

const map = fromTiled(assets.json("level1"), { image: (path) => assets.image("tiles") });
const player = { x: 32, y: 32, w: 12, h: 14 };

// update(dt)
const hit = map.move(player, vx * dt, vy * dt);
if (hit.onGround) vy = 0;

// render(draw)
draw.withCamera(game.camera, () => map.draw(draw, { camera: game.camera }));

Building maps

  • Tiled (.tmj): fromTiled(json, { image, tilesets? }). Orthogonal maps, CSV or uncompressed Base64, infinite maps, layer groups (offsets, opacity, parallax), flip and rotation flags, external tilesets, object layers.
  • LDtk (.ldtk): fromLdtk(project, { level?, image, intGrid? }). Tiles, AutoLayer (stacked tiles become extra layers), IntGrid collision, entities and level fields.
  • In code: new Tilemap({ width, height, tileWidth, tileHeight, tilesets, layers }), then map.set(layer, col, row, id). Useful for procedural levels.

Collision

SourceBecomes
Tiled tile property solid / collidessolid
Tiled tile property oneWayone-way (solid from above)
Tiled layer property collision: trueevery tile in the layer is solid
LDtk IntGrid valuesolid; values named oneWay, one_way or platform are one-way; override with intGrid
Codemap.setCollision(col, row, Collision.Solid)

map.move(body, dx, dy, { dropThrough? }) moves an { x, y, w, h } box, resolving X then Y. It splits fast moves into tile-sized steps so nothing tunnels, and returns onGround, hitCeiling, hitLeft, hitRight. map.edges controls which map borders are solid (default: sides solid, top and bottom open).

API

  • map.draw(draw, { camera?, layers? }): draws only tiles in view, applies parallax, no per-tile allocation
  • map.get / set / tileAt, map.tileProperties(id), map.objects(layer), map.properties
  • map.collisionAt(col, row), map.collideFrom(layers, { everyTile? }), overlapsSolid(map, body)
  • The asset pipeline loads .tmj, .tsj and .ldtk files as JSON

版本与发布记录

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

版本发布日期距今
0.33.0latest2026/11/11今天
0.32.02026/11/074 天前
0.31.12026/11/065 天前
0.31.02026/11/065 天前
0.30.02026/11/056 天前
0.29.22026/11/056 天前

关于 @debuffjp/tilemap 的常见问题

@debuffjp/tilemap 是什么?

Tilemaps for debuff: culled batched rendering, tile collision, Tiled and LDtk import

如何安装 @debuffjp/tilemap?

在项目目录运行 npm install @debuffjp/tilemap,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@debuffjp/core(0.33.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@debuffjp/tilemap 支持 TypeScript 吗?

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

@debuffjp/tilemap 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@debuffjp/tilemap 可以商用吗?

@debuffjp/tilemap 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@debuffjp/tilemap 的下载量有多少?

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

@debuffjp/tilemap 还在维护吗?

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