Docs

Using Phoenix UI

Getting started

Phoenix UI is a set of addons: the core Phoenix_UI folder and one folder per module (Phoenix_UI_UnitFrames, Phoenix_UI_Vault, and so on). Put all of them in World of Warcraft/_retail_/Interface/AddOns and log in.

On the first login a five-step setup opens: language, UI scale (with a pixel-perfect suggestion for your screen), a role preset (Healer, Tank, Damage, PvP or Minimal), a layout preset and a look. Apply saves your choices and reloads once. You can skip it and run it later with /pui setup.

Every module starts switched off until you or a preset turns it on, and a module that is off does no work at all.

Options

  • /pui options opens the options window. Type a word after it to search, for example /pui options tooltip.
  • Simple shows the main switches; Advanced shows every setting of every module.
  • Every change applies at once. Nothing needs a reload except the setup wizard and uninstall.
  • /pui list, /pui get <key> and /pui set <key> <value> do the same from the chat box.

Studio (moving frames)

/pui studio opens Studio, the layout editor. Drag any Phoenix frame, use the arrow keys to nudge it, and close Studio to keep the positions. Studio does not open in combat. Positions are stored in your profile.

Commands

  • /pui help lists every command.
  • /pui setup opens the first-install wizard again; /pui tour shows the three-card tour.
  • /pui cdm export and /pui cdm import <string> share Cooldown Manager settings as a !PUI_CDM string.
  • /pui copychat opens recent chat lines in a box you can copy from (Chat module).
  • /pui rl reloads the UI and /pui cd <seconds> starts a pull countdown (both are Flow switches, off until you turn them on).
  • /pui oracle (or Ctrl+K once Oracle is on) opens the command palette: type to find settings, game panels, macros, mounts, profiles and commands. Panels, macros and mounts are hidden in combat.
  • /pui embers list | report party | export | pin 1 works with the Embers meter's saved fights. Reports are refused in combat and wherever the game locks chat.
  • /pui ascent note <text> attaches a route note to the current dungeon; /pui ascent best lists your best runs.
  • /pui wisdom weight CritRating 1.2, /pui wisdom import <scale string> and /pui wisdom export manage gear-score weights; with no weights, Wisdom compares item level.
  • /pui loadout save raid remembers your spec, talents and gear set for raids; /pui loadout check and /pui loadout apply compare and switch.
  • /pui loc shows how much of Phoenix is translated into your language; /pui packs lists the data packs and their dates.
  • /pui sentinel opens the diagnostics panel (see Sentinel).
  • /pui test runs the built-in self test.
  • /pui uninstall confirm puts back the game settings Phoenix changed (UI scale, camera distance) and disables every Phoenix addon.

Media library

Install the optional Phoenix_UI_Media folder to get a wide set of styles in the Options pickers:

  • 43 fonts, including Arabic (Noto Sans Arabic, Cairo, Tajawal), Chinese, Japanese and Korean (Noto Sans SC, JP, KR) and Cyrillic families. Font pickers show each font in its own face.
  • 22 bar textures, 12 backgrounds, 6 borders and 12 glows. Bar pickers show a preview strip.
  • 84 icons and 145 sounds. Alert sound in Theme replaces the reminder, Group Finder and quest-complete sounds; hover a sound to hear it.

If another addon loads LibSharedMedia, Phoenix fonts, bars, backgrounds, borders and sounds also appear in that addon's pickers as "Phoenix: name" (switch off with Share with other addons).

Credits: fonts from Google Fonts (SIL Open Font License); sounds by Kenney (CC0); icons from game-icons.net by Lorc, Delapouite and others (CC BY 3.0). The full per-file list is in Phoenix_UI_Media/LICENSES.md.

Import and export

Embers exports a saved fight as a !PUI_EMB1 string and Wisdom reads and writes Pawn-style scale strings. The Cooldown Manager has its own share string, !PUI_CDM. Export with /pui cdm export, paste the string to a friend, and they import it with /pui cdm import. Only Cooldown Manager settings are read from the string; anything else in it is ignored.

FAQ

Does Phoenix work in Mythic+, raids and PvP? Yes. Phoenix never reads values the game hides in restricted content; it passes them straight to the game's own widgets.

Does a module I do not use slow the game down? No. A module that is switched off registers no events and runs no timers.

Can I go back to the default interface? Turn modules off one by one in the options, or use /pui uninstall confirm to disable every Phoenix addon at once.