Skip to content

Add bridge-first formation controls and localized status tooltip - #47

Merged
Wishmaster117 merged 3 commits into
mainfrom
Add-bridge-first-formation-controls-and-localized-status-tooltip
Aug 3, 2026
Merged

Add bridge-first formation controls and localized status tooltip#47
Wishmaster117 merged 3 commits into
mainfrom
Add-bridge-first-formation-controls-and-localized-status-tooltip

Conversation

@Wishmaster117

@Wishmaster117 Wishmaster117 commented Aug 3, 2026

Copy link
Copy Markdown
Owner

Moves formation selection and inspection out of PARTY/RAID chat, adds a localized per-bot formation tooltip, and keeps the scope raid-wide for all controllable bots.

Summary by CodeRabbit

  • New Features

    • Added formation controls for party and raid groups.
    • Added asynchronous formation status queries with tooltips showing unavailable, timeout, empty, mixed, and individual formation states.
    • Successful formation changes now update the selected formation indicator automatically.
    • Added localized formation names and status messages in multiple languages.
  • Documentation

    • Updated setup, usage, troubleshooting, project layout, and roadmap documentation for formation features.

Moves formation selection and inspection out of PARTY/RAID chat, adds a localized per-bot formation tooltip, and keeps the scope raid-wide for all controllable bots.
@coderabbitai

coderabbitai Bot commented Aug 3, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@Wishmaster117, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 17 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 951e6f64-5f2e-4cff-8b83-de72d6c24430

📥 Commits

Reviewing files that changed from the base of the PR and between 3d7fdbd and 78a5c92.

📒 Files selected for processing (12)
  • Core/MultiBotComm.lua
  • Locales/MultiBotAceLocale-deDE.lua
  • Locales/MultiBotAceLocale-enGB.lua
  • Locales/MultiBotAceLocale-enUS.lua
  • Locales/MultiBotAceLocale-esES.lua
  • Locales/MultiBotAceLocale-frFR.lua
  • Locales/MultiBotAceLocale-koKR.lua
  • Locales/MultiBotAceLocale-ruRU.lua
  • Locales/MultiBotAceLocale-zhCN.lua
  • README.md
  • UI/MultiBotFormationUI.lua
  • docs/ROADMAP.md
📝 Walkthrough

Walkthrough

The PR adds asynchronous formation commands and formation queries. It processes acknowledgements, payloads, timeouts, and state resets. The UI displays localized formation results. README and roadmap documentation describe the bridge behavior.

Changes

Formation support

Layer / File(s) Summary
Formation bridge commands and queries
Core/MultiBotComm.lua
The communication layer adds validated formation commands, tokenized callbacks, query collection, sorting, timeouts, acknowledgement handling, and disconnect/world-entry cleanup.
Formation control and query display
UI/MultiBotFormationUI.lua
The UI uses asynchronous bridge APIs, ignores stale callbacks, updates successful selections, and displays formation query results.
Localized formation status
Locales/MultiBotAceLocale-*.lua
All supported locales define formation query messages and formation names for supported, distant, and unknown states.
Formation bridge documentation
README.md, docs/ROADMAP.md
Documentation covers bridge commands, controls, localized tooltips, troubleshooting, validation, and project documentation links.

Estimated code review effort: 4 (Complex) | ~45 minutes

Sequence Diagram(s)

sequenceDiagram
  participant FormationUI
  participant MultiBotComm
  participant Bridge
  participant Bots
  FormationUI->>MultiBotComm: RunFormationCommand(scope, target, formation, callback)
  MultiBotComm->>Bridge: Send RUN~FORMATION
  Bridge->>Bots: Apply formation
  Bots-->>Bridge: FORMATION_ACK
  Bridge-->>MultiBotComm: Return formation result
  MultiBotComm-->>FormationUI: Invoke callback
  FormationUI->>MultiBotComm: RequestFormations(callback)
  MultiBotComm->>Bridge: Request formation data
  Bridge-->>MultiBotComm: Send formation payloads
  MultiBotComm-->>FormationUI: Display sorted results
Loading

Possibly related PRs

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the bridge-first formation controls and localized status tooltip added by the pull request.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch Add-bridge-first-formation-controls-and-localized-status-tooltip

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 3d7fdbd058

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread UI/MultiBotFormationUI.lua Outdated
Comment thread docs/ROADMAP.md Outdated

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 6

🧹 Nitpick comments (1)
UI/MultiBotFormationUI.lua (1)

163-186: 🩺 Stability & Availability | 🔵 Trivial | ⚡ Quick win

Formation selection gives no feedback when the command is not sent.

MultiBot.Comm.RunFormationCommand returns false when the bridge is disconnected or the send fails. In that case token is falsy, the code skips the assignment, and the user sees nothing. The right-click path at lines 206-227 shows the formation.query.unavailable tooltip for the same condition. Align the left-click path, and also clear the stale latestFormationToken.

♻️ Proposed alignment with the right-click path
         if token then
             latestFormationToken = token
+        else
+            latestFormationToken = nil
+            showFormationTooltip(button, { status = "unavailable" })
         end
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@UI/MultiBotFormationUI.lua` around lines 163 - 186, Update the left-click
formation command flow around RunFormationCommand to handle a falsy token like
the right-click path: clear latestFormationToken and show the
formation.query.unavailable tooltip when the command is not sent. Preserve the
existing token assignment and callback behavior for successful sends.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@Core/MultiBotComm.lua`:
- Around line 432-446: Add timeout cleanup to Comm.RunFormationCommand matching
Comm.RequestFormations: remove the pending formationCommands entry and invoke
its callback with a timeout result when no acknowledgement arrives. Also reset
state.formationCommands in Core/MultiBotComm.lua lines 1090-1090 within
Comm.MarkDisconnected, alongside the existing outfitCommands and trainerCommands
resets.

In `@docs/ROADMAP.md`:
- Around line 66-71: The documentation incorrectly describes right-click
formation inspection as PARTY/RAID-chat-based instead of bridge-delivered.
Update docs/ROADMAP.md lines 66-71 and 160-161 to state that
MultiBotFormationUI.lua uses Comm.RequestFormations() with the
GET~FORMATIONS~GROUP bridge path; docs/ROADMAP.md lines 160-161 require the same
correction. Use README.md lines 206-209 and 492-493 as the existing reference
and make no direct changes there.

In `@Locales/MultiBotAceLocale-enUS.lua`:
- Around line 1033-1049: Add the missing formation.confirm.none and
formation.confirm.partial localization keys to the English locale and every
other locale file, matching the fallback strings used by Core/MultiBotComm.lua.
Keep the keys grouped with the existing formation query/name entries so
confirmation notifications use translated locale values.

In `@Locales/MultiBotAceLocale-koKR.lua`:
- Line 1024: Update the localized string for formation.query.unavailable to
replace the English “Bridge” with the existing Korean term “브릿지,” preserving the
rest of the message unchanged.

In `@Locales/MultiBotAceLocale-ruRU.lua`:
- Line 1040: Update the `formation.name.near` localization to use the existing
noun phrase `Скученное построение` instead of `Рядом`, matching the established
formation label.

In `@README.md`:
- Around line 103-111: README.md lines 103-111, 575-591, and docs/ROADMAP.md
lines 49-61 must present one consistent bridge-request contract. Update the
request list near GET~FORMATIONS and RUN~FORMATION to document complete syntax,
including GET~FORMATIONS~GROUP~~<token> and RUN~FORMATION~GROUP, or explicitly
identify GET/RUN as request families with those full examples; keep the README
query and roadmap scope aligned.

---

Nitpick comments:
In `@UI/MultiBotFormationUI.lua`:
- Around line 163-186: Update the left-click formation command flow around
RunFormationCommand to handle a falsy token like the right-click path: clear
latestFormationToken and show the formation.query.unavailable tooltip when the
command is not sent. Preserve the existing token assignment and callback
behavior for successful sends.
🪄 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: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: be0e43ad-a7e7-43bb-aff6-8c47a007ae54

📥 Commits

Reviewing files that changed from the base of the PR and between df3402f and 3d7fdbd.

📒 Files selected for processing (12)
  • Core/MultiBotComm.lua
  • Locales/MultiBotAceLocale-deDE.lua
  • Locales/MultiBotAceLocale-enGB.lua
  • Locales/MultiBotAceLocale-enUS.lua
  • Locales/MultiBotAceLocale-esES.lua
  • Locales/MultiBotAceLocale-frFR.lua
  • Locales/MultiBotAceLocale-koKR.lua
  • Locales/MultiBotAceLocale-ruRU.lua
  • Locales/MultiBotAceLocale-zhCN.lua
  • README.md
  • UI/MultiBotFormationUI.lua
  • docs/ROADMAP.md

Comment thread Core/MultiBotComm.lua
Comment thread docs/ROADMAP.md Outdated
Comment thread Locales/MultiBotAceLocale-enUS.lua
Comment thread Locales/MultiBotAceLocale-koKR.lua Outdated
Comment thread Locales/MultiBotAceLocale-ruRU.lua Outdated
Comment thread README.md
@Wishmaster117
Wishmaster117 merged commit 69921f5 into main Aug 3, 2026
5 checks passed
@Wishmaster117
Wishmaster117 deleted the Add-bridge-first-formation-controls-and-localized-status-tooltip branch August 3, 2026 20:05
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