docs: refresh README to reflect current addon state (#181)#182
Merged
docs: refresh README to reflect current addon state (#181)#182
Conversation
Updates Supported Versions table to match DragonToast.toc, rewrites Features for the 3.x feature set (roll-win toasts, mail/reputation/currency toasts, hover-pause, inventory item count, skin presets, bundled sounds), adds new Sub-addons / Toast Types / Localization sections, documents slash command aliases and full filter set, expands Integration API to cover the legacy DragonLoot bridge and 120s safety timer. Closes #181
Contributor
📝 WalkthroughWalkthroughREADME.md updated to reflect current addon state: adds CurseForge/Wago badges, refreshes feature list and version table, documents DragonToast_Options sub-addon, revises installation and command documentation, updates API integration details, and adds explicit localization and contributing guidance. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Review rate limit: 0/1 reviews remaining, refill in 60 minutes.Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 108-129: Replace the incorrect "AceComm-3.0" reference with
"AceEvent-3.0" in the README description so it matches the actual message bus
used (see DRAGONTOAST_QUEUE_TOAST, DRAGONTOAST_SUPPRESS, DRAGONTOAST_UNSUPPRESS
and the example calling LibStub("AceEvent-3.0"):SendMessage), and ensure the
text and any headings or introductory sentence referencing the listener
explicitly say "AceEvent-3.0" to align with MessageBridge.lua's handler pattern.
- Line 33: The README line describing "DragonLoot AceComm integration" is
incorrect: replace the reference to AceComm with AceEvent because the
integration uses LibStub("AceEvent-3.0"):SendMessage() and the message handler
pattern in MessageBridge.lua; update the sentence to read something like
"DragonLoot AceEvent integration: suppresses duplicate loot toasts and queues
celebration toasts for roll wins" so it correctly references AceEvent-3.0 and
aligns with the example code and MessageBridge.lua.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: 8233afe0-9d5b-47c5-bbb6-93077eaab923
📒 Files selected for processing (1)
README.md
| - LibSharedMedia integration: full control over fonts, background textures, and borders | ||
| - Sound picker with bundled default notification sounds | ||
| - Defer-in-combat option to delay toast display until after combat ends | ||
| - DragonLoot AceComm integration: suppresses duplicate loot toasts and queues celebration toasts for roll wins |
Contributor
There was a problem hiding this comment.
Factual error: AceComm should be AceEvent.
The integration uses AceEvent-3.0 (internal message bus), not AceComm-3.0 (addon channel communication). This is confirmed by the example code on line 120 which calls LibStub("AceEvent-3.0"):SendMessage() and the message handler pattern in MessageBridge.lua.
📝 Proposed correction
-- DragonLoot AceComm integration: suppresses duplicate loot toasts and queues celebration toasts for roll wins
+- DragonLoot AceEvent integration: suppresses duplicate loot toasts and queues celebration toasts for roll wins📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| - DragonLoot AceComm integration: suppresses duplicate loot toasts and queues celebration toasts for roll wins | |
| - DragonLoot AceEvent integration: suppresses duplicate loot toasts and queues celebration toasts for roll wins |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 33, The README line describing "DragonLoot AceComm
integration" is incorrect: replace the reference to AceComm with AceEvent
because the integration uses LibStub("AceEvent-3.0"):SendMessage() and the
message handler pattern in MessageBridge.lua; update the sentence to read
something like "DragonLoot AceEvent integration: suppresses duplicate loot
toasts and queues celebration toasts for roll wins" so it correctly references
AceEvent-3.0 and aligns with the example code and MessageBridge.lua.
Comment on lines
108
to
+129
|
|
||
| DragonToast provides a generic AceEvent messaging API for other addons to control toast behavior: | ||
| DragonToast listens for AceComm-3.0 messages. Other addons can trigger or suppress toasts without a hard dependency. | ||
|
|
||
| | Message | Payload | Description | | ||
| |:--------|:--------|:------------| | ||
| | `DRAGONTOAST_SUPPRESS` | `source` (string) | Suppress normal loot toasts (120s safety timer) | | ||
| | `DRAGONTOAST_UNSUPPRESS` | `source` (string) | Clear suppression for the given source | | ||
| | `DRAGONTOAST_QUEUE_TOAST` | `data` (table) | Queue a toast with a custom data payload | | ||
|
|
||
| ### Example Usage | ||
|
|
||
| ```lua | ||
| -- Queue a custom toast via AceEvent-3.0 | ||
| local payload = { | ||
| itemName = "Sulfuras, Hand of Ragnaros", | ||
| itemIcon = 132711, | ||
| itemQuality = 5, | ||
| quantity = 1, | ||
| isSelf = true | ||
| } | ||
| LibStub("AceEvent-3.0"):SendMessage("DRAGONTOAST_QUEUE_TOAST", payload) | ||
| ``` |
Contributor
There was a problem hiding this comment.
Factual error: AceComm should be AceEvent.
Line 109 claims DragonToast "listens for AceComm-3.0 messages", but line 120 contradicts this by showing the correct usage: LibStub("AceEvent-3.0"):SendMessage(). The message handler pattern in MessageBridge.lua confirms this is AceEvent (internal message bus), not AceComm (addon channel communication).
📝 Proposed correction
-DragonToast listens for AceComm-3.0 messages. Other addons can trigger or suppress toasts without a hard dependency.
+DragonToast listens for AceEvent-3.0 messages. Other addons can trigger or suppress toasts without a hard dependency.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| DragonToast provides a generic AceEvent messaging API for other addons to control toast behavior: | |
| DragonToast listens for AceComm-3.0 messages. Other addons can trigger or suppress toasts without a hard dependency. | |
| | Message | Payload | Description | | |
| |:--------|:--------|:------------| | |
| | `DRAGONTOAST_SUPPRESS` | `source` (string) | Suppress normal loot toasts (120s safety timer) | | |
| | `DRAGONTOAST_UNSUPPRESS` | `source` (string) | Clear suppression for the given source | | |
| | `DRAGONTOAST_QUEUE_TOAST` | `data` (table) | Queue a toast with a custom data payload | | |
| ### Example Usage | |
| ```lua | |
| -- Queue a custom toast via AceEvent-3.0 | |
| local payload = { | |
| itemName = "Sulfuras, Hand of Ragnaros", | |
| itemIcon = 132711, | |
| itemQuality = 5, | |
| quantity = 1, | |
| isSelf = true | |
| } | |
| LibStub("AceEvent-3.0"):SendMessage("DRAGONTOAST_QUEUE_TOAST", payload) | |
| ``` | |
| DragonToast listens for AceEvent-3.0 messages. Other addons can trigger or suppress toasts without a hard dependency. | |
| | Message | Payload | Description | | |
| |:--------|:--------|:------------| | |
| | `DRAGONTOAST_SUPPRESS` | `source` (string) | Suppress normal loot toasts (120s safety timer) | | |
| | `DRAGONTOAST_UNSUPPRESS` | `source` (string) | Clear suppression for the given source | | |
| | `DRAGONTOAST_QUEUE_TOAST` | `data` (table) | Queue a toast with a custom data payload | | |
| ### Example Usage | |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 108 - 129, Replace the incorrect "AceComm-3.0"
reference with "AceEvent-3.0" in the README description so it matches the actual
message bus used (see DRAGONTOAST_QUEUE_TOAST, DRAGONTOAST_SUPPRESS,
DRAGONTOAST_UNSUPPRESS and the example calling
LibStub("AceEvent-3.0"):SendMessage), and ensure the text and any headings or
introductory sentence referencing the listener explicitly say "AceEvent-3.0" to
align with MessageBridge.lua's handler pattern.
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
1 participant
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.
Description
Refreshes README.md so it accurately reflects DragonToast as it sits on master. The previous README described the 1.x/2.x feature set and listed stale Interface versions; this brings it in sync with current source (TOC, listeners, slash commands, locales, integration API).
No source code changes - documentation only.
Type of Change
Related Issues
Closes #181
Testing
All claims verified against current source on master (TOC, listeners, slash commands, locale files, MessageBridge):
luacheck .) - n/a, no Lua changedChanges
Screenshots
n/a - no UI changes.
Checklist
Summary by CodeRabbit