Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Add an auto-map of visited rooms

Open
  • Is something wrong?
#24 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
38/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
typescript
Domain
accessibility, frontend

Research direction

Start by reading packages/engine/src/types.ts, packages/engine/src/affordances.ts, and the noir pack map at packs/letzte-nacht-der-reichsmark/design/world.md. Then inspect apps/web/src/components/dock.ts to find the player controls and how themes and sheets are handled. The work is done when the pure helper has unit tests, the noir walkthrough map has no overlaps, unvisited rooms stay unnamed, and the accessible room list and all three themes meet the criteria.

Written by the indexing model from the issue text.

Description

area: engine area: web priority: medium type: feature

Context

With ten or more rooms (the noir pack has eleven), players on phones lose their bearings. The engine already knows the visited rooms and the exits of each room, so a map needs no format change.

Scope

  • Engine: a pure helper (for example mapView(pack, state)) that returns the visited rooms with their names, the current room, and per visited room its listed exits (direction or custom label). Targets of exits are named only if visited; unvisited targets appear as unexplored stubs. Exits hidden by visibleWhen are not revealed.
  • Layout: deterministic placement from compass directions (north, south, east, west, diagonals, up, down); custom exits drawn as labelled links; collisions resolved deterministically without overlapping rooms.
  • Player: a map button opens a sheet with an SVG map built with DOM APIs (text as text nodes), current room highlighted, read-only in this version; themed for light, sepia and dark.
  • Accessible alternative: a list of visited rooms and their exits.

Acceptance criteria

  • After the noir pack's walkthrough the map shows all eleven rooms without overlaps.
  • Unvisited rooms are never named.
  • The helper is pure and unit-tested; the same state always produces the same layout.
  • The list alternative is reachable with a screen reader.
  • The map is legible in all three themes.

References

  • packages/engine/src/types.ts (View)
  • packages/engine/src/affordances.ts
  • packs/letzte-nacht-der-reichsmark/design/world.md (Map)
  • apps/web/src/components/dock.ts
Dominant language
TypeScript
Stars
0
Forks
0
Avg merge
28m
Merged PRs (30d)
2

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from nullthrone/lexvm

All issues in nullthrone/lexvm

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.