Timmy_Foundation/the-beacon
15
0
Fork 0
Code Issues 22 Pull Requests 5 Actions Packages Projects Releases Wiki Activity

feat: first-time player tutorial walkthrough #66

Open
Timmy wants to merge 1 commits from beacon/polish-tutorial-onboarding into main
pull from: beacon/polish-tutorial-onboarding
merge into: Timmy_Foundation:main
Conversation 2 Commits 1 Files Changed 3 +252 -1
Timmy commented 2026-04-11 08:49:12 +00:00
Owner
Copy Link

Part of #57

What

Adds a 5-screen click-through tutorial for first-time players, triggered on the very first game session.

Screens

  1. The Beacon — game intro, what it is
  2. Write Code — core mechanic, combo system
  3. Build & Research — passive production, projects
  4. Phases & Progress — 6-phase progression, progress bar
  5. You're Ready — summary, keyboard shortcut hint

Features

  • Skip button on every screen — one click exits
  • Keyboard support — Enter/Right advances, Escape closes
  • One-time only — stored in localStorage key the-beacon-tutorial-done
  • Style-matched — dark theme, accent colors, monospace font, smooth animations
  • Non-blocking — game tick loop runs underneath the overlay

Files changed

  • js/tutorial.js — new file, all tutorial logic + styles
  • js/main.js — hooks startTutorial() for new games
  • index.html — adds script tag

Testing

  • Opened index.html in browser — tutorial appears on fresh load
  • Skip button dismisses overlay immediately
  • Tutorial does not appear after page reload (localStorage set)
  • Reset game — tutorial reappears
  • Keyboard shortcuts work (Enter, Escape, Arrow keys)
  • Smoke test passes (29/30 — pre-existing community_drama bug unrelated to this PR)
Part of #57 ## What Adds a 5-screen click-through tutorial for first-time players, triggered on the very first game session. ## Screens 1. **The Beacon** — game intro, what it is 2. **Write Code** — core mechanic, combo system 3. **Build & Research** — passive production, projects 4. **Phases & Progress** — 6-phase progression, progress bar 5. **You're Ready** — summary, keyboard shortcut hint ## Features - **Skip button** on every screen — one click exits - **Keyboard support** — Enter/Right advances, Escape closes - **One-time only** — stored in localStorage key `the-beacon-tutorial-done` - **Style-matched** — dark theme, accent colors, monospace font, smooth animations - **Non-blocking** — game tick loop runs underneath the overlay ## Files changed - `js/tutorial.js` — new file, all tutorial logic + styles - `js/main.js` — hooks startTutorial() for new games - `index.html` — adds script tag ## Testing - Opened index.html in browser — tutorial appears on fresh load - Skip button dismisses overlay immediately - Tutorial does not appear after page reload (localStorage set) - Reset game — tutorial reappears - Keyboard shortcuts work (Enter, Escape, Arrow keys) - Smoke test passes (29/30 — pre-existing community_drama bug unrelated to this PR)
Timmy added 1 commit 2026-04-11 08:49:13 +00:00
feat: add first-time player tutorial walkthrough
Some checks failed
Accessibility Checks / a11y-audit (pull_request) Failing after 2s
Details
Smoke Test / smoke (pull_request) Failing after 3s
Details
3b142d485e 
Part of #57 — Task 4: Tutorial & Onboarding

- 5 click-through screens introducing game concepts (code, buildings,
  research, phases, keyboard shortcuts)
- Skip button on every screen, keyboard support (Enter/Escape/arrows)
- Stores completion in localStorage — only shows once for new players
- Matches existing visual style (dark theme, accent colors, monospace)
- Start Playing button on final screen with shortcut hint (? overlay)
Rockachopa commented 2026-04-11 09:32:08 +00:00
Owner
Copy Link

🚫 Blocked: Required status checks failing — Both Smoke Test and Accessibility Checks fail within 3s. These fast failures suggest infrastructure/config issues rather than test logic failures. The repo has branch protection requiring these checks to pass. Fix CI before this can merge.

🚫 **Blocked: Required status checks failing** — Both Smoke Test and Accessibility Checks fail within 3s. These fast failures suggest infrastructure/config issues rather than test logic failures. The repo has branch protection requiring these checks to pass. Fix CI before this can merge.
allegro was assigned by Rockachopa 2026-04-11 09:45:10 +00:00
Timmy commented 2026-04-11 10:11:02 +00:00
Author
Owner
Copy Link

🚫 Cannot merge — CI failing.

• Smoke Test / smoke: ❌
• Accessibility Checks / a11y-audit: ❌

Please fix the CI failures before merging.

🚫 **Cannot merge — CI failing.** • Smoke Test / smoke: ❌ • Accessibility Checks / a11y-audit: ❌ Please fix the CI failures before merging.
Some checks failed
Accessibility Checks / a11y-audit (pull_request) Failing after 2s
Details
Smoke Test / smoke (pull_request) Failing after 3s
Details
This pull request doesn't have enough required approvals yet. 0 of 1 official approvals granted.
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin beacon/polish-tutorial-onboarding:beacon/polish-tutorial-onboarding
git checkout beacon/polish-tutorial-onboarding
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
P0
P1
P2
P3
architecture
devops
documentation
education
endgame
gameplay
mechanics
narrative
polish
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
Rockachopa Timmy allegro antigravity bezalel claude codex-agent ezra gemini google grok hermes kimi manus perplexity
No Assignees allegro
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Timmy_Foundation/the-beacon#66
Delete Branch "beacon/polish-tutorial-onboarding"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?