docs: document the R/Z run/crouch toggles for text mode#497
Merged
Conversation
The README controls table listed only held Shift/Ctrl for run/crouch, not the existing run_toggle (R) / crouch_toggle (Z) single-press toggles. A terminal can't detect held keys, so the toggles are the only way to run/crouch in --text mode. The toggle feature (with status-bar state, and pygame hold behavior unchanged) already exists; this documents it. Closes #480 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Member
Author
|
Self-review rubric (reviewed by Claude; CI green on head):
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Addresses #480 (run/crouch don't work in text mode). On investigation, the toggle model the issue proposed already exists:
run_toggle(R) andcrouch_toggle(Z) are bound to terminal-usable ASCII keys, toggle the player's run/crouch with a single press, show the state in the status bar ("Run: ON/OFF", "Crouch: ON/OFF"), and leave the pygame held Shift/Ctrl behavior unchanged (worldScreen.py:962-978,keyBindings.py:25-26). All of the issue's acceptance criteria are met by existing code.The remaining gap was discoverability: the README controls table listed only the held Shift/Ctrl bindings, not the R/Z toggles — and since a terminal can't detect held keys, the toggles are the only way to run/crouch in
--textmode. This PR documents them.Changes
Shift (hold) or R (toggle) | RunandCtrl (hold) or Z (toggle) | Crouch.Test plan
Closes #480
🤖 Generated with Claude Code