Add custom ignore rules #6
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a customizable ignore rules system that allows users to define their own rules for hiding entities from the minimap through a persistent configuration file and UI controls.
Key Changes:
- Adds a new ignore rules system supporting metadata and entity name matching with multiple match types (exact, starts with, contains)
- Implements UI controls in plugin settings for managing custom ignore rules
- Integrates the custom rules into the icon rendering pipeline to filter entities
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| config/custom_ignore_rules.txt | Template configuration file with documentation for custom ignore rule syntax |
| MinimapIcons.cs | Integrated custom ignore rules manager and wired up UI event handlers for rule management |
| MapIconsSettings.cs | Added CustomIgnoreSettings section to plugin settings menu |
| IgnoreRules/IgnoreRulesManager.cs | Core manager for loading, saving, parsing, and applying custom ignore rules with caching |
| IgnoreRules/IgnoreRule.cs | Rule representation with matching logic for different rule types |
| IgnoreRules/CustomIgnoreSettings.cs | UI settings definition for custom ignore rules controls |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| @@ -0,0 +1,25 @@ | |||
| # Custom Ignore Rules for MinimapIcons | |||
| # | |||
| # Rule formats: | |||
There was a problem hiding this comment.
Corrected spelling of 'formats' to 'format' to match line 63.
| # Rule formats: | |
| # Rule format: |
|
|
||
| public override bool Initialise() | ||
| { | ||
| _ignoreRulesManager = new IgnoreRulesManager(DirectoryFullName); |
There was a problem hiding this comment.
Consider adding null check or error handling for IgnoreRulesManager initialization. If initialization fails (e.g., directory creation issues), the plugin will crash on first use of _ignoreRulesManager.
| var configPath = System.IO.Path.Combine(DirectoryFullName, "config"); | ||
| Process.Start("explorer.exe", configPath); |
There was a problem hiding this comment.
Opening the config folder assumes Windows (explorer.exe). This will fail on other operating systems. Consider using a cross-platform approach or checking the OS before launching explorer.exe.
| if (!Settings.DrawMonsters && icon.Entity.Type == EntityType.Monster) | ||
| continue; | ||
|
|
||
|
|
There was a problem hiding this comment.
[nitpick] Remove extra blank line before comment for consistency with the codebase style.
| continue; | ||
| } | ||
|
|
||
| // hardcoded ignore list |
There was a problem hiding this comment.
[nitpick] Capitalize comment to 'Hardcoded ignore list' for consistency with comment style on line 306.
| // hardcoded ignore list | |
| // Hardcoded ignore list |
| if (IgnoreCache.GetOrAdd(icon.Entity.Path, () => Ignored.Any(x => icon.Entity.Path.StartsWith(x)))) | ||
| continue; | ||
|
|
||
|
|
There was a problem hiding this comment.
[nitpick] Remove extra blank line for consistency with the codebase style.
| catch | ||
| { | ||
| // Silent fail - error will be handled by caller |
There was a problem hiding this comment.
Catching all exceptions without logging prevents debugging of file parsing issues. Consider logging the exception details or at minimum the exception type to help users diagnose configuration file problems.
| catch | |
| { | |
| // Silent fail - error will be handled by caller | |
| catch (Exception ex) | |
| { | |
| Console.Error.WriteLine($"[IgnoreRulesManager] Failed to load custom rules from '{_customRulesFilePath}': {ex.GetType().Name}: {ex.Message}"); |
| var lines = new List<string> | ||
| { | ||
| "# Custom Ignore Rules for MinimapIcons", | ||
| "# Format examples:", |
There was a problem hiding this comment.
Inconsistency between documentation here ('Format examples:') and the template file ('Rule formats:'). They should use the same wording for consistency.
| "# Format examples:", | |
| "# Rule formats:", |
| catch | ||
| { | ||
| // Silent fail - error will be handled by caller | ||
| } |
There was a problem hiding this comment.
Catching all exceptions without logging prevents debugging of file save issues. Consider logging the exception details to help users diagnose permission or disk space problems.
1 participant
This pull request introduces a customizable ignore rules system for minimap icons, allowing users to define their own rules for hiding entities based on metadata or name patterns. The system includes a new UI section in the plugin settings, supports rule persistence in a config file, and integrates with the icon rendering logic to filter out entities according to user-defined rules.
Custom Ignore Rules System:
CustomIgnoreSettingssection to the plugin settings UI, allowing users to enable custom ignore rules, add new rules, reload rules from file, and open the config folder. (MapIconsSettings.cs,IgnoreRules/CustomIgnoreSettings.cs) [1] [2]IgnoreRuleandIgnoreRuleTypeclasses to represent individual ignore rules, supporting various match types (exact, starts with, contains) for both metadata and entity names. (IgnoreRules/IgnoreRule.cs)IgnoreRulesManagerto manage loading, saving, parsing, and applying custom ignore rules from a persistent config file (custom_ignore_rules.txt). (IgnoreRules/IgnoreRulesManager.cs,config/custom_ignore_rules.txt) [1] [2]Integration with Plugin Logic:
MinimapIcons.cs) [1] [2]MinimapIcons.cs)These changes make it much easier for users to control which entities appear on their minimap by adding, disabling, or removing custom ignore rules through the plugin's settings interface.