Skip to content

WoW addon that optimizes M+ group decisions with automatic keystone detection, IO gain calculations, loot tracking, and smart dungeon recommendations. Supports premade groups and PUG workflows.

License

Notifications You must be signed in to change notification settings

sagerobot/NextKey

Repository files navigation

NextKey

The intelligent Mythic+ companion addon that helps you choose your next key in under 30 seconds.

NextKey analyzes your group's keystones, player scores, and loot preferences to provide instant, data-driven recommendations for which dungeon to run next. Stop wasting time debating which key to push—let NextKey optimize your IO gains and loot targeting for you.


🚀 What NextKey Does

Smart Key Selection (Main Feature)

When your group has multiple keystones, which one gives the best IO gains? NextKey instantly ranks all available keys by:

  • IO Gain Potential: Shows exactly how much rating each player will earn
  • Player Coverage: Highlights keys that benefit the most group members
  • Loot Targeting: Prioritizes dungeons with items you're farming
  • Smart Sort (Borda Count): Balances all factors for the mathematically optimal choice

Result: Your group agrees on the next key in under 30 seconds instead of minutes of discussion.

M+ Group Organizer

Forming multiple groups for M+ night? The Organizer helps you:

  • Drag-and-drop roster management with role validation
  • Keystone assignment per group for rotation planning
  • Spec preference polling to understand player flexibility
  • Auto-detection of party members with instant roster population

Perfect for guilds running 10-30 people through keys each week.

PUG Helper (For Solo Players)

Applying to Mythic+ PUGs via Group Finder? NextKey assists with:

  • Auto-travel assistance: Teleport window opens when you're accepted to a group
  • Dungeon detection: Automatically identifies which dungeon from group names. No more forgetting what dungeon you applied to! Now you wont have to ask in chat!
  • Leave Group helper: Quick exit after dungeon completion with pop up hearthstone and leave group button.

Loot Targeting System

Stop running dungeons you don't need. Track specific items and see:

  • Featured Season 3 loot for each dungeon
  • Custom item tracking by item ID
  • Run counters: How many times you've run each dungeon (7+ only)
  • Smart sorting: "Max Item Need" mode prioritizes dungeons with your tracked items
  • Currently Bugged: Known Issue: Items arent showing up properly.

📦 Installation

  1. Download: Get the latest release from GitHub Releases (releases coming soon)
  2. Extract: Unzip the NextKey folder
  3. Install: Copy to World of Warcraft\_retail_\Interface\AddOns\
  4. Restart WoW: Log in and type /nk to start

Requirements:

  • World of Warcraft: Retail (The War Within - 11.2.7)
  • RaiderIO Addon: REQUIRED for accurate player scores and dungeon data
  • LibOpenRaid (optional): Enhanced keystone sharing across party/guild

🎮 Quick Start Guide

First Time Setup

  1. Open the addon: /nk
  2. The main window shows all available keystones in your party
  3. Keys are automatically ranked by "Smart Sort" (best overall choice)
  4. Click the Teleport button on any key to get portal assistance

Common Workflows

Premade Group (Guild/Friends):

  1. Form your group
  2. Open NextKey: /nk
  3. Review ranked keys (top = best IO gains)
  4. Leader announces choice: "Let's do [top key]"
  5. Click Teleport → Use portal or hearthstone

PUG Mode (Solo via Group Finder):

  1. Apply to M+ groups via the default Group Finder
  2. Get accepted → NextKey teleport window opens automatically
  3. Use suggested portal/hearthstone to travel
  4. Complete dungeon → "Leave Group" card appears

Loot Farming:

  1. Open a dungeon card (e.g., "Priory of the Sacred Flame")
  2. Click the Loot button
  3. Track items you want (featured items or custom IDs)
  4. Change main window sort to "Max Item Need"
  5. Run the top-ranked dungeons to target your loot

M+ Organizer (10+ People):

  1. Open organizer: /nk organizer
  2. Auto-detect detects party → click to populate roster
  3. Drag players from bench into Tank/Healer/DPS slots
  4. Assign a keystone to each group
  5. Send poll to gather spec preferences (optional)
  6. Form groups in-game and run keys

⚙️ Key Slash Commands

Command Description
/nk "<no arg>" or "show" or "hide" Open main NextKey window (keystone rankings)
/nk "config" or "opt" or "options" Open configuration panel
/nk "organizer" or "org" Open M+ Group Organizer

Debug Mode (for troubleshooting):

  • /nk config|opt|options → Debug System → Enable Debugging
  • Allows granular logging control and performance monitoring

🔧 Configuration Options

Access via /nk config|opt|options:

Teleport Settings:

  • Auto-show teleport window after M+ completion (default: ON)
  • Hearthstone preferences for travel assistance

UI Settings:

  • Window scale and positioning(Coming soon tm*)
  • Theme customization(Coming soon tm*)

Debug System (Advanced):

  • 23 debug categories across 5 logical groups
  • Performance profiling tools
  • Fake player simulation

🏆 What Makes NextKey Different?

vs Manual Coordination

  • Speed: 30 seconds vs minutes
  • Accuracy: Calculated IO gains vs guesswork
  • Coverage: Analyzes entire party, not just individuals

vs Other Addons

  • Focus: Specialized for key selection optimization (not just tracking)
  • Integration: Deep RaiderIO + LibOpenRaid + Blizzard API integration
  • Intelligence: Multi-factor ranking algorithms (not just key level sorting)
  • Group-Centric: Optimizes for the entire party's benefit

📊 Sorting Algorithms Explained

NextKey offers multiple sorting strategies:

Algorithm Best For How It Works
Smart Sort Balanced groups Borda Count algorithm: balances IO gain, player coverage, key level, and loot
Max Group IO Score pushing Maximizes total IO gain for the entire party
Max Player Coverage Fairness Ensures the most players benefit from IO gains
Highest Key Level Challenge seekers Prioritizes the hardest content
Max Item Need Loot farming Ranks dungeons with the most tracked items

Recommended: Use "Smart Sort" for most groups. Switch to "Max Group IO" when everyone needs rating.


🐛 Known Issues & Limitations

Current Status (v0.6.6):

  • ✅ Core keystone ranking stable
  • ✅ Independent Two-Window Architecture (Keystone Selection + Dungeon Overview)
  • ✅ UI Main Refactoring complete (49% code reduction, modular architecture)
  • ✅ M+ Group Organizer fully functional (drag/drop, polls, keystone assignment, persistence)
  • ✅ PUG Helper architecture implemented and hardening in progress
  • ⚠️ Hero-track item tooltips (ilvl display needs tuning)

Limitations:

  • RaiderIO Dependency: Score data requires RaiderIO addon installed
  • Party Member Keystones: Requires LibOpenRaid or manual communication for non-current-player keys

Reporting Bugs:

  1. Enable debug logging: /nk config → Debug System → Enable
  2. Reproduce the issue
  3. Type /console scriptErrors 1 to see Lua errors
  4. Report via GitHub Issues with debug logs

📚 Documentation


📝 Version History

v0.6.6 (November 13, 2025) - LibGroupInSpecT Integration & Enhanced Spec Detection

  • LibGroupInSpecT-1.1 integration for accurate group member specialization detection
  • Improved RaiderIO score calculation using TWW Season 1 formula
  • Modernized WoW API calls throughout the codebase
  • Enhanced debug system to hide DEV/TRACE levels in production

v0.6.3 (November 11, 2025) - M+ Group Organizer Enhancements

  • Auto-save functionality preserves player slot assignments across sessions
  • Visual theming improvements with class-colored survey cards and role icons
  • Enhanced poll data usage and state management
  • Improved fake player detection to prevent data filtering issues

v0.6.0 (November 10, 2025) - Independent Two-Window Architecture

  • Revolutionary two-window system allowing Keystone Selection and Dungeon Overview to operate independently
  • UI Main Refactoring: 49% code reduction (3000+ → 1531 lines) with 13 specialized modules
  • Each window has dedicated toggle button for maximum flexibility

v0.5.26 (November 9, 2025) - Category-Based Debug Profiles

  • Replaced generic debug presets with targeted category-based profiles
  • Streamlined main UI with unified "Refresh Data" button
  • Removed deprecated "Suggest Groups" functionality

v0.5.0 (October 27, 2025) - M+ Group Organizer

  • New drag-and-drop UI for forming M+ breakout groups from raids
  • Comprehensive roster management with role validation

v0.4.0 (October 19, 2025) - Hearthstone Selector

  • New UI for selecting from unlocked hearthstones in teleport system

v0.3.0 (October 13, 2025) - Loot Window

  • New UI window displaying loot information for dungeons
  • Track desired items for specific content

v0.2.3 (November 8, 2025) - PUG Mode Critical Fixes

  • Fixed primary invite lock for first-accepted-wins guarantee
  • Added Season 3 dungeon abbreviation support

v0.2.0 (October 13, 2025) - PUG Mode Initial Release

  • First version of PUG Mode for LFG workflow assistance

v0.1.0 (February 4, 2024) - DungeonCards & Preferences

  • Card-based visual interface for keystones
  • Per-character dungeon preferences

See CHANGELOG.md for full version history.


🙏 Credits

Created by: Sagerobot (with AI assistance) Inspired by: Details! Damage Meter architecture Powered by: RaiderIO data, Ace3 libraries, LibOpenRaid

Special Thanks:

  • RaiderIO team for comprehensive M+ data and addon API
  • RatingCalculator for IO calculation algorithms
  • Details! team for architectural inspiration
  • Ace3 library maintainers
  • AI assistance in development and code analysis

📄 License

NextKey is free and open-source software licensed under the MIT License.


Questions? Feedback? Open an issue on GitHub Issues

About

WoW addon that optimizes M+ group decisions with automatic keystone detection, IO gain calculations, loot tracking, and smart dungeon recommendations. Supports premade groups and PUG workflows.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages