Rework interactive new-player tutorial (real-map walkthrough + MUD intro) - #62
adhocmedia wants to merge 2 commits into
Conversation
Reviewer's GuideReworks the interactive tutorial into a 16-chapter, real-map walkthrough: it now opens with a pinned reading-only MUD/MUME introduction, uses data-driven per-chapter map visuals and grounded Black Hill Village content, simplifies the prose and interactions, and ends with a web-client/MMapper hand-off. Sequence diagram for the reading-only tutorial introductionsequenceDiagram
participant Reader
participant TutorialPlayer
participant ChapterData
Reader->>TutorialPlayer: Open 1-welcome
TutorialPlayer->>ChapterData: Load chapter frontmatter and content
ChapterData-->>TutorialPlayer: Intro with no steps
TutorialPlayer->>TutorialPlayer: renderStepLog()
TutorialPlayer->>TutorialPlayer: completeChapter(true)
TutorialPlayer->>TutorialPlayer: scrollTop()
TutorialPlayer-->>Reader: Show pinned intro and Begin the tutorial button
Reader->>TutorialPlayer: advanceNext()
TutorialPlayer-->>Reader: Navigate to chapter 2
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've found 1 issue
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="docs/.vitepress/theme/components/TutorialPlayer.vue" line_range="60-62" />
<code_context>
const teachList = computed(() => frontmatter.value?.teach || currentChapterObj.value?.teach || [])
+// Optional per-chapter mini-map: { x, y } mark the "you are here" room as a
+// percentage of the map image; { zoom, fx, fy } optionally crop/zoom to focus
+// the village; { arrow } shows a move direction. Driven from chapter frontmatter.
+const chapterMap = computed(() => frontmatter.value?.map || currentChapterObj.value?.map || null)
+
</code_context>
<issue_to_address>
**issue (bug_risk):** The documented `map` options (`x`, `y`, `zoom`, `fx`, `fy`, and `arrow`) are never applied: the template renders only the image and label, while the pin and arrow CSS has no corresponding markup. Any chapter that supplies those fields still displays the full unannotated image without the promised location marker, crop, or direction indicator.
**Triggers:** When a chapter uses any map positioning, zoom, focus, or arrow metadata.
**Suggested fix:** Render the pin and arrow from the metadata and apply the requested crop/zoom styles, or remove the unsupported fields and comments.
</issue_to_address>Sourcery assessment
Approval pending. 1 finding to address first.
Blocking findings: docs/.vitepress/theme/components/TutorialPlayer.vue:62
The "you are here" marker is baked into each map screenshot, so the runtime
pin/crop/arrow mechanism is never used. Remove the dead .tut-map-pin,
tut-pin-pulse and .tut-map-arrow CSS and correct the chapterMap comment to
document the actual { img, label } shape.
Addresses Sourcery review on MUME#62.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
🔎 Live previewSince the org-root repo's PR-preview base path is broken (see below), I deployed this branch to my fork's Pages so you can click through the real thing: https://whitecouncil-alt.github.io/mume.github.io/play/tutorial/ Verified end-to-end: intro redirect works, maps load, chapter navigation and titles all render correctly. ✅ MergingNothing special required — a normal merge to The base-path bug below only affects PR previews, never the production deploy, so the merged result renders correctly regardless. 🐞 Optional: fix PR previews for future PRsPreviews 404 because - name: Determine Base URL Prefix
id: base_url
run: |
name_lc=$(echo "${{ github.event.repository.name }}" | tr '[:upper:]' '[:lower:]')
owner_lc=$(echo "${{ github.repository_owner }}" | tr '[:upper:]' '[:lower:]')
if [ "$name_lc" = "$owner_lc.github.io" ]; then
echo "prefix=/" >> $GITHUB_OUTPUT
else
echo "prefix=/${{ github.event.repository.name }}/" >> $GITHUB_OUTPUT
fi
echo "host=${{ github.repository_owner }}.github.io" >> $GITHUB_OUTPUT(Since |
9939be0 to
04abc5b
Compare
04abc5b to
386e410
Compare
Rebuild the interactive tutorial as a real-map walkthrough of Black Hill Village, on top of Nils's upstream engine (pager + image lightbox, MUME#64). - 16 chapters: adds a "What is MUME?" intro; reorders so Movement & Doors (ch4, Common Room -> Kitchen -> open trapdoor -> Cellar) precedes Examining (ch5, in the cellar); real room descriptions throughout. - Maps are inline story-beat images per the new TUTORIAL.md guidance (dropped the custom `map:` frontmatter and its bespoke figure code). - Rooms auto-displayed after `change spam all off` are brief (name + occupants + exits); explicit `look` stays full. - Fixes: spam command, equipment vs inventory ordering, parry (not dodge) on wimpy mood, snake combat text, give-to-Irelm, bare-command accepts. - Update MumeCommandGuide + Newcomers/home/play links to the new numbering. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
386e410 to
d498df5
Compare
The reading-only intro overflowed the terminal on the new engine, showing a 'More output' pager instead of a Continue button — it read as stuck. Move the intro prose into streamed story beats with a short lesson card so it flows and ends on the Continue-to-Chapter-2 button. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
cceeb56 to
5780f1f
Compare
Sourcery withdrew this approval because it has stopped reviewing this pull request.
|
Sourcery has withdrawn its approval of this pull request. It auto-reviews a pull request 5 times, and this push is past that limit, so the approval no longer reflects code Sourcery has read. Comment |
Hi Nils — this is the reworked interactive tutorial we discussed. As agreed, we've taken ownership of the walkthrough content and rebuilt it on top of your data-driven engine from #60. Happy to adjust anything before it goes in.
What changed
Notes
chapters.data.js,TutorialPlayer.vue, frontmatter schema) is reused.docs/public/assets/images/tutorial-maps/, matching the image convention from fix images and banners #61.Once CI runs, the PR preview deployment link is the easiest way to click through the whole thing.
🤖 Generated with Claude Code
Summary by Sourcery
Rework the new-player tutorial into a real-map, guided introduction to MUME that takes beginners from basic concepts through their first adventure and live-client handoff.
New Features:
Enhancements:
Documentation:
Chores: