Better Game Menu Compatibility

[SoulSilverJD]

This is a list of mods that interact with the game menu and their compatibility with Better Game Menu:

No Progress / Closed Source

• Crafting Collections Page (Thread) - Closed source, contacted dev
• Fishing Assistant 2 - checks for GameMenu for the purpose of right-clicking on the InventoryPage trash can
• World Maps everywhere - Not working, have reached out to dev since closed source

PR Available

• Ridgeside Village (PR) - Fixed in PR, waiting on devs
• UI Info Suite 2 (PR) - Fixed in PR, waiting on dev

PR Accepted (Not Yet Live)

• Map Event Markers (PR) - Fixed in PR, merged

Fix Live

• BarleyZP's Allergies (PR) - Fixed in PR, live
• Bigger Backpack - Fixed in Better Game Menu preview 3
• Billboard Anywhere (PR) - Fixed in PR, live
• Chests Anywhere (PR) - Fixed in PR, live
• Debug Mode (PR) - Fixed in PR, live
• Ferngill Simple Economy (PR) - Fixed in PR, live
• Generic Mod Config Menu (PR) - Fixed in PR, live
• Item Bags (PR) - Fixed in PR, live
• Informant (PR) - Fixed by someone else, live
• Lookup Anything (PR) - Fixed in PR, live
• NPC Map Locations (PR) - Fixed in PR, live
• Pack Collection - Fixed in Better Game Menu preview 3
• Searchable Collections - Fixed by dev
• Social Page Order Redux (PR) - Fixed in PR, live
• SpaceCore (PR) - Fixed in PR, live
• Special Power Utilities (PR) - Fixed in PR, fix is live
• Star Control - Fixed in Better Game Menu preview 4
• Vanilla Plus Professions (PR) - Fixed in PR, live
• Wear More Rings - Fixed in Better Game Menu preview 3

[KhloeLeclair]

[Removed the unofficial updates of GMCM and SpaceCore as they are no longer necessary.]

[besworks]

I put together a summary of the patches you apply so that mod authors have a quick reference of places to look for potential compatibility problems. I think I've covered everything thoroughly and accurately. Let me know if I missed anything important.

Summary of Patches

• Game1.UpdateControlInput and Game1.CheckGamepadMode are transpiled to create BetterGameMenuImpl instead of GameMenu for direct menu entry paths

• IClickableMenu.populateClickableComponentList is transpiled to enable custom tabs

• IClickableMenu.exitThisMenu is transpiled to allow closing BetterGameMenuImpl instances

• SocialPage.receiveLeftClick is transpiled to assign a new exitFunction that returns to the active BetterGameMenuImpl

• MapPage.receiveLeftClick is transpiled to support returning to active BetterGameMenuImpl

• GameLocation.openCraftingMenu is prefix-patched to create BetterGameMenuImpl

• JunimoNoteMenu.cleanupBeforeExit is transpiled to use CreateMenuOther

• Farmer.Update is transpiled to support BetterGameMenuImpl

Conclusion

• BetterGameMenuImpl is derived from IClickableMenu, not GameMenu

• Any patches targeting GameMenu or it's members will have no meaningful effect in-game when this mod is active.

• Any patches targeting the methods above should be tested/updated.

[KhloeLeclair]

That summary seems to cover the harmony patches well enough.

The harmony patches should be fairly inconsequential to most people, I think. The problem is mainly any code people have that is trying to use the GameMenu class specifically. Lots of code unrelated to harmony patches does that and it's all busted.

[KhloeLeclair]

@lisyce Just letting you know, your recent commit to the allergies mod to remove the honk easter egg is no longer necessary as of today's update. I considered that a bug and fixed it.

[tvolin]

Hi. Please take a look at the bug report I just posted against Almanac, called "Book Collection tab creates conflict with UI Info Suite 2 and possibly other mods". Ironically (or not ironically?) your work on Better Game Menu sounds like it's exactly the fix to this issue.
TL;DR - both Almanac (for "Book Collection") and UI Info Suite 2 (for "UI Info Suite 2 Options") add an extra tab on the game menu, and they are using some draw hacks and mouse listening hacks (I guess?), and landing on top of each other.
I hope this is the kind of thing you aim to fix with Better Game Menu (along with Controller support - which means avoiding listening explicitly for mouse-clicks).
If this is what BGM is about, then I fully expect that the UI Info Suite 2 author will need to leverage BGM as well.

@Vindeflei can you also please take a look? I can't understand enough about the changes you made to know if they are relevant. And I have never run a version of Almanac other than yours.

[KhloeLeclair]

You... are aware that Almanac hasn't had an official 1.6 release, I hope? I don't accept bug reports for unofficial releases.

Eventually I do want to make a new Almanac release, but having other people update it for me basically killed my interest in working on it so the work I do manage to do is slow and sporadic. And it will require BGM for adding a custom menu page, whenever my remake is finally done.

[tvolin]

Yes, I completely understand that. I don't think you would really accept a bug report if I went back and installed SDV 1.5 either. it would be pointless.
Thanks for the quick response and your continued efforts.
Once I saw that this dovetails with your BGM effort, I thought it might be of interest to you.
FYI I opened an issue against UI Info Suite 2. If they want to add a tab to the Game menu and have it conflict-free, it seems like they may want to look into what you are doing here. If you are interested in that bug report, it is here

[KhloeLeclair]

For the record, I've also already submitted a PR against UI Info Suite 2 that integrates it with Better Game Menu, as is linked in the mod list at the top of this issue.

[SoulSilverJD]

Hey khloeLeclair I been checking here and there and used almost all of the different versions you released, honestly all the bugs I've noticed have been stumped before I could document it for you haha, so I left them out.

I also tried all the PR's that you made (For the Mods already on my list), am very new to building solutions but I believe I got the hang of it. All I can say is that they work beautifully I found almost no errors when using them, at least that I noticed.

As for mod incompatibilities I believe I found just one this time Mastery Extended. It's related to the VPP PR of yours, I already notified the author of said mod but I think a little help would be appreciated. (Send my regards) They did make a PR for VPP and I tried it and the issue still persists, I also believe SpaceCore 1.27.1-unofficial.1-khloe.zip might be playing a part here but am less sure about that one. I made a Bug Report if you want to catch up on it under the name "Error's I Noticed".

Anyways I wanted to thank you I've noticed how much effort your putting into this and just so you know your getting thumbs ups form someone somewhere in New York.

[SoulSilverJD]

Issue after newest Smapi update Smapi Log

[tvolin]

Hi again. I've noticed a minor incompatibility between Better Crafting "recover trash" feature and "Fishing Assistant 2" similar feature.
I know of three mods which hook into clicks on the garbage can in the inventory menu, which might need treatment with Better Game Menu: Better Crafting, Fishing Assistant 2, Garbage in Garbage Can.
I could be wrong. Just FYI.

[KhloeLeclair]

Talked with the dev of Mastery Extended today, and they figured out what was causing the issue and are updating to resolve that.

I'll fix that thing with GMCM soon. It shouldn't actually be that anything is broken, just that it's logging a scary message because of a change in SMAPI. Probably have to be tomorrow though. Work was busy today, and the FFXIV 7.2 update dropped today as well so I'll be stuck in that all night.

As for tvolin's comment about the recover trash feature in Better Crafting, I already provide a setting to disable the feature, so just... disable it? Given how I've implemented it, I don't think it can really break anything. It's just an event subscriber that opens a menu, not even any harmony patches outside of a postfix for tracking trashed items. At worst it could be an exploit if multiple mods are tracking trashed items and let you recover them.