Log inGet started
World

Wayfinder Studio: Minimap, Compass, Waypoint and Toast Kit

Merged

navUiKit 1.3.0: room map (roomGrid), side-view plane, gothic look

#2
Author
claude-code @ auraAgent
Opened
Nov 8, 2026
From
contrib-51dgfc5r
Into
main
Merged
Nov 8, 2026

navUiKit 1.3.0: a room map for games made of rooms, plus a side-view plane and a sixth look. Everything that worked in 1.2.1 behaves the same; defaults are unchanged.

Why: navUiKit's maps are top-down pictures that reveal by distance. A metroidvania or dungeon map is different: rooms on a grid, doors between them, icons for save rooms and bosses, arrows on doors the player has not tried, and each player's explored rooms coming from the game's own save, not from walking distance. Lantern Depths had a separate package for that (roomMap2D); this puts it into navUiKit generically so it is one map system, styled by navUiKit's looks.

What:

  • Room grid API: Nav.addRoom(id, { name, cell = {gx, gy, w, h}, area (world rect for placing the player and POIs), icons, doors = { { id, side, at = {f0, f1}, to?, cell? } } }), updateRoom, removeRoom, clearRooms, room, rooms, roomAt.
  • Per-player room state: visitRoom / setVisitedRooms / roomVisited / roomsExplored, useDoor / setUsedDoors / doorUsed / untriedDoors, setRoomIcons (e.g. skull becomes a check for the player who won). The HUD marks the room a player stands in (rooms.autoVisit, default on); a game that keeps its own record turns it off and feeds it. State for a player on another peer is relayed ("room" message), like per-player waypoints.
  • New variants: minimap.roomGrid (centred on the player, header with room name and % seen) and map.roomGrid (all visited rooms fitted, room names, legend built from the icons in use, rooms seen). New module navUiKit.roomGrid draws both and can draw into any box.
  • plane = "xy" setting: side view for 2D games (map space x, -y). The bake, fog, distances, minimaps and room map follow it; on-screen waypoint markers and beams stay in world space.
  • Sixth look "gothic" (panel and ring frames), and room-map colours on every look (roomFill, roomHere, roomEdge, roomNew, roomText, roomIcons) with fallbacks to the map colours for registered themes.
  • map.input = false: the game opens/closes the map with its own controls while the hint still shows map.key; Escape still closes.
  • Catalogue rows, tags and README sections for all of the above; version 1.3.0 in Nav.version, package.yaml and README.

Tests: navUiKitTests grows from 49 to 55 (rooms, visits, doors, icons, plane, both roomGrid variants in every theme top-down and side view plus a phone-sized portrait map, the HUD auto-visit, relay and session reset, map.input). Ran in Lantern Depths: 55/55 after a README version line fix. Also checked in play there: walked three rooms with keyboard input, opened the map with M, captured the roomGrid map in the pixel, scifi, gothic and fantasy looks and on a phone-density screen (640x360 points).

Source world: a8c98b5b-86a7-474c-9b7a-4a4eb6856130 Contributed paths:

  • navUiKit.package/README.md
  • navUiKit.package/core.module/init.luau
  • navUiKit.package/hud.module/init.luau
  • navUiKit.package/mapScreen.module/init.luau
  • navUiKit.package/minimap.module/init.luau
  • navUiKit.package/nav.module/init.luau
  • navUiKit.package/navUiKitTests.testSuite/init.luau
  • navUiKit.package/package.yaml
  • navUiKit.package/roomGrid.module/.metadata
  • navUiKit.package/roomGrid.module/README.md
  • navUiKit.package/roomGrid.module/init.luau
  • navUiKit.package/theme.module/init.luau
  • navUiKit.package
  • navUiKit.package/core.module
  • navUiKit.package/hud.module
  • navUiKit.package/mapScreen.module
  • navUiKit.package/minimap.module
  • navUiKit.package/nav.module
  • navUiKit.package/navUiKitTests.testSuite
  • navUiKit.package/roomGrid.module
  • navUiKit.package/theme.module
  • navUiKit.package/NavHud.component/init.luau
  • navUiKit.package/PointOfInterest.component/init.luau
  • navUiKit.package/compass.module/init.luau
  • navUiKit.package/gallery.module/init.luau
  • navUiKit.package/glyphs.module/init.luau
  • navUiKit.package/icons.module/init.luau
  • navUiKit.package/markers.module/init.luau
  • navUiKit.package/toasts.module/init.luau
  • navUiKit.package/tracker.module/init.luau
  • scenes/gallery.scene/entrypoint.luau
  • scenes/playground.scene/entrypoint.luau

21 files changed

  • ChangednavUiKit.packageFolderBeforeAfter
  • ChangednavUiKit.package/README.md29.7 KB → 35.4 KBBeforeAfter
  • ChangednavUiKit.package/core.moduleFolderBeforeAfter
  • ChangednavUiKit.package/core.module/init.luau24.8 KB → 32.4 KBBeforeAfter
  • ChangednavUiKit.package/hud.moduleFolderBeforeAfter
  • ChangednavUiKit.package/hud.module/init.luau35.2 KB → 36.0 KBBeforeAfter
  • ChangednavUiKit.package/mapScreen.moduleFolderBeforeAfter
  • ChangednavUiKit.package/mapScreen.module/init.luau12.4 KB → 15.4 KBBeforeAfter
  • ChangednavUiKit.package/minimap.moduleFolderBeforeAfter
  • ChangednavUiKit.package/minimap.module/init.luau19.7 KB → 20.1 KBBeforeAfter
  • ChangednavUiKit.package/nav.moduleFolderBeforeAfter
  • ChangednavUiKit.package/nav.module/init.luau36.8 KB → 45.7 KBBeforeAfter
  • ChangednavUiKit.package/navUiKitTests.testSuiteFolderBeforeAfter
  • ChangednavUiKit.package/navUiKitTests.testSuite/init.luau56.1 KB → 67.1 KBBeforeAfter
  • ChangednavUiKit.package/package.yaml677 B → 991 BBeforeAfter
  • AddednavUiKit.package/roomGrid.moduleFolderAfter
  • AddednavUiKit.package/roomGrid.module/.metadata17 BAfter
  • AddednavUiKit.package/roomGrid.module/README.md1.3 KBAfter
  • AddednavUiKit.package/roomGrid.module/init.luau16.0 KBAfter
  • ChangednavUiKit.package/theme.moduleFolderBeforeAfter
  • ChangednavUiKit.package/theme.module/init.luau23.5 KB → 26.8 KBBeforeAfter

Checks

No checks have been posted.

Reviews

No reviews yet.

Conversation

No comments yet.

Sign in to comment or review.