-
Notifications
You must be signed in to change notification settings - Fork 29
Update configuration icons and add build documentation #423
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.
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
base: master
Are you sure you want to change the base?
Conversation
Visual & Documentation Updates: - Modernized all configuration dialog icons (autologger, general, graphics, mume protocol, parser, pathmachine, terminal, group-recolor) - Added new icons for future features (hotkeys, comms) - Added BUILD_GUIDE.md with detailed build instructions Cleanup: - Updated .gitignore to exclude build artifacts (*.exe, *.bat, .claude/, nul) - Prevents accidentally committing temporary files and build tools This PR focuses purely on visual polish and documentation, with no functional changes to the codebase.
Reviewer's GuideUpdates resource configuration icons, adds a detailed Windows/Qt/CMake build guide focused on the seasonal textures feature, and tightens .gitignore to exclude build artifacts and temporary tool directories, without changing runtime behavior. Sequence diagram for building and testing seasonal textures featuresequenceDiagram
actor Developer
participant Shell
participant CMake
participant Ninja
participant Compiler
participant QtRcc
participant MMapperExe
Developer->>Shell: mkdir build && cd build
Developer->>Shell: cmake -G "Ninja" -DCMAKE_BUILD_TYPE=RelWithDebInfo ..
Shell->>CMake: Configure project (locate Qt6, compiler, Ninja)
CMake-->>Shell: Build files for Ninja
Developer->>Shell: cmake --build . --config RelWithDebInfo
Shell->>Ninja: Start build
Ninja->>Compiler: Compile src source files
Ninja->>QtRcc: Compile mmapper2.qrc with textures into resources object
QtRcc-->>Ninja: Resources object file
Compiler-->>Ninja: Object files
Ninja->>Compiler: Link objects and resources into mmapper.exe
Compiler-->>Ninja: mmapper.exe
Ninja-->>Shell: Build complete
Developer->>Shell: src\mmapper.exe
Shell->>MMapperExe: Launch executable
MMapperExe->>MMapperExe: Load embedded seasonal texture resources
Developer->>MMapperExe: Connect to MUME and issue time command
MMapperExe->>MMapperExe: Detect current season and update textures
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey there - I've reviewed your changes - here's some feedback:
- The new BUILD_GUIDE.md is very Windows- and MSVC-specific (hardcoded paths like
C:\Qt\6.x.x\msvc2019_64and Ninja in-tree); consider clearly labeling it as Windows-only and/or separating out cross-platform, toolchain-agnostic instructions so it doesn’t mislead users on other setups. - Several troubleshooting notes in BUILD_GUIDE.md reference already-fixed seasonal texture issues and specific source files/lines; it may be more future-proof to describe these as examples of common Qt MOC/CMake problems without tying to past one-off fixes that could become outdated.
- The .gitignore additions for
*.exeand*.batare very broad and could unintentionally hide committed tooling or scripts; consider scoping these patterns to known build output directories instead of ignoring them project-wide.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The new BUILD_GUIDE.md is very Windows- and MSVC-specific (hardcoded paths like `C:\Qt\6.x.x\msvc2019_64` and Ninja in-tree); consider clearly labeling it as Windows-only and/or separating out cross-platform, toolchain-agnostic instructions so it doesn’t mislead users on other setups.
- Several troubleshooting notes in BUILD_GUIDE.md reference already-fixed seasonal texture issues and specific source files/lines; it may be more future-proof to describe these as examples of common Qt MOC/CMake problems without tying to past one-off fixes that could become outdated.
- The .gitignore additions for `*.exe` and `*.bat` are very broad and could unintentionally hide committed tooling or scripts; consider scoping these patterns to known build output directories instead of ignoring them project-wide.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #423 +/- ##
==========================================
- Coverage 66.48% 65.48% -1.01%
==========================================
Files 85 86 +1
Lines 4186 3963 -223
Branches 255 264 +9
==========================================
- Hits 2783 2595 -188
+ Misses 1403 1368 -35 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Visual & Documentation Updates:
Cleanup:
This PR focuses purely on visual polish and documentation, with no functional changes to the codebase.
Summary by Sourcery
Update resource configuration and build documentation for the project.
Enhancements:
Build:
Documentation: