Description
ZaeUI_DungeonNotes
Take personal notes for each dungeon and raid — displayed on instance entry via a discreet notification, editable from a floating window, organised per character, and shareable via text profiles.
Compatible with World of Warcraft Midnight (12.0.0+). 100% local: no network traffic, no cross-player sync, no addon messaging — works everywhere including Mythic+, Arenas and active raid encounters where many other addons are restricted by Blizzard's new combat API rules.
Features
- Per-dungeon notes — one free-form multi-line note per instance, indexed by WoW
instanceMapID - Per-character storage — each character maintains its own notes via
SavedVariablesPerCharacter - Instance-entry notification — a floating button appears briefly when you enter a dungeon or raid; click to open the editor
- Instance browser — list every dungeon and raid you have already visited and open any of their notes from the options panel, without needing to enter the instance
- Shareable profiles — export all your notes as a text string, import them on another character or share them with friends
- Customisable notifications — toggle on/off, adjust duration (5–60s), enable for dungeons and raids independently
- Safe profile parser — hand-written regex scanner, no
loadstring, 50 KB hard limit on imports - ZaeUI minimap button integration — an "Open Dungeon Notes" entry appears in the shared ZaeUI right-click context menu
- Works everywhere — no dependency on Blizzard APIs restricted in competitive instanced content; every feature operates entirely on your client
Display Modes
Floating Editor Window
A draggable, resizable window with a multi-line text area, Save button and Clear-note button. Window position and size are persisted per character.
Instance-Entry Notification
On entering a dungeon or raid, a small button appears near the top of the screen for a few seconds and then fades out. Clicking it opens the editor on the current instance. The notification can be suppressed entirely or configured to appear even for instances without existing notes.
Instance Browser
A scrollable list of every dungeon and raid you have visited, grouped by type. Each row shows the instance name and a note status indicator (has note / empty). Click any row to open its notes directly — no need to zone into the dungeon.
Slash Commands
| Command | Description |
|---|---|
/zdn |
Open the note window for the current instance |
/zdn browse |
Browse and open notes for any visited dungeon or raid |
/zdn options |
Open the options panel |
/zdn export |
Export your profile to a shareable string |
/zdn import |
Import a profile string |
/zdn reset |
Delete all notes (with confirmation) |
/zdn help |
Show all commands |
How It Works
- On entering a dungeon or raid (
PLAYER_ENTERING_WORLD), the addon resolves theinstanceMapIDviaGetInstanceInfo()and catalogues the instance name in a local list. - If a note already exists for that
mapID— or if "notify empty instances" is enabled — a discreet notification button appears and fades out afternotificationDurationseconds. - Clicking the button opens the editor with the existing note pre-filled. Typing marks the buffer dirty; clicking Save persists the note to
SavedVariables. - Notes can be browsed from the options panel via the "Browse all dungeons..." button, which lists every instance ever visited along with its note status.
- Profiles can be exported to a plain-text string (
ZAEDN1:{[mapID]="escaped text",...}) and imported on any other character or shared with a friend.
Shareable Profile Format
Profiles use a strict, whitelisted format prefixed with ZAEDN1:. Example:
ZAEDN1:{[2660]="kick prio magie on trash 3",[2661]="boss 2: dodge left"}
The import parser is a hand-written regex-based scanner — no loadstring, no arbitrary code execution — and rejects any input that is malformed or larger than 50 KB.
SavedVariables
Stored per-character in ZaeUI_DungeonNotesCharDB:
notes—[mapID] = "text"knownInstances— catalogue of visited instances with their namesshowNotification,notificationDuration,notifyEmptyInstancesenableParty,enableRaidswindowPoint,windowWidth,windowHeight— editor persistenceshowLoadMessage
Requirements
- ZaeUI_Shared — required dependency (install from CurseForge)


