Skip to content

Conversation

@Halvance
Copy link

@Halvance Halvance commented Dec 17, 2025

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.

Summary by Sourcery

Update resource configuration and build documentation for the project.

Enhancements:

  • Refresh configuration-related resources to support updated and future icons in the application UI.

Build:

  • Adjust .gitignore entries to exclude build artifacts and temporary files.

Documentation:

  • Add BUILD_GUIDE.md with detailed Windows build and troubleshooting instructions for the seasonal textures feature.

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.
@sourcery-ai
Copy link

sourcery-ai bot commented Dec 17, 2025

Reviewer's Guide

Updates 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 feature

sequenceDiagram
  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
Loading

File-Level Changes

Change Details Files
Add a comprehensive Windows/Qt/CMake build guide for the seasonal textures feature.
  • Create BUILD_GUIDE.md with prerequisites (CMake, Qt6, Ninja, C++ compiler) and environment setup instructions.
  • Document quick build workflow via build script and manual CMake+Ninja steps.
  • Describe common build errors specific to seasonal textures changes and how they were previously fixed in code.
  • Provide Visual Studio generator usage, build-type configuration, troubleshooting steps, and next steps for wiring seasonal texture UI controls.
BUILD_GUIDE.md
Tighten ignore rules to avoid committing local build artifacts and temporary tool files.
  • Ignore Windows executables and batch scripts produced by local builds.
  • Ignore the .claude/ directory and nul artifact to prevent accidental commits of local tooling files.
.gitignore
Update Qt resource collection to use modernized configuration icons and prepare for future features.
  • Replace existing configuration dialog icons (autologger, general, graphics, mume protocol, parser, pathmachine, terminal, group-recolor) with modernized assets in the Qt resource file.
  • Register new icons for upcoming features such as hotkeys and communications without wiring them into code yet.
src/resources/mmapper2.qrc

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a 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_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.
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.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link

codecov bot commented Dec 18, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 65.48%. Comparing base (26d1a9d) to head (6b415bd).
⚠️ Report is 153 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant