administrator/Worldshaper
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Expand request review tooling and KB

Browse source
This commit is contained in:
Andraxion 2026-06-27 01:12:35 -04:00
parent ab1dfbf029
commit cae21b61b7
16 changed files with 1258 additions and 241 deletions
Download patch file Download diff file Expand all files Collapse all files

73
docs/kb/systems/graphics-painter.md
View file

@ -1,48 +1,55 @@
# Graphics Painter
## What It Does
## What It Owns
The Graphics Painter is the tile and sprite art editing window. It handles pixel editing, frame management, animation timeline editing, preview playback, and import-oriented art workflows.
This is the dedicated art-editing environment for tile and sprite graphics. It covers shape tools, erasers, transforms, previewing, and animation timeline editing for the currently opened asset.
## Key Files
## Core Behaviors
- Shape drawing modes:
- rectangle
- circle
- triangle
- line
- Shape variants:
- outline
- fill
- outline + fill
- Shape erasers:
- rectangle
- circle
- triangle
- Transform workflows available through the painter menu.
- Animation timeline controls, frame order, playback speed, and preview.
## Important UI Surfaces
- Graphic Painter window
- Tool menu and tooltip menus
- Animation timeline row
- Preview card and frame preview
## Important Files
- `src/worldshaperStudio/tileArtEditorWindowController.ts`
- `src/worldshaperStudio/graphicsDocumentHelpers.ts`
- `src/worldshaperStudio/importController.ts`
- `src/worldshaperStudio/dom.ts`
## Endpoints It Uses
## Known Tool Details
- `GET /api/images`
- `GET /api/images/:filename`
- `POST /api/content/images`
- `POST /api/content/sprites`
- `POST /api/content/tiles`
- Shape menus are nested by shape and variant, rather than being a single flat tool list.
- The active draw tool and active eraser shape are tracked separately.
- The painter already knows about animation preview, frame creation, and per-frame editing; many animation requests should be phrased as extensions to an existing timeline rather than brand-new systems.
- The preview and animation controls are editor-side only; runtime rendering requests often cross into `Rendering And Viewport`.
## Important Data And Rules
## Relationships
- graphics records may include animation frame data and playback metadata
- preview behavior is maintained in painter-local UI state
- art changes eventually flow into tile and sprite content records
- imports and previews are tightly tied to painter usability
- Depends on `Content Catalog And Records` for source records and saved asset definitions.
- Depends on `Floating Window Shell` because the painter lives inside a movable editor window.
- Feeds `Rendering And Viewport` when edited assets are later shown in the live map renderer.
- Intersects with `Animation`-tagged requests when frame behavior changes.
## Invariants And Constraints
## Triage Hints
- the painter is a floating tool window, not a docked pane
- animation preview should reflect current frame ordering and speed settings
- save behavior must preserve frame structure and timing metadata
- painter workflows often depend on tile and sprite schema conventions
## Common Request Themes
- move or selection tools
- frame duplication and frame management
- animation controls
- import workflow improvements
- better preview behavior
## Triage Questions
- Is this request about art authoring, record storage, or runtime playback?
- Does it affect tiles, sprites, or both?
- Is the requested behavior inside the painter window only?
Requests about sprite drawing, tile art tools, frame duplication, painter transforms, selection or move workflows, and editor-side animation controls should usually start here.