@mertdogar/phaser-procedural-walls 0.2.0 → 0.4.0

package/README.md

@@ -2,19 +2,28 @@
 
 A Phaser 4 scene plugin that draws top-down floorplan walls from a few lines of data. You describe wall centerlines and window positions; the plugin draws thick wall bodies, a front face, see-through windows with sills, and optional Arcade Physics colliders, and it depth-sorts each wall so characters walk in front of and behind walls correctly.
 
-![Wallcraft editor with a selected wall and geometry inspector](docs/images/wallcraft-editor.png)
+![Wallcraft editor with a selected wall, layers panel, and docked inspector](docs/images/wallcraft-editor.png)
 
 ## Features
 
 - Axis-aligned wall segments with automatic corner and T-junction filling
 - Per-wall style presets: flat colors or tiled textures for the wall top and its face
 - Windows cut into the face with translucent glass and an opaque sill
-- One depth-sorted Container per wall, so `sprite.setDepth(sprite.y)` is all a character needs
-- Optional Arcade static bodies: a thin plane under horizontal walls, a full rectangle for vertical ones
+- One depth-sorted Container per wall; use `sprite.setDepth(sprite.y)` with automatic wall depths
+- Optional Arcade static bodies matching each wall's bottom footprint
 - Pure geometry module with unit tests, no Phaser needed to test it
+- Embeddable `WallEditor` for drawing, selection, endpoint handles, and window dragging in an existing Phaser scene
 - Wallcraft editor prototype: draw walls, drag endpoints and windows, edit height and drawing order, and manage presets
+- Resizable layers and inspector panels with wall selection, duplication, deletion, and reordering
+- Full-pane canvas with origin axes, two-finger scrolling to pan, and pinching to zoom
+- Map preferences for applying height or thickness to all existing walls
 - Upload tiled textures, export/import maps with embedded images, and test collisions in a playable preview
 
+Custom wall drawing orders need matching character-depth handling in your game.
+Wallcraft preview handles player occlusion against wall footprints, but this
+editor-only logic is not included in JSON exports. See the
+[depth convention](docs/api.md#depth-convention).
+
 ## Try Wallcraft
 
 With Node 20 or newer, launch the packaged editor:
@@ -25,7 +34,9 @@ npx @mertdogar/phaser-procedural-walls@latest editor
 pnpx @mertdogar/phaser-procedural-walls@latest editor
 ```
 
-This command requires a release that includes the editor CLI. For a source checkout, use:
+This command requires a release that includes the editor CLI. This README and
+its screenshots describe the current repository; the published npm release may
+not include the latest editor and geometry changes. To use the repository version:
 
 ```bash
 pnpm install
@@ -88,14 +99,81 @@ player.setDepth(player.y);
 - [Quick start](docs/quickstart.md). Build a walkable room with a window from an empty folder.
 - [Wallcraft guide](docs/wallcraft.md). Edit maps, manage presets and textures, test collisions, and export to Phaser.
 - [API reference](docs/api.md). Every config field, preset option, and method.
-- [How it works](docs/how-it-works.md). Corner filling, depth sorting, the collision plane, and window holes.
+- [How it works](docs/how-it-works.md). Corner filling, depth sorting, collision footprints, and window holes.
+
+## Agent skill
+
+The repository includes a portable
+[procedural-walls skill](skills/phaser-procedural-walls/SKILL.md) for coding
+agents. It covers library integration, Wallcraft exports, presets, textures,
+depth sorting, and collisions, with self-contained references.
+
+Install it from your project's root with the [skills CLI](https://skills.sh/docs):
+
+```bash
+npx skills add mertdogar/phaser-procedural-walls --skill phaser-procedural-walls
+```
+
+Append `--agent codex` to target Codex, or `--global` to install for your user
+instead of the current project. The installation includes the bundled references.
+
+To check available skills without installing:
+
+```bash
+npx skills add mertdogar/phaser-procedural-walls --list
+```
+
+Start a new agent session if needed, then ask, for example:
+“Use the phaser-procedural-walls skill to load my Wallcraft export into a Phaser
+scene with player collisions.” The skill is distributed in Git, not in the npm
+package. Its bundled references track the repository, including changes made
+after the original 0.2.0 release.
+
+## 0.4.0 release notes
+
+Version 0.4.0 exports `WallEditor`, extracted from Wallcraft's canvas interactions.
+Attach it to your existing Phaser scene to draw snapped walls, select walls,
+drag endpoints, and move windows. Your application owns data, UI, rendering,
+camera navigation, and accepting or refusing edits.
+
+The standalone editor now uses this component. Open `/?embedded` in the demo
+or packaged editor for a small Phaser-only example with property controls.
+See the [embedding guide](docs/wallcraft.md#embed-the-wall-editor-in-your-game)
+and [API reference](docs/api.md#walleditor). Existing renderer and geometry APIs
+are unchanged.
+
+## 0.3.0 release notes
+
+Version 0.3.0 adds large-map navigation, resizable layers and inspector panels,
+bulk height and thickness settings, window-width controls, and a Help dialog.
+Select and Draw now live in the top bar. Preview handles player occlusion with
+custom wall drawing orders. Documentation, screenshots, and the repository's
+installable agent skill have also been updated.
+
+### Upgrade from 0.2.0
+
+Review existing maps before upgrading your game:
+
+- **Collision footprints changed.** Colliders now match the wall body's bottom
+  footprint, shifted south by its effective face height. Recheck spawn points,
+  wall junctions, and doorways. Use matching face heights around aligned gaps.
+- **Default window sills changed.** When `sillHeight` is omitted, it follows wall
+  thickness, clipped to the opening height. Explicit values remain unchanged;
+  set a value to preserve an older look, or use zero to disable sills.
+- **Preview sorting is editor-only.** Exported custom `depth` values remain
+  absolute drawing orders. Consumer games still need character sorting that
+  accounts for these values; `setDepth(player.y)` assumes automatic wall depths.
+
+Launch this specific version with
+`npx @mertdogar/phaser-procedural-walls@0.3.0 editor` or
+`pnpx @mertdogar/phaser-procedural-walls@0.3.0 editor`.
 
 ## Develop
 
 ```bash
 pnpm install
 pnpm dev     # wall editor prototype: draw walls and import/export WallMapConfig JSON
-pnpm test    # geometry unit tests
+pnpm test    # geometry and editor interaction tests
 pnpm typecheck
 pnpm lint
 pnpm build   # library in dist/ and bundled app in dist/editor/

package/dist/WallEditor.d.ts

@@ -0,0 +1,54 @@
+import Phaser from "phaser";
+import type { WallMapConfig, WallSpec } from "./types";
+export type WallEditorTool = "select" | "wall";
+export interface WallEditorCallbacks {
+    onAddWall: (wall: WallSpec) => void;
+    onSelectWall: (index: number | null) => void;
+    onUpdateWall: (index: number, patch: Partial<WallSpec>) => void;
+}
+export interface WallEditorState {
+    config: WallMapConfig;
+    selectedIndex: number | null;
+    tool: WallEditorTool;
+    enabled?: boolean;
+}
+export interface WallEditorOptions extends WallEditorState, WallEditorCallbacks {
+    camera?: Phaser.Cameras.Scene2D.Camera;
+    gridSize?: number;
+    overlayDepth?: number;
+    newWall?: Partial<Pick<WallSpec, "thickness" | "height" | "preset">>;
+}
+export declare class WallEditor {
+    private readonly scene;
+    private configData;
+    private selectedIndex;
+    private tool;
+    private enabled;
+    private readonly camera;
+    private readonly gridSize;
+    private readonly overlay;
+    private readonly callbacks;
+    private newWall;
+    private drawStart;
+    private pointerPosition;
+    private anchorDrag;
+    private windowDrag;
+    constructor(scene: Phaser.Scene, options: WallEditorOptions);
+    setState(state: WallEditorState): void;
+    setNewWall(wall: Partial<Pick<WallSpec, "thickness" | "height" | "preset">>): void;
+    get dragging(): boolean;
+    cancel(): void;
+    destroy(): void;
+    private handlePointerDown;
+    private handlePointerMove;
+    private handlePointerUp;
+    refresh(): void;
+    private findWall;
+    private findAnchor;
+    private findWindow;
+    private getWindowRects;
+    private moveWindow;
+    private moveEndpoint;
+    private snapPoint;
+    private axisLock;
+}