# Pet HQ
A pet battle team manager built for PvP team building. The core is new code. The analysis, Team Builder and in-battle features are Ben's work, carried over from his combos build.
## Getting started
1. Copy the `PetHQ` folder into `World of Warcraft\_retail_\Interface\AddOns\`.
2. **Move your Rematch data over (one time).** Keep Rematch enabled for one session alongside Pet HQ and log in. Pet HQ offers to import your data after a few seconds. You can also start it yourself with `/phq import` or Options > Data & About.
- It copies your teams, groups, chosen abilities, win records, team notes, favourites, pet notes, pet tags and tag names.
- It reads them at runtime through Rematch's public `Rematch` table and saved variables. None of Rematch's code is used or shipped.
- Running it again skips teams it has already imported.
- Slots that held leveling, random or ignored pets are left empty.
3. Disable or delete Rematch.
Open Pet HQ with `/phq`, the minimap button, the addon compartment or a key binding (Key Bindings > AddOns).
## Replacing the Pet Journal
Pet HQ takes over the game's Pet Journal. Open it the usual way (the Pets key binding, or the Pet tab of the Collections journal) and Pet HQ opens over the journal, straight into the Team Builder with the team list beside it. The journal is hidden completely except its tab row, which is scaled to sit right under Pet HQ, so the Mounts, Toy Box, Heirlooms, Appearances and other tabs stay clickable.
- Closing Pet HQ closes the journal, and closing the journal closes Pet HQ.
- Click any other journal tab to leave Pet HQ; click the Pet Journal tab to come back. The **Collections** button in Pet HQ's toolbar is a shortcut to the Mounts tab.
- To see Blizzard's own pet page for a visit, hold **Alt** while opening the Pet tab, Shift-click Collections, or type `/phq journal`.
- Options > Window: **Replace The Pet Journal** turns the takeover off. **Open Team Builder With It** controls whether it opens in the Team Builder or on the pet list.
- While it sits over the journal, Pet HQ can't be dragged. Its saved position comes back when it's opened by itself.
## The main window
Pet HQ is one window with two layouts. **Manage** shows your three slots and the pet list on the left. **Build** (the Build button under the team list, `/phq build`, or right-clicking the minimap button) swaps the left side for the Team Builder, and the team list stays on the right, so you can load, compare and save teams without a second window. The X on the Team Builder returns to the pet list; the window's own X closes Pet HQ. Your picks are kept if you close and reopen the window, and dropped when you leave Build.
- **Toolbar.** Revive Battle Pets, Battle Pet Bandage, Theorycraft, Head to Head, Battle Hub and Find Battle / Leave Queue. Hovering Find Battle lists the pets you'd queue with.
- **Left side: your three slots.**
- Drag a pet onto a slot to load it.
- Click an ability to switch it. Right-click or double-click an ability to find pets that have it.
- Right-click a pet for its menu.
- **Left side: the pet list.**
- Search box, Filter menu, and the Type / Strong Vs / Tough Vs bar. On the bar, shift-click selects every type except that one and alt-click selects only that one.
- Rows show breed, win rate, pet tags and type-chain links.
- **Right side: teams.**
- At the top: the loaded team and its record. Hold Alt over it to see totals across all teams.
- Groups: click to collapse, right-click to rename, sort, move or delete.
- Teams: click to load, right-click for the menu.
- Hovering a team shows its win record (plus nemeses, with Pet Battle Log Keeper) and the coverage chart.
- Bottom buttons: **Save**, **Save As** (into "Current Testing"), **Build** (right-click for Battle Hub) and **Reset Queue**.
- **Right side: options.** Every setting, grouped by section, plus the Radar Chart & Stats Guide.
### Searches
- **Pet search:** names, species, notes, ability names and ability text. Also takes stat and word terms:
- `level=21-23`, `speed>300`, `h>1500`, `p<280`, `wr>=60`, `td=3`
- `breed=hp`, `rarity=rare`, `type=aquatic`
- `"Quoted"` text matches a whole pet name.
- **Team search:** team names, pet names and notes. Also takes:
- `coverage>5`, `blue=3`, `green>4`, `total>12`
- `dmg:elemental`, `pet:humanoid`
- `strongvs:dragonkin`, `weakvs:magic`
- `pattern:meta`, `pattern:safeswap` and the other patterns
- **Teams > Filter Teams** holds the same filters as menus.
### Right-click menus
- **Pet** (list, slots, pet card): Summon/Dismiss, Pet Tags, Set Notes, Find Similar, **Find Moveset** (pets that can use the same three abilities), Find Teams, Rename, Set/Remove Favorite, **Hide/Show Pet** (hidden pets leave the lists; Filter > Other > Hidden Pets shows only them), Link To Chat, Release and Put In Cage. Pet HQ also adds Add To Build Team, Team Combos and Put In Slot.
- **Ability** (right-click an ability on the pet card or a slot): Find Pets With This Ability, Link To Chat.
- **Team:** Load, Unload, Edit, Set Notes, Improve, Compare, Favorite, Move To Group, Reset Win Record and Delete.
- **Group:** Sort, Move, Rename, New Group, Delete Teams and Delete Group.
- Shift-click a pet or ability anywhere to put its link in your chat box.
### Pet card
Hover a pet to see its card. Click the pet to pin the card open.
- Hover a pet to open its card; click it to lock it open (it stays until you press the X or Escape). Clicking anything on the card also locks it. Drag it to move it.
- Click the pet's icon to favourite it. Click the family icon in the corner to **find similar pets** (same family, hitting the same families hard).
- **Collected (n/3)** lists your copies with level and breed, and **Possible Breeds** the breeds the species comes in. Click either to list just that pet. **Find pets with this moveset** lists every pet that can use the same three abilities.
- Click an ability to search for pets that have it. Right-click it for its menu; shift-click links it to chat.
- Click a battle pet link in chat to open its card (Options > Pet Card > Pet Card For Chat Links). Your own copy of the pet is shown if you have it.
- The card shows the pet's picture over a background made for its family (`textures/cardbg-top-N.tga` and `cardbg-bot-N.tga`, N = the pet type number). The pictures start at 50% brightness so the text stays readable (Options > Pet Card > Card Background Brightness); the family emblem sits below the family button in the top right. Pet Card Family Theme turns the backgrounds off.
- **Drag the pet's picture** to turn it, **scroll** over it to zoom, **right-click** it to reset the view. The pet sits a little left of centre so the family emblem has room.
- **Drag the card** from anywhere on it to move it. It stays pinned where you drop it, and opens there from then on. `/phq reset` puts it back.
- Coverage rows: win rate, Power Score, type diversity, self coverage, type chain, **Team Combos** and **Coverage Partners**. The last two can be clicked.
### Groups: order, colour, icon and tabs
- **Drag a group header** onto another header to put it before that group, or onto the empty space under the list to put it last.
- **Right-click a group > Color & Icon** for colour presets, a custom colour picker, an icon picker (pet family icons and more, or type any icon name or file number) and Reset Look. Headers show the icon and colour, and each team gets a thin strip in its group's colour.
- **Group Tabs** (Teams dropdown, or Options): a strip of small tabs beside the list. Click one to jump to its group, drag to reorder, right-click for the group menu.
- Group colour and icon travel in exported strings, in the Rematch header fields.
### Building teams by dragging
Pets from the list, **Combos** and **Gems > Untapped** can all be dragged into a team slot (clicking still works). A dragged Combos pet arrives on the abilities it was scored with.
### Favorites, merging, stats card
- Teams you mark as favorites are also listed in a **Favorite Teams** section at the top of the team list (and as a star tab on the tab strip).
- **Right-click a group > Merge Into...** moves all its teams into another group and removes it.
- **Stats card:** the "Stats card" tick box along the bottom of the Pet HQ window and of the game's own pet page flips a card up over the bottom of the window: your loaded team's record, each pet's logged results and weak link, and your totals. Off by default; untick to flip it away.
- **Reset Queue** now sits under Find Battle at the top right. The pet tag bar is 10% smaller and runs last-to-first.
### Sharing teams (compatible with Rematch)
Teams and groups copy out as plain text in the same format Rematch uses, so strings go both ways between the two addons and between players on either.
- **Export:** a team's right-click menu > Share > Export Team (or Plain Text for a readable version to post in Discord); a group's menu > Export Group; Teams dropdown > Export All Teams. Also `/phq export`.
- **Import:** Teams dropdown or a group's menu > Import Teams, or `/phq paste`. Paste the text and the dialog tells you how many groups and teams it found and how many use a name you already have. Teams with no group go into the group you pick; same-named teams become copies unless you tick "Replace teams with the same name".
- A string carries each pet's species, breed and chosen abilities, plus team notes and group names. Importing picks your best copy of each species (the right breed if you have it) and keeps a placeholder for species you don't own. Leveling, random and ignored slots, PvE targets and leveling preferences are skipped. Win records aren't part of a string.
- Sending teams directly to another player in game isn't included, only copying text.
### Your results with a pet
With Pet Battle Log Keeper, a pet's card shows your games with that species (record, win rate, last 50), the damage it deals and takes per game, how often it falls and falls first, and how often it leads. A saved team's hover tooltip names its weak link, the pet that goes down first in at least 40% of that team's logged games.
### Win records
When a battle ends with a saved team loaded, the result is added to that team's record:
- It's only recorded if the pets that fought are the team's pets.
- Draws count as half a win in every win rate.
- Forfeits are handled.
- By default only PvP battles are recorded. You can change this in Options > Teams & Win Records.
The window size is Options > Window > Window Scale (108% by default).
## Slash commands
| Command | Opens or does |
|---|---|
| `/phq` | Opens or closes the window |
| `/phq build` | Team Builder |
| `/phq compare` | Compare Teams |
| `/phq h2h` | Head to Head |
| `/phq meta` | Theorycraft / Meta Scan |
| `/phq hub` | Battle Hub |
| `/phq scout` | Turns the Battle Scout card on or off |
| `/phq logcheck` | Shows what the battle logs are feeding into the numbers |
| `/phq options` | Options |
| `/phq journal` | Shows Blizzard's own pet journal page until the journal closes |
| `/phq paste` | Imports teams from a pasted team string |
| `/phq export` | Copies every team and group as text |
| `/phq import` | Imports from Rematch |
| `/phq reset` | Moves the window back to the centre of the screen |
## What came from where
- **New for Pet HQ** (`Core/`, `Data/Breeds|Pets|Roster|Teams|Records|Loadout|PetFilter|Tags|Import`, `UI/`): the addon frame, the event bus, settings, pet records, the roster, breed detection, teams and groups, win recording, team loading, the pet filter and sort engine, the main window, pet card, menus, save dialog, options, slots, list widgets and the minimap button.
- **Ben's combos code, rewired onto the new core:**
- `Analysis/`: coverage chart, ability damage model, sims, battle logs, Team Combos, gems, meta scan, team patterns
- `Windows/`: Team Builder, Compare Teams, Battle Hub, Head to Head, Meta Scan, pet picker
- `Battle/`: Battle Scout, Loss Review, Matchup Grid, Enemy Ability Bar
- `Data/`: AbilityInfo, AbilityEffects, SpeciesBase, SynergyInfo, TeamFilters
- `UI/TypeBar`, `UI/TeamFilterMenu`
- `textures/`
- **Rematch features that were dropped** (PvE or Rematch-specific): the NPC target database and auto-load prompts, the leveling queue (and the leveling/random/ignore slot items in the pet menu), sending teams to other players in game, Pet Herder, random teams, team preferences and the journal-integrated mode. In the Gems "Level Up" tab, clicking a pet now opens its pet card instead of queueing it.
## Saved data
- `PetHQSettings`: options.
- `PetHQData`: teams, groups, pet notes and pet tags.
- `PetHQMetaCache`: the Meta Scan cache.
## Search and sort
The pet search and filters start empty after a login or reload. The sort order is never reset by that, or by Reset: it only changes when you change it (the combo-partner list borrows it while it is showing and then puts yours back).
PetHQ not final Team
