1681-engine 0.6.1 → 0.6.2

package/CHANGELOG.md

@@ -3,6 +3,13 @@
 All notable changes to this package are written here. The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and versions follow [Semantic Versioning](https://semver.org/); before 1.0 a minor version may break the API.
 
+## 0.6.2
+
+### Added
+
+- `Stage.pixelDensity`: texels of the pixel-perfect grid to a world pixel (1 by default). A game drawing characters at
+  two art pixels to a world pixel sets 2, and the grid keeps their detail instead of sampling them back down.
+
 ## 0.6.1
 
 ### Added

package/dist/core/PixelGrid.js

@@ -1,7 +1,7 @@
-import { Matrix as n, Sprite as l, RenderTexture as a } from "pixi.js";
-import { gridPlacement as d } from "./gridPlacement.js";
+import { Matrix as a, Sprite as l, RenderTexture as d } from "pixi.js";
+import { gridPlacement as p } from "./gridPlacement.js";
 import { SharpText as x } from "./SharpText.js";
-class m {
+class w {
   constructor(e, t) {
     this.app = e, this.world = t, this.text = new x(t);
   }
@@ -10,18 +10,18 @@ class m {
   texture = null;
   sprite = null;
   text;
-  transform = new n();
+  transform = new a();
   on = !1;
   get enabled() {
     return this.on;
   }
   /** Once a frame, after the camera wrote the world's transform and before Pixi draws the screen. */
-  render(e, t) {
+  render(e, t, i = 1) {
     if (t !== this.on && (t ? this.enable(e) : this.disable(e)), !t) return;
-    const i = e.zoom || 1, s = this.world.position, r = d(s.x, s.y, i, this.app.renderer.resolution, e.width, e.height), o = this.fit(r.width, r.height);
-    this.transform.set(1, 0, 0, 1, -r.tx, -r.ty), this.app.renderer.render({ container: this.world, target: o, clear: !0, clearColor: [0, 0, 0, 0], transform: this.transform });
-    const h = this.sprite;
-    h.scale.set(i), h.position.set(r.x, r.y), this.text.sync(s, i);
+    const r = e.zoom || 1, h = this.world.position, s = p(h.x, h.y, r, this.app.renderer.resolution, e.width, e.height), n = this.fit(s.width, s.height, Math.max(1, Math.round(i)));
+    this.transform.set(1, 0, 0, 1, -s.tx, -s.ty), this.app.renderer.render({ container: this.world, target: n, clear: !0, clearColor: [0, 0, 0, 0], transform: this.transform });
+    const o = this.sprite;
+    o.scale.set(r), o.position.set(s.x, s.y), this.text.sync(h, r);
   }
   destroy(e) {
     this.disable(e), this.text.destroy();
@@ -37,11 +37,15 @@ class m {
     const t = this.app.stage, i = Math.max(0, this.sprite ? t.children.indexOf(this.sprite) : 0);
     t.removeChild(this.text.layer), this.sprite?.destroy(), this.sprite = null, this.texture?.destroy(!0), this.texture = null, this.world.destroyed || t.addChildAt(this.world, i);
   }
-  /** The texture at exactly this size, made again only when the screen or the zoom changed. */
-  fit(e, t) {
-    return this.texture && this.texture.width === e && this.texture.height === t ? this.texture : (this.texture?.destroy(!0), this.texture = a.create({ width: e, height: t, resolution: 1, scaleMode: "nearest", antialias: !1 }), this.sprite.texture = this.texture, this.texture);
+  /**
+   * The texture at exactly this size (world pixels) and density (texels to a world pixel), made again only when the
+   * screen, the zoom or the density changed.
+   */
+  fit(e, t, i) {
+    const r = this.texture;
+    return r && r.width === e && r.height === t && r.source.resolution === i ? r : (this.texture?.destroy(!0), this.texture = d.create({ width: e, height: t, resolution: i, scaleMode: "nearest", antialias: !1 }), this.sprite.texture = this.texture, this.texture);
   }
 }
 export {
-  m as PixelGrid
+  w as PixelGrid
 };

package/dist/core/Stage.js

@@ -1,13 +1,13 @@
 import { Container as s } from "pixi.js";
-import { Camera as a } from "./Camera.js";
-import { Clock as n } from "./Clock.js";
+import { Camera as n } from "./Camera.js";
+import { Clock as a } from "./Clock.js";
 import { ObjectFactory as o } from "./ObjectFactory.js";
 import { PixelGrid as d } from "./PixelGrid.js";
 import { Pointer as c } from "./Pointer.js";
 import { Tweener as m } from "./Tweener.js";
 class h {
   constructor(t, e) {
-    this.app = t, this.textures = e, t.stage.addChild(this.world, this.screen), this.cameras = { main: new a(this.world, this.screen) }, this.input = { activePointer: new c(t.canvas) }, this.grid = new d(t, this.world), this.time.onError = (i) => this.caught("timers", i), this.syncSize();
+    this.app = t, this.textures = e, t.stage.addChild(this.world, this.screen), this.cameras = { main: new n(this.world, this.screen) }, this.input = { activePointer: new c(t.canvas) }, this.grid = new d(t, this.world), this.time.onError = (i) => this.caught("timers", i), this.syncSize();
   }
   app;
   textures;
@@ -17,7 +17,7 @@ class h {
   screen = new s();
   add = new o(this);
   tweens = new m();
-  time = new n();
+  time = new a();
   cameras;
   input;
   /**
@@ -26,6 +26,12 @@ class h {
    * Off (the default), the world is drawn straight at the zoom. Takes effect on the next frame; may be switched any time.
    */
   pixelPerfect = !1;
+  /**
+   * Texels of the pixel-perfect grid to a world pixel (whole, 1 by default). A game whose characters are drawn finer
+   * than its world pixel (two art pixels to one) sets 2, so the grid keeps their detail; everything else still lands on
+   * that finer grid.
+   */
+  pixelDensity = 1;
   grid;
   /** Whether the grid drew last frame, so the frame it is switched off still takes it down. */
   gridLive = !1;
@@ -55,7 +61,7 @@ class h {
    */
   frame(t) {
     const e = performance.now();
-    this.guard("resize", () => this.syncSize()), this.guard("update", () => this.update(e, t)), this.guard("tweens", () => this.tweens.update(t)), this.guard("timers", () => this.time.update(e)), this.guard("camera", () => this.cameras.main.apply(e)), (this.pixelPerfect || this.gridLive) && (this.gridLive = this.pixelPerfect, this.guard("pixel grid", () => this.grid.render(this.cameras.main, this.pixelPerfect)));
+    this.guard("resize", () => this.syncSize()), this.guard("update", () => this.update(e, t)), this.guard("tweens", () => this.tweens.update(t)), this.guard("timers", () => this.time.update(e)), this.guard("camera", () => this.cameras.main.apply(e)), (this.pixelPerfect || this.gridLive) && (this.gridLive = this.pixelPerfect, this.guard("pixel grid", () => this.grid.render(this.cameras.main, this.pixelPerfect, this.pixelDensity)));
   }
   /**
    * Keeps a piece of text made outside `add.text`/`add.label` (put on the world any way) at screen resolution while the

package/dist/types/core/PixelGrid.d.ts

@@ -3,7 +3,7 @@ import type { Camera } from './Camera.js';
 import { SharpText } from './SharpText.js';
 /**
  * A pixel-perfect world (`Stage.pixelPerfect`): the world layer is taken off the stage and drawn each frame into a
- * texture of one texel per world pixel, whose origin sits on a whole world pixel, then shown at the camera's zoom and
+ * texture of one texel per world pixel (`Stage.pixelDensity` texels, when the art is finer), whose origin sits on a whole world pixel, then shown at the camera's zoom and
  * moved by the scroll's fraction, so the camera still glides one backing pixel at a time. Everything turned, scaled or
  * placed between pixels lands on the same grid as the rest of the art, so no pixel on screen is drawn at another size
  * ("mixels"); the world is also filled at 1/zoom² of the screen's pixels. Roots placed with `Camera.snapRoot` land on
@@ -20,11 +20,14 @@ export declare class PixelGrid {
     constructor(app: Application, world: Container);
     get enabled(): boolean;
     /** Once a frame, after the camera wrote the world's transform and before Pixi draws the screen. */
-    render(cam: Camera, enabled: boolean): void;
+    render(cam: Camera, enabled: boolean, density?: number): void;
     destroy(cam: Camera): void;
     private enable;
     private disable;
-    /** The texture at exactly this size, made again only when the screen or the zoom changed. */
+    /**
+     * The texture at exactly this size (world pixels) and density (texels to a world pixel), made again only when the
+     * screen, the zoom or the density changed.
+     */
     private fit;
 }
 //# sourceMappingURL=PixelGrid.d.ts.map

package/dist/types/core/PixelGrid.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PixelGrid.d.ts","sourceRoot":"","sources":["../../../src/core/PixelGrid.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiC,KAAK,WAAW,EAAE,KAAK,SAAS,EAAE,MAAM,SAAS,CAAC;AAC1F,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;;;;GAOG;AACH,qBAAa,SAAS;IAQlB,OAAO,CAAC,QAAQ,CAAC,GAAG;IACpB,OAAO,CAAC,QAAQ,CAAC,KAAK;IARxB,OAAO,CAAC,OAAO,CAA8B;IAC7C,OAAO,CAAC,MAAM,CAAuB;IACrC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAgB;IAC1C,OAAO,CAAC,EAAE,CAAS;gBAGA,GAAG,EAAE,WAAW,EAChB,KAAK,EAAE,SAAS;IAKnC,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,mGAAmG;IACnG,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI;IAmB3C,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAK1B,OAAO,CAAC,MAAM;IAWd,OAAO,CAAC,OAAO;IAef,6FAA6F;IAC7F,OAAO,CAAC,GAAG;CAOZ"}
+{"version":3,"file":"PixelGrid.d.ts","sourceRoot":"","sources":["../../../src/core/PixelGrid.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiC,KAAK,WAAW,EAAE,KAAK,SAAS,EAAE,MAAM,SAAS,CAAC;AAC1F,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;;;;;GAOG;AACH,qBAAa,SAAS;IAQlB,OAAO,CAAC,QAAQ,CAAC,GAAG;IACpB,OAAO,CAAC,QAAQ,CAAC,KAAK;IARxB,OAAO,CAAC,OAAO,CAA8B;IAC7C,OAAO,CAAC,MAAM,CAAuB;IACrC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAgB;IAC1C,OAAO,CAAC,EAAE,CAAS;gBAGA,GAAG,EAAE,WAAW,EAChB,KAAK,EAAE,SAAS;IAKnC,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,mGAAmG;IACnG,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,SAAI,GAAG,IAAI;IAmBxD,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAK1B,OAAO,CAAC,MAAM;IAWd,OAAO,CAAC,OAAO;IAef;;;OAGG;IACH,OAAO,CAAC,GAAG;CAQZ"}

package/dist/types/core/Stage.d.ts

@@ -31,6 +31,12 @@ export declare abstract class Stage {
      * Off (the default), the world is drawn straight at the zoom. Takes effect on the next frame; may be switched any time.
      */
     pixelPerfect: boolean;
+    /**
+     * Texels of the pixel-perfect grid to a world pixel (whole, 1 by default). A game whose characters are drawn finer
+     * than its world pixel (two art pixels to one) sets 2, so the grid keeps their detail; everything else still lands on
+     * that finer grid.
+     */
+    pixelDensity: number;
     private readonly grid;
     /** Whether the grid drew last frame, so the frame it is switched off still takes it down. */
     private gridLive;

package/dist/types/core/Stage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Stage.d.ts","sourceRoot":"","sources":["../../../src/core/Stage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC;;;GAGG;AACH,8BAAsB,KAAK;IAyBvB,QAAQ,CAAC,GAAG,EAAE,WAAW;IACzB,QAAQ,CAAC,QAAQ,EAAE,eAAe;IAzBpC,yFAAyF;IACzF,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,IAAI,CAAQ;IAEvE,QAAQ,CAAC,KAAK,8CAA6C;IAC3D,QAAQ,CAAC,MAAM,8CAAmB;IAClC,QAAQ,CAAC,GAAG,gBAA2B;IACvC,QAAQ,CAAC,MAAM,UAAiB;IAChC,QAAQ,CAAC,IAAI,QAAe;IAC5B,QAAQ,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACnC,QAAQ,CAAC,KAAK,EAAE;QAAE,aAAa,EAAE,OAAO,CAAA;KAAE,CAAC;IAC3C;;;;OAIG;IACH,YAAY,UAAS;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAY;IACjC,6FAA6F;IAC7F,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAsB;IACtD,OAAO,CAAC,SAAS,CAAK;IACtB,OAAO,CAAC,UAAU,CAAK;gBAGZ,GAAG,EAAE,WAAW,EAChB,QAAQ,EAAE,eAAe;IAWpC,IAAI,KAAK,IAAI,MAAM,CAElB;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,GAAG,IAAI,MAAM,CAEhB;IAED,6GAA6G;IAC7G,QAAQ,CAAC,EAAE,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI;IAQpC,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAEjD;;;;OAIG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAc1B;;;OAGG;IACH,SAAS,CAAC,GAAG,EAAE,SAAS,GAAG,IAAI;IAI/B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAqB;IAE9C;;;;OAIG;IACH,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,IAAI,GAAG,IAAI;IAInD,2EAA2E;IAC3E,SAAS,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,CAAC;IAS/D,iIAAiI;IACjI,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,GAAG,IAAI;IASlD,OAAO,IAAI,IAAI;IAUf,OAAO,CAAC,QAAQ;CAWjB"}
+{"version":3,"file":"Stage.d.ts","sourceRoot":"","sources":["../../../src/core/Stage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC;;;GAGG;AACH,8BAAsB,KAAK;IA+BvB,QAAQ,CAAC,GAAG,EAAE,WAAW;IACzB,QAAQ,CAAC,QAAQ,EAAE,eAAe;IA/BpC,yFAAyF;IACzF,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,IAAI,CAAQ;IAEvE,QAAQ,CAAC,KAAK,8CAA6C;IAC3D,QAAQ,CAAC,MAAM,8CAAmB;IAClC,QAAQ,CAAC,GAAG,gBAA2B;IACvC,QAAQ,CAAC,MAAM,UAAiB;IAChC,QAAQ,CAAC,IAAI,QAAe;IAC5B,QAAQ,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACnC,QAAQ,CAAC,KAAK,EAAE;QAAE,aAAa,EAAE,OAAO,CAAA;KAAE,CAAC;IAC3C;;;;OAIG;IACH,YAAY,UAAS;IACrB;;;;OAIG;IACH,YAAY,SAAK;IACjB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAY;IACjC,6FAA6F;IAC7F,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAsB;IACtD,OAAO,CAAC,SAAS,CAAK;IACtB,OAAO,CAAC,UAAU,CAAK;gBAGZ,GAAG,EAAE,WAAW,EAChB,QAAQ,EAAE,eAAe;IAWpC,IAAI,KAAK,IAAI,MAAM,CAElB;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,GAAG,IAAI,MAAM,CAEhB;IAED,6GAA6G;IAC7G,QAAQ,CAAC,EAAE,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI;IAQpC,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAEjD;;;;OAIG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAc1B;;;OAGG;IACH,SAAS,CAAC,GAAG,EAAE,SAAS,GAAG,IAAI;IAI/B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAqB;IAE9C;;;;OAIG;IACH,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,IAAI,GAAG,IAAI;IAInD,2EAA2E;IAC3E,SAAS,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,CAAC;IAS/D,iIAAiI;IACjI,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,GAAG,IAAI;IASlD,OAAO,IAAI,IAAI;IAUf,OAAO,CAAC,QAAQ;CAWjB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "1681-engine",
-  "version": "0.6.1",
+  "version": "0.6.2",
   "description": "A 2D game engine on PixiJS 8 for any art style: scenes and a fast ECS, a fixed-step loop, asset loading, Tiled maps, sprite animation, input actions, camera follow, audio and deterministic, server-replayable movement, plus Dither, an optional pixel-art module (pixel-perfect effects, dithered lighting).",
   "type": "module",
   "types": "./dist/types/index.d.ts",