Skip to content

Add opt-in embedded Keyring support to Forever Bags - #3425

Open
Almightree wants to merge 12 commits into
EllesmereGaming:mainfrom
Almightree:feat/embedded-keyring
Open

Almightree wants to merge 12 commits into
EllesmereGaming:mainfrom
Almightree:feat/embedded-keyring

Conversation

@Almightree

@Almightree Almightree commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

What does this PR do?

Adds a Show Keyring option, disabled by default, for WoW Forever. Players can view and interact with keys directly inside EUI Bags.

  • Adds a dedicated Keyring sidebar view and Keyring sections in inventory-wide views.
  • Supports Grid, Compact, and List. Compact retains one real empty drop target when space remains; List shows occupied keys only.
  • Adds cross-character Keyring snapshots with separate freshness timestamps and ownership tooltip counts.
  • Preserves physical bag/slot identities, ordinary inventory capacity, and category filtering.
  • Keeps Keyring slots excluded from EUI pinning, junk marking, custom bank routing, and quick-split actions.

The existing Keyring popup option remains available independently.

Feature request: https://ellesmereui.com/features/397/add-keyring-to-eui-bags

How was it tested?

Automated and static checks

  • Repository guardrails passed.
  • Changed Lua files compile under Lua 5.1.
  • Local Lua behavioral checks passed for display projection, physical slot IDs, search, snapshots, freshness, ownership indexing, profile transitions, and empty-label rendering.
  • Locale keys regenerated and diff checks passed.
  • Cumulative diff reviewed after integrating upstream v9.8.8.

Local behavioral harnesses and tooling are excluded from this PR.

In-game testing

WoW Forever 1.30.1.70938, tested by myself and Mantis:

  • All Items, OneBag, MultiBag, and dedicated Keyring views across Grid, Compact, and List.
  • Populated and empty layouts, resizing, scrolling, and pooled-frame cleanup.
  • Key pickup/drop, movement between slots and bags, non-key rejection, tooltips, shift-click linking, and intended key use.
  • Search filtering and clearing, including Compact drop-target visibility.
  • Pinning/junk exclusions, sorting, Quick Actions cleanup, and bank/merchant interactions.
  • Setting persistence, enabled/disabled profile transitions, and return to All Items when Keyring is disabled.
  • Opening populated bags in combat and after reloading during combat.
  • Cross-character contents, read-only interactions, freshness, ownership updates, and unrecorded versus empty snapshots.
  • Follow-up checks for offline visibility invalidation, dedicated List empty-slot exclusion, and empty-label font updates.

Midnight 12.1.5.70783: smoke-tested with no Lua errors observed.

Formal taint-log verification was not performed by the contributor.

Screenshots

Before

Screenshot 2026-11-16 100536 Screenshot 2026-11-16 100614

After

Screenshot 2026-11-10 192444 Screenshot 2026-11-16 090401 Screenshot 2026-11-16 090415 Screenshot 2026-11-16 090439 Screenshot 2026-11-16 090448 Screenshot 2026-11-16 090535 Screenshot 2026-11-16 091034

Checklist

  • New settings default OFF
  • Zero cost while disabled: no feature-specific event registrations, polling, tickers, or Keyring collection
  • Cheap while enabled: event-driven, using existing inventory refresh/save infrastructure
  • No new unsafe writes to Blizzard-owned frames identified in review; existing secure item-button and combat-deferral paths reused
  • Tested in-game on WoW Forever, with a Midnight regression smoke test

Closes #2688

@Almightree
Almightree marked this pull request as ready for review November 16, 2026 18:11
@Arcitec

Arcitec commented Nov 17, 2026 •

Copy link
Copy Markdown

@Almightree Wow thank you so much for this feature!

I notice one thing though. It adds an annoying keyring slot to all the other bag views (like All Items, Onebag, Multibag). It's overkill because checking keys is something we do very rarely.

I would recommend a "..." dot menu next to this feature, which defaults to:

"Don't show in general bag sections".

So that it's only accessible by clicking the Keyring in the left bar.

Otherwise that clutter on the normal bag view will drive me insane. ;D

@Arcitec

Arcitec commented Nov 17, 2026 •

Copy link
Copy Markdown

I also noticed that EllesmereUI recently has added a keyring skin (in 9.8.7 on November 15). Which honestly makes me wish you had gone more in the direction of #2688 with a single button that just opens the keyring without cluttering regular bags (or the bag category sidebar) at all.

A very simple implementation would be:

  • The "Show bags" icon in EllesmereUI also has a statically included Keyring icon.
  • Clicking it opens the separate, floating Keyring window. ToggleBag(KEYRING_CONTAINER)
image

That's the appropriate amount of access to a feature that people check once per year. Having it in the UI: Good. Cluttering the bags with it: Why?

Maybe someone wants it in the regular bags for some reason. So this PR is fine. But it doesn't solve the issue of getting access to keys without cluttering the UI with it.

@Arcitec

Arcitec commented Nov 17, 2026 •

Copy link
Copy Markdown

Oh cool, someone already implemented the keyring icon in top bar idea in 9.8.7:

image image

Which means your PR is a wholly separate feature. Which is pretty cool for those who want this level of keyring view. Go for it! 👍 :)

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.

WoW Forever Bags: Keyring button

2 participants