Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[feature] Integration with official LFG Tool #323

Open
juemrami opened this issue Nov 23, 2024 · 8 comments
Open

[feature] Integration with official LFG Tool #323

juemrami opened this issue Nov 23, 2024 · 8 comments
Assignees
Labels
enhancement New feature or request

Comments

@juemrami
Copy link
Collaborator

juemrami commented Nov 23, 2024

With patch 1.15.5, blizzard has added a version of the LFGList UI for classic wow game modes (currently only on SoD/Anniversary Realms).

This addon used to have minor support for the LFG tool back in burning crusade before Vysci forked it for wrath, but it has since been abandoned since blizzard swapped API's/Frames for the LFG Tool sometime in early Wotlk Classic.

It would be nice to re-implement the integration of the LFGList tool, there are however some limitations to the new API that make it really cumbersome to work with.

Most notably, the GetSearchResultInfo APIs result struct contains "protected strings" which are encrypted strings that only the game client can decrypt. Critically, these types of strings are used for the name and comment fields:

  • name - the posting title required when creating a group on the LFG tool (not used in the Era version of the tool)
  • comment - the optional message/comment you can use when creating a group in the LFG tool

Additionally, we can only query the API for one category at a time (categories being Dungeons, Raids, Quests, Custom, PvP).

These 2 limitations mean that we can only ever display (on the bulletin board) the LFGList tool results for a SINGLE category at a time.

@juemrami juemrami added the enhancement New feature or request label Nov 23, 2024
@juemrami
Copy link
Collaborator Author

These 2 limitations mean that we can only ever display (on the bulletin board) the LFGList tool results for a SINGLE category at a time.

So then, i think its a little overkill to have a whole tab to display the results from the LFG Tool.
Id like a way to be able to implement the Tool into the main "Request List" tab.

  • Can use a tooltip on the refresh button to show the current category being searched

@juemrami juemrami self-assigned this Nov 23, 2024
@juemrami
Copy link
Collaborator Author

related issues:

@juemrami juemrami changed the title [feature] Official LFG Tool Integration [feature] Integration with official LFG Tool Nov 23, 2024
@juemrami
Copy link
Collaborator Author

So then, i think its a little overkill to have a whole tab to display the results from the LFG Tool.
Id like a way to be able to implement the Tool into the main "Request List" tab.

I opted not to go this route and keep the LFG tool in its own tab as it was easier for me to implement the new scroll frames without affecting the chat request tab.

Ive added some additional ui elements for making sure users can tell that only 1 category can be selected via a dropdown
WowClassic_chbCNMyhEA

Pull request soon.

@Vysci
Copy link
Owner

Vysci commented Dec 14, 2024

I originally went with the separate tab for couple reasons. One is that classic didn’t have the tool so it was going to be difficult to have wotlk features and classic being separate but in the same tab. Second reason is I think it had to do with keeping it sorted. The lfg tool posts dont really change so most of the time they would always end up at the bottom and basically hidden. Also performance

@Vysci
Copy link
Owner

Vysci commented Dec 14, 2024

Btw there is a max limit on the results the lfg api returns, think it’s 100 if I remember. One other gotcha is the user can change the category in the tool itself and that would change the results, so just need to handle the case and update the tab accordingly

Last thing is the api is a little confusing, if I am remembering correctly it requires a hardware event to fetch any new listings but without it just updates the status of groups it previously returned. Hence why I also added it to update the list when the user opens the addon

@Vysci
Copy link
Owner

Vysci commented Dec 14, 2024

Which integration are you talking in TBC? I don’t recall adding one in TBC but I also forgot that I didn’t upload it until TBC

@juemrami
Copy link
Collaborator Author

Btw there is a max limit on the results the lfg api returns, think it’s 100 if I remember. One other gotcha is the user can change the category in the tool itself and that would change the results, so just need to handle the case and update the tab accordingly

Last thing is the api is a little confusing, if I am remembering correctly it requires a hardware event to fetch any new listings but without it just updates the status of groups it previously returned. Hence why I also added it to update the list when the user opens the addon

yup, i already accounted for pretty much all of this.

@juemrami
Copy link
Collaborator Author

juemrami commented Dec 14, 2024

Which integration are you talking in TBC? I don’t recall adding one in TBC but I also forgot that I didn’t upload it until TBC

TBC had a group finder that was also used in early WOTLK. I was just calling it the TBC group finder. Later in WOTLK classic they updated to the one thats still used up till Cata

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants