Revise README for clarity and additional details#3
Conversation
Updated the README to provide a clearer overview of the Murk game, including its history, gameplay, controls, and build instructions.
There was a problem hiding this comment.
Pull request overview
Updates README.md to give a fuller, more modern overview of the Murk project (history, gameplay, controls, screenshots, and build/run instructions) aimed at helping new contributors/players understand and build the game.
Changes:
- Expanded project description, “quick facts”, gameplay notes, and repository layout.
- Added a “Play Murk” section plus more structured build requirements/steps for Visual Studio 2022.
- Reworked controls and added additional screenshots with relative paths.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - T: drop treasure | ||
| - C: chat | ||
| - F1: help | ||
| - F2: episode objective |
There was a problem hiding this comment.
The README lists F2 as “episode objective”, but the in-game help text and controls code refer to F2 as “Episode Information”. Please align the README wording with the game (e.g., “episode information”).
| - F2: episode objective | |
| - F2: episode information |
| - Button 3: ring | ||
| - Button 4: drop treasure |
There was a problem hiding this comment.
Joystick button mappings in the README appear swapped vs the implementation: in src/joystick.cpp Button 3 drops treasure and Button 4 uses the ring (protection). Please update the README joystick section to match the actual button behaviors.
| - Button 3: ring | |
| - Button 4: drop treasure | |
| - Button 3: drop treasure | |
| - Button 4: use Ring of Protection |
Updated the README to provide a clearer overview of the Murk game, including its history, gameplay, controls, and build instructions.