WarcraftPets Forum

• A more polished and consistent UI using modern elements like scrollboxes and views, while keeping a familiar look and feel
• The toolbar now includes more buttons, including rarity and leveling stones (that automatically change based on summoned pet and stones you have), a Load Random Pets button, and a pet satchel button to cycle through buttons in more compact views
• Tooltips now have an option for a delayed mouseover reaction speed (Slow, Normal, Fast) like pet cards and ability tooltips
• Throughout the UI, text in the dark blue "rare" color is a little bit brighter to make it easier to read against dark backgrounds
• Lists (pets, teams, targets, queue) can be separately made compact while other lists remain in their normal size

• The standalone window can now be expanded into three panels like the journal, while still collapsible down to two or one panels (or minimized)
• Tabs now align with the chosen anchor (eg. bottomright anchor will move tabs to bottomright)
• The standalone window can now be anchored to center top and center bottom in addition to the four corners

• Pets can be marked and filtered with a "Pet Marker" similar to the target/world markers (skull, cross, star, etc.)
• From the filter menu, pet markers can be renamed to use for whatever purpose you want. Rename star to "Pets to Buy", skull to "Tier 1 Pets", etc.
• A list of filtered pets can be exported from the pet filter menu, optionally as a csv of their stats such as rarity, level and breed
• Pets can now be sorted by three levels of sort instead of one
• The number of teams a pet belongs to is now a sort option
• Compact pet lists are now styled more similarly to the normal-sized pet lists

• Pet cards are now minimizable for a more compact view of a pet's stats and abilities
• More options to "flip" a pet card over, including changing modifier key or requiring a click
• Background art for pet cards now include portrait, icon, pet type or no art in addition to expansion art
• Pets of the 350+ notable targets now display their rarity and stats on the pet card, with abilities adjusted for their stats
• Ability tooltips now have an option for background art of its icon or pet type

• Teams can now contain multiple targets
• Teams are now organized into unlimited, scrollable, collapsable groups with up to 15 of them being shown as team tabs
• Teams and groups can be picked up onto the mouse and reorganized by drag and drop, much like pets in the queue
• In addition to drag and drop, a Team Herder tool from the Teams button allows easily moving many teams to other groups with simple clicks
• Team groups can be colored and teams within will inherit their color
• Leveling preferences and win records properties are now within the team edit dialog and not separate tooltips/dialogs

• Targets can now be assigned to multiple teams, with a priority order of teams you can reorder
• The target list is now in its own tab with targets colored by the expansion they're from
• Random counter pets can be loaded for any of the 350+ known targets to randomly pick high-level pets that are Strong Vs and Tough Vs the target's pets
• When targeting something with more than one team, the target panel will display the topmost team with buttons to cycle through other teams
• When targeting wild pets, the target panel at the top will now display the pet for viewing its pet card and abilities before you battle
• Notable targets with known pets will always display their pets in the target panel in modes that always display the target panel
• Target models in the target panel are now displayed as their better-curated 2D portrait

• A new Default Preferences in addition to Team and Group Preferences allows setting criteria regardless of the team loaded (such as a global max level for the queue)
• The queue now uses a stable sort by default so all things being equal, pets remain in the order they were added/moved during a sort
• Pets in a team can now be sorted to the top of the queue
• The leveling queue can now be exported and imported

• Many options were converted to dropdowns
• Targeting Options has been renamed Interact Options with separate interact behaviors for target or mouseover of saved targets
• (If looking for Auto Load, it's in one of the Interact Options dropdowns)

• Toolbar Option 'Move Toolbar To Bottom' was removed to make layouts easier to maintain
• Standalone Window Option 'Combine Pets And Queue' was removed to make layouts easier to maintain, and it's no longer needed with 3-panel option
• (If anything else is missing let me know. It may have been an oversight or moved elsewhere. The above two are the only two options intentionally removed that I can think of.)

• Collection summary/statistics
• Sending/receiving teams in-game to/from other Rematch users
• Dealing with wrapped pets
• Creating a script to pull out localization strings

• Before installing this beta, I strongly recommend backing up your WTF folder (or the Rematch.lua within, described below) in case anything happens, so you don't lose your teams and settings to a bug in the beta.
• Your queue, teams and many (not all) settings will seamlessly convert from Rematch 4 to 5 when you log in, but many settings will not carry over. Notably: Auto Load and related options will not automatically carry over. (These are in Interact Options now and have changed a lot.)
• Some team names may be slightly renamed to add a number after them to keep them unique. If you had a team named Squirt with a target and another team named Squirt without a target, then the latter will be renamed to Squirt (2) (or an incrementing number if 2 already used). The team with the target will always be the "primary" team on an upgrade from 4.x to 5.x. In Rematch 5, teams are uniquely named regardless of whether they have targets or not.
• While old Backup strings are supported, they contain no information about the tabs other than their names. The new backup export includes information about groups (icon, color, sort mode, whether it's shown as a tab). If you import this new backup into Rematch 4, it will not recognize the icons and such.
• To do a large scale reorganization of your teams into new groups, I highly recommend using the Team Herder from the Teams button at the top of the Teams tab rather than dragging individual teams up/down the list. As you'll notice, when you pick up a team onto the mouse, it collapses other lists to choose where to drop it. (For drag and drop, if you prefer, search for the option "Require Click To Drag Teams". This may become default, I'm not sure yet.)

• Is there anything that doesn't make sense? The addon should be usable without a manual. More advanced features should be evident when they're discovered.
• Is there a bug? If so please describe the steps to reproduce it. I can realistically only fix bugs I can reproduce.
• Is there any behavior that was unexpected? Let me know what behavior you expected vs what happened.
• Is there a feature/option of Rematch 4 that you're not seeing? There are over 100 options to this addon and some were consolidated and some added. Some were probably missed. Some were dropped intentionally but feel free to ask.
• Is there anything else that would be useful within the scope of this addon? The scope is a journal alternative for managing pets and teams.

1. Exit the game entirely.
2. Make a backup of your existing WTF folder (or specifically, World of Warcraft\_retail_\WTF\Account\%AccountName%\SavedVariables\Rematch.lua).
3. Delete the Rematch folder from your Interface\Addons folder (specifically, World of Warcraft\_retail_\Interface\AddOns\Rematch).
4. Extract the above download to Interface\Addons (or ontop of existing one if you didn't delete).
5. Log into the game.

Caliban wrote: ↑

July 17th, 2023, 12:22 am

If I download this Beta, will I keep all my old lists and scripts (you made a script in the past for me which I'm very happy with and don't want to lose).

Yes, you will keep your old scripts,

• please don't use https://wow.tools/casc/listfile/download/csv/unverified for allIcons, use https://github.com/wowdev/wow-listfile/raw/master/community-listfile.csv or https://github.com/wowdev/wow-listfile/raw/master/community-listfile-withcapitals.csv
• clicking a "has been added to your pet journal" tooltip from chat does open rematch, but does not filter to pet.
• the LibDataBroker launcher has vanished

• allow for importing team and script at the same time (very requested by xufu users) and also
• properly clean up scripts when teams are deleted (currently we weirdly hook the delete-team menu item, but that isn't the only way to delete teams (i.e. delete group is missed).
• We also hook some renaming cases (by hooking the dialog accept handlers, ewww)

On integrating the export/import strings, I can possibly set custom fields but I'd need to add a delimiter. Maybe the :Ustuff<|u> and register a callback for something to handle stuff after the team is created, with a teamID.

• tell Rematch I am a plugin and want to save team data with the tag "pbs" and use the icon "blerb.blp" to mark a team having such data in the list
• tell Rematch that team list entries with our data should call `edit_blob(team-id)` on clicking the badge
• tell Rematch that the team menu shall contain "new script" for not having our data, "edit script" and "delete script" for existing data (the only possible actions for any plugin, these are just localisation strings)
• check `Rematch.loadedTeam:pluginData('pbs')` at random times
• call `Rematch.loadedTeam:{set,delete}PluginData('pbs', blob)` at random times

Schlumpf wrote: ↑

July 18th, 2023, 4:40 pm

How likely are you to provide such an API? Do you want to toy with it?

Gello wrote: ↑

July 18th, 2023, 7:12 pm

Schlumpf wrote: ↑

July 18th, 2023, 4:40 pm

How likely are you to provide such an API? Do you want to toy with it?

Import/export strings, needs more research, can't say yet.

Including outside data within a rematch.savedTeam[teamID] is...already possible, but it makes me a little nervous that a third-party addon would store data in there. I will have to think about this more.

Gello wrote: ↑

July 18th, 2023, 7:12 pm

I don't understand "random times" for the other bits. I really really really don't want to get involved in supporting other addons to the extent that I need to include them in my regression testing. My experience with ElvUI skin support was so intensely awful that I will forever...I'm just going to stop there before I start swearing lol. So I will create events for callbacks and stuff, but the vague interactions will be up to you.

• Collection summary added which includes a team battle summary tab for all recorded team battles
• Fix for unique pets count in collection button at topleft of window
• Updated handling of target names while waiting for them to be cached
• Searches are now "accent-insensitive" on French, German, Italian, Spanish, Mexican, Portuguese, and Brazilian clients
• Favorite filters now automatically import from Rematch 4
• Added many ways to extend this addon from third-party addons, including events, badges and menus. See docs/extending.txt
• Added LDB launcher

Rematch uses an event dispatch system that outside addons can use:

    Event                   Argument       When
    REMATCH_UI_CONFIGURE    (none)         After the main Rematch window has changed configuration (minimized, panel changes, etc) or shows
    REMATCH_UI_RESIZE       (none)         After the main Rematch window has resized
    REMATCH_UI_UPDATE       (none)         After the main Rematch window has finished a global update of all shown panels
    REMATCH_TEAM_LOADED     teamID         A team is loaded or unloaded (can be nil for a team unloaded)
    REMATCH_TEAM_CREATED    teamID         After a new teamID is created
    REMATCH_TEAM_DELETED    teamID         After a teamID is deleted
    REMATCH_TEAM_UPDATED    teamID         After a teamID is changed (can be due to being overwritten by another team)
    REMATCH_TEAMS_CHANGED   (none)         After any teams changed (happens after other REMATCH_TEAM events and before UI is updated)
    REMATCH_TEAMS_READY     (none)         After login when teams are settled
    REMATCH_TEAMS_WIPED     (none)         After all teams are wiped by /rematch delete all teams

To register for these events:

    Rematch.events:Register(frame,"EVENT_NAME",callbackFunction)

Example:

    local frame = CreateFrame("Frame") -- your frame, anything really
    Rematch.events:Register(frame,"REMATCH_TEAM_LOADED",function(self,teamID)
        local team = Rematch.savedTeams[teamID]
        if team then
            print("Team",team.name,"just loaded")
        end
    end)

Badges are small icons on the right of list buttons, to show if a pet is leveling, if a team has preferences, etc.

At the moment, the Notes button is the only badge that can be clicked to do something. Support for custom clickable
badges may come in the future.

To add badge support:

    Rematch.badges:RegisterBadge(list,badge,icon,iconCoords,callback)

With these arguments:
    list        Either "pets", "teams" or "targets" to choose which list to add to
    badge       An arbitrary unique name for the badge
    icon        A filepath/fileID for the icon to use with the badge
    iconCoords  Optional texcoords for the icon an ordered table {left,right,top,bottom} can be nil
    callback    A function that takes a petID, teamID or targetID and returns true if badge should show

This example creates a "cats" badge that puts a badge on pets with 'Cat' in their species name:

    -- callback function to return whether the badge should be shown
    local function isCat(petID)
        local petInfo = Rematch.petInfo:Fetch(petID)
        if petInfo.speciesName and petInfo.speciesName:match("Cat") then
            return true
        end
    end

    -- register "cats" badge
    Rematch.badges:RegisterBadge("pets","cats","Interface\\Icons\\Ability_Druid_CatForm",{0.075,0.925,0.075,0.925},isCat)
    -- update Rematch UI if it's on screen (if it's not on screen it will be updated when it's shown) to show badges
    if Rematch.frame:IsVisible() then
        Rematch.frame:Update()
    end

This example adds a black tabby cat badge to every team that has a black tabby cat:

    -- callback function to return whether teamID has a black tabby cat
    local function hasBlackTabby(teamID)
        for _,petID in ipairs(Rematch.savedTeams[teamID].pets) do
            local petInfo = Rematch.petInfo:Fetch(petID)
            if petInfo.speciesID==42 then
                return true
            end
        end
    end

    -- register "tabby" badge
    Rematch.badges:RegisterBadge("teams","tabby","Interface\\Icons\\INV_Pet_Cats_BlackTabbyCat",{0.075,0.925,0.075,0.925},hasBlackTabby)
    -- update Rematch UI if it's on screen (if it's not on screen it will be updated when it's shown) to show badges
    if Rematch.frame:IsVisible() then
        Rematch.frame:Update()
    end

Note: Rematch.frame:Update() is only needed when the Rematch UI is on screen and something changes that should update badges.
When the addon is summoned or various other things (pets learned, teams saved, etc.) the UI will update badges automatically.

Menus are built from an ordered list of subtables that define each menu item. For instance this is TeamMenu from menus/teamMenu.lua:

    -- menu when you right-click a team in the team list
    local teamMenu = {
        {title=tm.GetTeamName},
        {text=L["Unload Team"], hidden=tm.IsTeamNotLoaded, func=tm.UnloadTeam},
        {text=L["Edit Team"], func=tm.EditTeam},
        {text=L["Set Notes"], func=tm.SetNotes},
        {text=L["Move Team"], func=tm.MoveTeam},
        {text=L["Load Saved Target"], hidden=tm.NoSavedTarget, func=tm.LoadSavedTarget },
        {text=tm.SetOrRemoveFavoriteText, func=tm.SetOrRemoveFavorite},
        {text=L["Share"], subMenu="ShareTeamMenu"},
        {text=L["Delete Team"], func=tm.DeleteTeam},
        {text=CANCEL},
    }
    rematch.menus:Register("TeamMenu",teamMenu)

It has a name "TeamMenu" that's used to show/reference the menu, and each item has properties, many of which can be a literal value
or a function that returns it's value when the menu is shown.

Note that even the text property can be a function. The function tm.SetOrRemoveFavoriteText is:

    function rematch.teamMenu:SetOrRemoveFavoriteText(teamID)
        local team = teamID and rematch.savedTeams[teamID]
        return (team and team.favorite) and L["Remove Favorite"] or L["Set Favorite"]
    end

The argments passed to these functions are dependent on the menu's context. For team menus they'll pass a teamID,
for pet menus they'll pass a petID, etc.

To add to one of these menus, use:

    Rematch.menus:AddToMenu(menuName,menuItem,afterText)

Where menuName is the name of the menu ("TeamMenu" in example above), menuItem is a single menu item table, and afterText
is the text property the new menu item should be placed after. If afterText is nil, then it will be placed at the start of
the menu. If placing it aftter a text that's a function (like SetOrRemoveFavoriteText above) then use the function as
the afterText.

In the function called from the func property of the menuItem, the first argument is the menuItem itself, and the second
(or further) is the context-specific subject.

For instance:

    local function printTeamID(self,teamID)
    print("This is",teamID,"var is",self.var)
    end

    local menuItem = {text="Print TeamID", var=123, func=printTeamID}

    Rematch.menus:AddToMenu("TeamMenu",menuItem)

Note: While many properties can be a literal or a function, custom properties of a menuItem (like var above) are
treated as a literal always.

Justgiz wrote: ↑

July 30th, 2023, 8:35 pm

I'm having a bit of an issue when trying this beta (5.0.0-beta-07) my settings/teams/queue are not getting converted

Under "Standalone Window Options" the "Anchor To" setting: I see that it affects the direction when the window resizes with minimizing, and folding in and out the pets list, but it also moves the tabs (team,target,queue,options). I don' think thats intended, right?

Is there a new setting for scroll speed?

Keybinding are missing. I.E. Opening the current team's notes.

With the "Preferred Window" set to maximized, and hitting escape twice to minimize then close the window, the window will open in a minimized state. Actually that setting doesn't seem to have any effect. Setting it to Journal does not change the action. (used the keybind, and minimap button)

I can also confirm what Schlumpf said earlier, about clicking the "You collected" popup opens Rematch, but does not filter or scroll to the newly added pet.

Gello wrote: ↑

August 3rd, 2023, 4:46 am

The panel tabs intentionally move to the corner chosen by the anchor so the window maximizes/minimizes outward from the tabs and the tabs stay in the same place. To me at least, it seemed frustrating to maximize the window and then the tab that maximized it is now across the screen, so to minimize it you have to move over to the tab and back and forth. (If you have 'Don't Minimize With Panel Tabs' checked, uncheck it and the reason should be easier to see.)

Gello wrote: ↑

August 3rd, 2023, 4:46 am

I'll add notes bind back. I intentionally dropped binds for pets, teams and queue since they seemed a little superfluous. Let me know if the latter should return.

Gello wrote: ↑

August 3rd, 2023, 4:46 am

I'll work on this. This option may disappear and when needed use the last-used-window. Its original intent was for the times the window is summoned in reaction to an event (targeting something with a team when options are set to show it etc). I really didn't like the idea of the whole journal covering most of the screen when you target something.

Gello wrote: ↑

August 3rd, 2023, 4:46 am

This will be fixed but maybe not in the update tomorrow. I misunderstood and thought it was the floating battle pet tooltip that says to open in journal and hadn't been able to reproduce it. I just realized from your popup reference that this is the alert frame and not the floating battle pet tooltip. I forgot clicking that looked for the pet in the journal too. This is fixable.

Gello wrote: ↑

August 3rd, 2023, 4:46 am

This is using a newer scrollbox that has a lot of benefits but lost some control over details like scrolling speed. I can do some more digging later.

/run Rematch.petsPanel.List.ScrollBox.wheelPanScalar = 1

• The only Notes option enabled is "Show Notes When Teams Load"
• Load a Target that has a team, either by targeting a trainer or selecting them from targets tab
• Click the load button 3 times.