Skip to content

🎨 Palette: Add keyboard instructions and accessibility to Mario game #194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
EiJackGH wants to merge 1 commit into
base: main
Choose a base branch
from
Open

🎨 Palette: Add keyboard instructions and accessibility to Mario game #194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 3 additions & 14 deletions .Jules/palette.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,3 @@
## 2024-05-23 - CLI UX Enhancement
**Learning:** Even in CLI apps, visual distinction (colors, emojis) significantly reduces cognitive load when scanning logs.
**Action:** Use ANSI colors and consistent emojis for key events (success/failure) in future CLI tools.

## 2025-02-28 - Structured CLI Reports
**Learning:** Dense numerical data in CLI output is hard to parse. Using ASCII box-drawing characters and alignment to create a "dashboard" or "invoice" style summary significantly improves readability and perceived quality.
**Action:** When summarizing simulation or batch job results, always format the final report as a structured table or box rather than a list of print statements.
## 2024-05-20 - Dynamic Progress Bar for Quiet CLI Tasks
**Learning:** For long-running CLI processes that suppress verbose logging (e.g., `--quiet`), users lose system status visibility.
**Action:** Implemented a dynamic progress bar using `\r` and `flush=True`, conditional on `sys.stdout.isatty()`, to provide status feedback without polluting non-interactive logs.

## 2025-03-23 - Game Key Scrolling
**Learning:** Browsers natively scroll the page when users press Space or Arrow keys. When building a web-based game, this creates a frustrating UX where the game viewport jumps around while playing.
**Action:** Always call `e.preventDefault()` on keydown events for typical game controls ("Space", "ArrowUp", etc.) when the focus is on a game container or the body.
## 2024-06-14 - Game Interaction and Accessibility
**Learning:** For web-based interactive games with dynamic scoring, combining custom keyboard listeners with ARIA attributes is tricky. Keypresses for games (like Space/Arrows) must explicitly call `e.preventDefault()` to stop unwanted page scrolling, while dynamic status updates (like score counters) need `aria-live="polite"` and `aria-atomic="true"`. However, static instructions should not be placed inside the `aria-live` region, as the screen reader will redundantly announce them on every score tick.
**Action:** Always extract static instructional text into a separate sibling element from dynamic status updates, and implement `e.preventDefault()` on game-bound keys.
1 change: 0 additions & 1 deletion requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
numpy
pandas
requests
venv
13 changes: 12 additions & 1 deletion src/views/mario-game.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,24 @@
font-size: 20px;
font-family: Arial;
}

#instructions {
position: absolute;
top: 40px;
left: 10px;
color: white;
font-size: 16px;
font-family: Arial;
opacity: 0.8;
}
</style>
</head>

<body>

<div id="game">
<div id="score">Score: 0</div>
<div id="score" aria-live="polite" aria-atomic="true">Score: 0</div>
<div id="instructions">Press Space or Up Arrow to jump</div>
<div id="mario"></div>
<div class="ground"></div>
</div>
Expand Down
Loading