Fallback Region Option #9254

flagrama · 2020-11-17T02:50:09Z

A user-selected fallback to use instead of the default PAL

This can be used for unknown region or region free titles to give them the ability to force a different region than the current fallback region of PAL. This can be useful if a user is trying to play a region free title that is originally NTSC and expects to be run at NTSC speeds. This may be done when a user attempts to dump a WAD of their own without understanding the settings they have chosen, or could be an intentional decision by a developer of a ROM hack that can be injected into a Virtual Console WAD.

This is primarily a proof-of-concept in its current stage.

JosJuice · 2020-11-17T09:43:02Z

If we're going to have a setting for this, the setting should be checked before checking the region of the system menu, as the region of the system menu is rather annoying to change.

It would be simpler if we used the Region enum as the type of the setting instead of a string.

I personally don't think it makes sense to have both "override" and "fallback" in the name. It's either an override or a fallback, not both. The way it's implemented, I would not call it an override, as it has no effect for games with a known region.

flagrama · 2020-11-17T11:55:23Z

If we're going to have a setting for this, the setting should be checked before checking the region of the system menu, as the region of the system menu is rather annoying to change.

I can certainly do that.

It would be simpler if we used the Region enum as the type of the setting instead of a string.

I tried that at first, didn't work immediately, went with strings for the POC. I definitely plan to look into this more.

I personally don't think it makes sense to have both "override" and "fallback" in the name. It's either an override or a fallback, not both. The way it's implemented, I would not call it an override, as it has no effect for games with a known region.

That's fair I suppose. I named it as such because it overrides the default fallback of forcing PAL if no other method exists to find one. (not identifiable from the running title, no System Menu installed)

I'll try to get some of this done soon.

JosJuice · 2020-11-17T12:03:47Z

Hm, maybe "fallback override" does actually make sense if it overrides the system menu check... I would appreciate if someone else could weigh in on this.

flagrama · 2020-11-17T21:46:18Z

The fallback override should now take precedence over the current installed Wii System Menu. It also uses the DiscIO::Region enum instead of strings. Converting between the Combo Box selection and the region still uses separate index values because I personally find Disabled at the top of the list much more user-friendly than having it fourth in the list, not even as the last one, that using the Region enum directly would cause.

leoetlino

Hm, maybe "fallback override" does actually make sense if it overrides the system menu check... I would appreciate if someone else could weigh in on this.

I agree with this reasoning. However, I'm not sure most users know what fallback it's overriding, or even that the system menu region is used as a fallback... Removing the "override" wouldn't be a good solution because it is technically an override and you can disable the override, so I think what we should do is add an explanation in the UI.

leoetlino · 2020-11-25T12:48:40Z

Source/Core/Core/ConfigManager.cpp

@@ -246,6 +246,7 @@ void SConfig::SaveCoreSettings(IniFile& ini)
  core->Set("PerfMapDir", m_perfDir);
  core->Set("EnableCustomRTC", bEnableCustomRTC);
  core->Set("CustomRTCValue", m_customRTCValue);
+  core->Set("FallbackRegionOverride", m_fallback_region_override);


Suggested change

core->Set("FallbackRegionOverride", m_fallback_region_override);

leoetlino · 2020-11-25T12:48:46Z

Source/Core/Core/ConfigManager.cpp

@@ -514,6 +515,7 @@ void SConfig::LoadCoreSettings(IniFile& ini)
  core->Get("EnableCustomRTC", &bEnableCustomRTC, false);
  // Default to seconds between 1.1.1970 and 1.1.2000
  core->Get("CustomRTCValue", &m_customRTCValue, 946684800);
+  core->Get("FallbackRegionOverride", &m_fallback_region_override, DiscIO::Region::Unknown);


Suggested change

core->Get("FallbackRegionOverride", &m_fallback_region_override, DiscIO::Region::Unknown);

leoetlino · 2020-11-25T12:48:56Z

Source/Core/Core/ConfigManager.h

@@ -308,6 +308,9 @@ struct SConfig
  std::string m_auto_update_track;
  std::string m_auto_update_hash_override;

+  // Fallback Region Override setting


These three lines should be removed: instead, you should add it to the list in Core/ConfigLoaders/IsSettingSaveable.cpp (and then use Config::SetBase / Config::Get to interact with the setting)

leoetlino · 2020-11-25T12:55:13Z

Source/Core/DolphinQt/Settings.cpp

+  if (region == GetFallbackRegionOverride())
+    return;
+
+  SConfig::GetInstance().m_fallback_region_override = region;


This should use Config::SetBase (as mentioned above)

leoetlino · 2020-11-25T12:56:40Z

Source/Core/DolphinQt/Settings.cpp

+
+DiscIO::Region Settings::GetFallbackRegionOverride() const
+{
+  return SConfig::GetInstance().m_fallback_region_override;


Config::Get

leoetlino · 2020-11-25T13:01:49Z

Source/Core/Core/ConfigManager.cpp

@@ -929,6 +931,13 @@ bool SConfig::SetPathsAndGameMetadata(const BootParameters& boot)

 DiscIO::Region SConfig::GetFallbackRegion()
 {
+  // Fall back to the override option if set
+  const DiscIO::Region fallback = SConfig::GetInstance().m_fallback_region_override;


Missed this one, but this should use Config::Get as well, of course.

flagrama · 2020-11-26T18:28:48Z

[...] so I think what we should do is add an explanation in the UI.

How does this work for an explanation as a QLabel under the form row?

Overrides the fallback region for titles that do not have one.

Titles without a region that can be determined automatically will fallback to this option. If this option is disabled, instead the region will fallback to the installed Wii System Menu region, or if one cannot be found, the PAL region.

I'm certainly not a wordsmith, so am up for changing it any way it is needed.

leoetlino · 2020-11-27T01:32:49Z

I'd remove the first sentence as vertical space is at a premium in the setting windows:

Dolphin will use this for titles whose region cannot be determined automatically. If this option is disabled, the region of the installed Wii System Menu will be used, or if one cannot be found, the PAL region.

flagrama · 2020-11-27T01:55:49Z

I've added that explanation text and it appears like so:

flagrama · 2020-11-28T17:45:42Z

Appearance after latest commit:

Source/Core/Core/ConfigManager.cpp

JosJuice · 2020-11-28T20:01:35Z

Source/Core/Core/Config/MainSettings.h

+#include <DiscIO/Enums.h>
 #include <string>

 #include "Common/Config/Config.h"


Suggested change

#include <DiscIO/Enums.h>

#include <string>

#include "Common/Config/Config.h"

#include <string>

#include "Common/Config/Config.h"

#include "DiscIO/Enums.h"

JosJuice · 2020-11-28T20:02:01Z

Source/Core/Core/ConfigManager.cpp

@@ -11,6 +11,7 @@
 #include <sstream>
 #include <variant>

+#include <Core/Config/MainSettings.h>


Same here. (Place the include below #include "Common/Config/Config.h".)

Also, #include "name" for Dolphin headers, not #include <name>.

Fallback Region A user-selected fallback to use instead of the default PAL This is used for unknown region or region free titles to give them the ability to force region to use. This replaces the current fallback region of PAL. This can be useful if a user is trying to play a region free tilte that is originally NTSC and expects to be run at NTSC speeds. This may be done when a user attempts to dump a WAD of their own without understanding the settings they have chosen, or could be an intentional decision by a developer of a ROM hack that can be injected into a Virtual Console WAD. Remove using System Menu region being checked in GetFallbackRegion Use DiscIO::Region instead of std::String for fallback Add explanation text for Fallback Region

flagrama marked this pull request as ready for review November 24, 2020 02:24

leoetlino requested changes Nov 25, 2020

View reviewed changes

leoetlino reviewed Nov 25, 2020

View reviewed changes

JosJuice reviewed Nov 28, 2020

View reviewed changes

Source/Core/Core/ConfigManager.cpp Show resolved Hide resolved

flagrama changed the title ~~Fallback Region Override Option~~ Fallback Region Option Nov 28, 2020

JosJuice reviewed Nov 28, 2020

View reviewed changes

flagrama force-pushed the fallback-region-selection branch from 33e732c to db5aec0 Compare November 28, 2020 20:47

leoetlino approved these changes Nov 28, 2020

View reviewed changes

leoetlino merged commit 361bf25 into dolphin-emu:master Nov 28, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fallback Region Option #9254

Fallback Region Option #9254

flagrama commented Nov 17, 2020

JosJuice commented Nov 17, 2020

flagrama commented Nov 17, 2020

JosJuice commented Nov 17, 2020

flagrama commented Nov 17, 2020 •

edited

leoetlino left a comment •

edited

leoetlino Nov 25, 2020

leoetlino Nov 25, 2020

leoetlino Nov 25, 2020

leoetlino Nov 25, 2020

leoetlino Nov 25, 2020

leoetlino Nov 25, 2020

flagrama commented Nov 26, 2020

leoetlino commented Nov 27, 2020

flagrama commented Nov 27, 2020

flagrama commented Nov 28, 2020

JosJuice Nov 28, 2020

JosJuice Nov 28, 2020

leoetlino Nov 28, 2020

Fallback Region Option #9254

Fallback Region Option #9254

Conversation

flagrama commented Nov 17, 2020

JosJuice commented Nov 17, 2020

flagrama commented Nov 17, 2020

JosJuice commented Nov 17, 2020

flagrama commented Nov 17, 2020 • edited

leoetlino left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

flagrama commented Nov 26, 2020

leoetlino commented Nov 27, 2020

flagrama commented Nov 27, 2020

flagrama commented Nov 28, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

flagrama commented Nov 17, 2020 •

edited

leoetlino left a comment •

edited