Worldshaper/docs/kb/systems/world-overview.md

1.4 KiB

World Overview

What It Does

World Overview is a separate window that displays a coarse map of all known chunks, supports bookmark navigation, and exposes chunk operations such as move, duplicate, rotate, flip, delete, and background adjustments.

Key Files

  • src/worldshaperStudio/worldOverviewWindowController.ts
  • src/worldshaperStudio/dom.ts
  • server.js

Endpoints It Uses

  • GET /api/world/:worldId/overview
  • GET /api/world/:worldId/bookmarks
  • bookmark writes flow through the world save path

Important Data And Rules

  • overview currently requests the full set of world chunks from the server
  • it draws its own chunk preview surfaces
  • it merges server chunks with cached client chunks to reflect unsaved local state
  • chunk context menus expose world-level operations

Invariants And Constraints

  • overview is only available in world mode
  • overview actions should not silently discard unsaved chunk edits
  • chunk transform actions must preserve chunk addressing rules
  • the full overview payload can become a performance hotspot on larger worlds

Common Request Themes

  • chunk operations
  • world navigation
  • bookmark workflows
  • overview performance
  • better high-level visualization

Triage Questions

  • Is the issue specific to the overview window, or all world editing?
  • Does it affect overview drawing only, or also chunk save/load behavior?
  • Is the request about overview scale, navigation, or chunk manipulation?