X2CommunityCore / xcom2-launcher

The Alternative Mod Launcher (AML) is a replacement for the default game launchers from XCOM 2 and XCOM Chimera Squad.
GNU General Public License v3.0
348 stars 51 forks source link

Troubleshooting Mode #59

Open Dragon-32 opened 5 years ago

Dragon-32 commented 5 years ago

90% (or maybe more) of issues people have with mods can be fixed by re-creating their Config files in My Games.

That's usually done by manually deleting the files. That can mean that people accidentally delete MCM configuration files, or maybe they delete files in the XCOM 2 Config directory and not the WotC one.

Not many people seem to know about the -regenerateinis argument

Some info from Amineri here - https://forums.nexusmods.com/index.php?/topic/3971445-partial-solution-to-configini-merging-issues/

So (finally) onto my enhancement idea:

Add a "Troubleshooting Mode" checkbox to the menu bar to the right of Run Challenge Mode. ToolTip something like:

"Troubleshooting Mode should fix most mod problems not caused by Overrides. Use Troubleshooting Mode when mods do not work properly or at all."

Enabling the checkbox will add the -regenerateinis argument.

I'd suggest a dialog when someone enables, something like:

"With Troubleshooting Mode enabled click the "Run XCOM 2" or "Run War of the Chosen" buttons. The game will launch with no mods enabled. When you reach the game's main menu select Options and configure your graphics, sound and gameplay options; define your key bindings too. When complete Exit the game and disable Troubleshooting Mode in the XCOM 2 Mod Launcher. The next time you run the game your problematic mod will very probably be fixed."

There should be a "Don't show this again" checkbox for that wall of text. And I guess a "Actually please show the WoT again" option in Launcher settings.

Maybe it's possible to automatically clear the Troubleshooting Mode checkbox on game launch?

Reason for telling people to set their options and key bindings is that when mods which use keyboard input are enabled bindings never seem to stick. Also had some problems with graphics options resetting.

Anyway, think this would be a really good thing for all XCOM 2 mod users. I manually add the -regenerateinis argument whenever I'm troubleshooting, but having this front and centre (and GUI-fied for the non-techie) in the Launcher would be so useful.

Dragon-32 commented 5 years ago

Thanks for looking at this, RevZero. Issue is currently set as unclear and needing further discussion.

Happy to clarify: what's not clear?

RevZero commented 5 years ago

So far I just haven't had time to look at this in detail.

So this essentially comes down, to having an option, that allows to reset the current configuration to the default values? And from what I get, it potentially helps fixing mod issues, because there maybe invalid configuration values from older mod versions that can cause a mod to crash/misbehave? Not sure about that part, please correct me.

Maybe some others are more qualified to comment on this issue @robojumper @Xymanek or anyone else has something to add?

Dragon-32 commented 5 years ago

Manually deleting and letting the game recreate the config files in My Games fixes ~95% of mod problems.

Having a GUI widget which launches the game with the -regenerateinis argument automates this troubleshooting step and would hopefully cut down on the multitude of "mod no work, pls fix" posts on the Workshop.

Xymanek commented 5 years ago

A good tool to implement would be an automated binary search for searching for a mod that:

There will also be a need for ability to exclude some important mods (disabling which will surely break the campaign, eg. RPGO) from this search