Dusk/Modernization-Tool
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 5 Wiki Activity

Keep Vanilla Tweaks independent from SuperWoW

Browse Source
This commit is contained in:
github-actions[bot]
2026-09-03 21:33:23 +00:00
parent a46bb67d0d
commit b861ad89e2
2 changed files with 75 additions and 201 deletions
Download Patch File Download Diff File Expand all files Collapse all files
setup_tool.py
+34 -115
View File
@@ -724,35 +724,25 @@ class WowSetupTool:
return bool(var is not None and var.get())
def update_superwow_managed_controls(self):
"""Disable vanilla-tweaks controls that SuperWoW already handles."""
active = self._superwow_enabled()
"""Keep Vanilla Tweaks controls independent from SuperWoW."""
if hasattr(self, "superwow_notice"):
if active:
self.superwow_notice.configure(
text="✓ SuperWoW enabled — FoV, Sound Channels, Auto-loot and Background sounds are handled by SuperWoW. Their vanilla-tweaks patches are skipped.",
background="#EAF4FF",
foreground="#005A9E",
)
else:
self.superwow_notice.configure(
text="SuperWoW disabled — FoV, Sound Channels, Auto-loot and Background sounds are controlled by vanilla-tweaks.",
background="#F4F4F4",
foreground="#444444",
)
try:
self.superwow_notice.pack_forget()
except tk.TclError:
pass
if hasattr(self, "fov_ratio_combo"):
self.fov_ratio_combo.configure(state="disabled" if active else "readonly")
self.fov_ratio_combo.configure(state="readonly")
if hasattr(self, "fov_entry"):
self.fov_entry.configure(state="disabled" if active else "normal")
self.fov_entry.configure(state="normal")
if hasattr(self, "sound_scale"):
self.sound_scale.configure(state="disabled" if active else "normal")
self.sound_scale.configure(state="normal")
if hasattr(self, "sound_entry"):
self.sound_entry.configure(state="disabled" if active else "normal")
self.sound_entry.configure(state="normal")
if hasattr(self, "cb_loot"):
self.cb_loot.configure(state="disabled" if active else "normal")
self.cb_loot.configure(state="normal")
if hasattr(self, "cb_bg"):
self.cb_bg.configure(state="disabled" if active else "normal")
self.cb_bg.configure(state="normal")
def build_tweaks_tab(self, parent):
self.superwow_notice = tk.Label(
@@ -2512,79 +2502,22 @@ WScript.Echo oWS.SpecialFolders("Desktop")
return digest.hexdigest()
def _vanilla_tweaks_signature(self):
"""Return only settings that change WoW_Modernized.exe patch output."""
superwow_active = self._superwow_enabled()
signature = {
"superwow_active": bool(superwow_active),
"fov": None if superwow_active else round(float(self.vt_fov.get()), 4),
"""Return settings that change WoW_Modernized.exe patch output."""
return {
"fov": round(float(self.vt_fov.get()), 4),
"farclip": int(self.vt_farclip.get()),
"frill": int(self.vt_frill.get()),
"nameplate": int(self.vt_nameplate.get()),
"sound_channels": (
None if superwow_active else int(self.vt_soundchan.get())
),
"sound_channels": int(self.vt_soundchan.get()),
"max_camera": int(self.vt_maxcam.get()),
"quickloot": (
None if superwow_active else bool(self.vt_quickloot.get())
),
"background_sound": (
None if superwow_active else bool(self.vt_bg_sound.get())
),
"quickloot": bool(self.vt_quickloot.get()),
"background_sound": bool(self.vt_bg_sound.get()),
"large_address_aware": bool(self.vt_laa.get()),
"camera_fix": bool(self.vt_cam_fix.get()),
"crossfaction_res": bool(self.vt_crossfaction_res.get()),
"custom_glues": bool(self.vt_custom_glues.get()),
"bluemoon": bool(self.vt_bluemoon.get()),
}
if superwow_active:
signature["superwow_managed_patch_reset"] = 1
return signature
def _reset_superwow_managed_exe_patches(self, path):
"""Undo inherited vanilla-tweaks patches that SuperWoW/SuperAPI own."""
with open(path, "rb") as handle:
data = bytearray(handle.read())
required_size = 0x435D3C
if len(data) < required_size:
raise RuntimeError("WoW executable is too small to normalize SuperWoW-managed patches.")
quickloot_sites = (
(0x0C1ECF, b"\x74\x10"),
(0x0C2B25, b"\x74\x0B"),
)
for offset, vanilla_bytes in quickloot_sites:
current = bytes(data[offset:offset + 2])
known_variants = (
vanilla_bytes,
bytes((0x75, vanilla_bytes[1])),
b"\x90\x90",
)
if current not in known_variants:
raise RuntimeError(
f"Unexpected QuickLoot bytes at 0x{offset:X}; refusing to alter an unknown client."
)
data[offset:offset + 2] = vanilla_bytes
if data[0x3A4869] not in (0x14, 0x27):
raise RuntimeError(
"Unexpected Background Sound byte; refusing to alter an unknown client."
)
data[0x3A4869] = 0x14
data[0x4089B4:0x4089B8] = struct.pack("<f", 1.5708)
data[0x435D38:0x435D3C] = b"12\x00\x00"
staged = path + ".superwow-reset"
try:
with open(staged, "wb") as handle:
handle.write(data)
os.replace(staged, path)
finally:
if os.path.exists(staged):
try:
os.remove(staged)
except OSError:
pass
def run_vanilla_tweaks(self, target, tweaks_exe=None, modern_cli=False):
"""Patch a copy of WoW.exe while preserving the original executable."""
@@ -2596,12 +2529,10 @@ WScript.Echo oWS.SpecialFolders("Desktop")
raise FileNotFoundError("vanilla-tweaks.exe was not found.")
args = [tweaks_exe]
superwow_active = self._superwow_enabled()
if modern_cli:
# tubtubs/vanilla-tweaks keeps these four patches opt-in. When
# SuperWoW is active, deliberately leave them unpatched.
if not superwow_active and abs(self.vt_fov.get() - 1.5708) >= 0.0001:
# tubtubs/vanilla-tweaks keeps these patches opt-in.
if abs(self.vt_fov.get() - 1.5708) >= 0.0001:
args.extend(["--fov", str(self.vt_fov.get()), "--fov-patch"])
if self.vt_farclip.get() == 777:
@@ -2619,7 +2550,7 @@ WScript.Echo oWS.SpecialFolders("Desktop")
else:
args.extend(["--nameplatedistance", str(self.vt_nameplate.get())])
if not superwow_active and self.vt_soundchan.get() != 12:
if self.vt_soundchan.get() != 12:
args.extend([
"--soundchannels",
str(self.vt_soundchan.get()),
@@ -2629,9 +2560,9 @@ WScript.Echo oWS.SpecialFolders("Desktop")
if self.vt_maxcam.get() != 50:
args.extend(["--maxcameradistance", str(self.vt_maxcam.get())])
if not superwow_active and self.vt_quickloot.get():
if self.vt_quickloot.get():
args.append("--quickloot")
if not superwow_active and self.vt_bg_sound.get():
if self.vt_bg_sound.get():
args.append("--sound-in-background")
if not self.vt_laa.get():
args.append("--no-largeaddressaware")
@@ -2644,30 +2575,21 @@ WScript.Echo oWS.SpecialFolders("Desktop")
if not self.vt_bluemoon.get():
args.append("--no-bluemoonpatch")
else:
# Legacy bundled brndd patcher enables these older patches by
# default, so explicitly disable all four when SuperWoW handles them.
if superwow_active:
args.extend([
"--no-fov",
"--no-soundchannels",
"--no-quickloot",
"--no-sound-in-background",
])
# Legacy bundled brndd patcher kept only as an offline fallback.
if abs(self.vt_fov.get() - 1.5708) < 0.0001:
args.append("--no-fov")
else:
if abs(self.vt_fov.get() - 1.5708) < 0.0001:
args.append("--no-fov")
else:
args.extend(["--fov", str(self.vt_fov.get())])
args.extend(["--fov", str(self.vt_fov.get())])
if self.vt_soundchan.get() == 12:
args.append("--no-soundchannels")
else:
args.extend(["--soundchannels", str(self.vt_soundchan.get())])
if self.vt_soundchan.get() == 12:
args.append("--no-soundchannels")
else:
args.extend(["--soundchannels", str(self.vt_soundchan.get())])
if not self.vt_quickloot.get():
args.append("--no-quickloot")
if not self.vt_bg_sound.get():
args.append("--no-sound-in-background")
if not self.vt_quickloot.get():
args.append("--no-quickloot")
if not self.vt_bg_sound.get():
args.append("--no-sound-in-background")
if self.vt_farclip.get() == 777:
args.append("--no-farclip")
@@ -2711,9 +2633,6 @@ WScript.Echo oWS.SpecialFolders("Desktop")
try:
subprocess.run(args, check=True)
if superwow_active:
self._reset_superwow_managed_exe_patches(staged_output)
valid_pe, reason = self._inspect_wow_executable(staged_output)
if not valid_pe:
raise RuntimeError(
tests/test_safety.py
+41 -86
View File
@@ -812,66 +812,7 @@ class SmartUpdateTests(unittest.TestCase):
self.assertEqual(revision, "abcdef1234567890")
download.assert_not_called()
def test_superwow_reset_removes_inherited_vanilla_tweaks_patches(self):
tool = WowSetupTool.__new__(WowSetupTool)
size = 0x435D3C + 16
data = bytearray(size)
data[0x0C1ECF:0x0C1ED1] = b"\x75\x10"
data[0x0C2B25:0x0C2B27] = b"\x75\x0B"
data[0x3A4869] = 0x27
data[0x4089B4:0x4089B8] = struct.pack("<f", 1.919862)
data[0x435D38:0x435D3C] = b"64\x00\x00"
data[0x40FED8:0x40FEDC] = struct.pack("<f", 3000.0)
with tempfile.TemporaryDirectory() as root:
path = os.path.join(root, "WoW_Modernized.exe")
with open(path, "wb") as handle:
handle.write(data)
tool._reset_superwow_managed_exe_patches(path)
with open(path, "rb") as handle:
result = handle.read()
self.assertEqual(result[0x0C1ECF:0x0C1ED1], b"\x74\x10")
self.assertEqual(result[0x0C2B25:0x0C2B27], b"\x74\x0B")
self.assertEqual(result[0x3A4869], 0x14)
self.assertAlmostEqual(
struct.unpack("<f", result[0x4089B4:0x4089B8])[0],
1.5708,
places=4,
)
self.assertEqual(result[0x435D38:0x435D3C], b"12\x00\x00")
self.assertEqual(
result[0x40FED8:0x40FEDC],
struct.pack("<f", 3000.0),
)
def test_superwow_reset_handles_known_always_autoloot_variant(self):
tool = WowSetupTool.__new__(WowSetupTool)
size = 0x435D3C + 16
data = bytearray(size)
data[0x0C1ECF:0x0C1ED1] = b"\x90\x90"
data[0x0C2B25:0x0C2B27] = b"\x90\x90"
data[0x3A4869] = 0x14
data[0x4089B4:0x4089B8] = struct.pack("<f", 1.5708)
data[0x435D38:0x435D3C] = b"12\x00\x00"
with tempfile.TemporaryDirectory() as root:
path = os.path.join(root, "WoW_Modernized.exe")
with open(path, "wb") as handle:
handle.write(data)
tool._reset_superwow_managed_exe_patches(path)
with open(path, "rb") as handle:
result = handle.read()
self.assertEqual(result[0x0C1ECF:0x0C1ED1], b"\x74\x10")
self.assertEqual(result[0x0C2B25:0x0C2B27], b"\x74\x0B")
def test_superwow_signature_versions_patch_reset_policy(self):
def test_superwow_does_not_change_vanilla_tweaks_signature(self):
tool = WowSetupTool.__new__(WowSetupTool)
tool.core_plugins = {"SuperWoWhook.dll": FakeVar(True)}
tool.vt_fov = FakeVar(1.919862)
@@ -888,18 +829,37 @@ class SmartUpdateTests(unittest.TestCase):
tool.vt_custom_glues = FakeVar(True)
tool.vt_bluemoon = FakeVar(False)
signature = tool._vanilla_tweaks_signature()
self.assertEqual(signature["superwow_managed_patch_reset"], 1)
self.assertIsNone(signature["fov"])
self.assertIsNone(signature["sound_channels"])
self.assertIsNone(signature["quickloot"])
self.assertIsNone(signature["background_sound"])
signature_with_superwow = tool._vanilla_tweaks_signature()
tool.core_plugins["SuperWoWhook.dll"].set(False)
signature = tool._vanilla_tweaks_signature()
self.assertNotIn("superwow_managed_patch_reset", signature)
signature_without_superwow = tool._vanilla_tweaks_signature()
def test_superwow_run_normalizes_staged_output_before_commit(self):
self.assertEqual(signature_with_superwow, signature_without_superwow)
self.assertEqual(signature_with_superwow["fov"], 1.9199)
self.assertEqual(signature_with_superwow["sound_channels"], 64)
self.assertTrue(signature_with_superwow["quickloot"])
self.assertTrue(signature_with_superwow["background_sound"])
def test_superwow_keeps_vanilla_tweaks_controls_enabled(self):
tool = WowSetupTool.__new__(WowSetupTool)
tool.superwow_notice = mock.Mock()
tool.fov_ratio_combo = mock.Mock()
tool.fov_entry = mock.Mock()
tool.sound_scale = mock.Mock()
tool.sound_entry = mock.Mock()
tool.cb_loot = mock.Mock()
tool.cb_bg = mock.Mock()
tool.update_superwow_managed_controls()
tool.superwow_notice.pack_forget.assert_called_once()
tool.fov_ratio_combo.configure.assert_called_once_with(state="readonly")
tool.fov_entry.configure.assert_called_once_with(state="normal")
tool.sound_scale.configure.assert_called_once_with(state="normal")
tool.sound_entry.configure.assert_called_once_with(state="normal")
tool.cb_loot.configure.assert_called_once_with(state="normal")
tool.cb_bg.configure.assert_called_once_with(state="normal")
def test_superwow_modern_cli_keeps_selected_fov_sound_loot_and_background(self):
tool = WowSetupTool.__new__(WowSetupTool)
tool.core_plugins = {"SuperWoWhook.dll": FakeVar(True)}
tool.vt_fov = FakeVar(1.919862)
@@ -915,9 +875,9 @@ class SmartUpdateTests(unittest.TestCase):
tool.vt_crossfaction_res = FakeVar(False)
tool.vt_custom_glues = FakeVar(True)
tool.vt_bluemoon = FakeVar(False)
tool._reset_superwow_managed_exe_patches = mock.Mock()
tool._inspect_wow_executable = mock.Mock(return_value=(True, "ok"))
tool._inspect_wow_executable = mock.Mock(return_value=(True, ""))
captured = {}
with tempfile.TemporaryDirectory() as root:
wow = os.path.join(root, "WoW.exe")
patcher = os.path.join(root, "vanilla-tweaks.exe")
@@ -927,26 +887,21 @@ class SmartUpdateTests(unittest.TestCase):
handle.write(b"patcher")
def fake_run(args, check):
captured["args"] = list(args)
staged = args[args.index("-o") + 1]
with open(staged, "wb") as handle:
handle.write(b"MZ" + b"\x00" * (2 * 1024 * 1024))
with mock.patch("setup_tool.subprocess.run", side_effect=fake_run):
result = tool.run_vanilla_tweaks(
root,
tweaks_exe=patcher,
modern_cli=True,
)
tool.run_vanilla_tweaks(root, tweaks_exe=patcher, modern_cli=True)
staged = os.path.join(
root,
"WoW_Modernized.exe.modernization-new",
)
tool._reset_superwow_managed_exe_patches.assert_called_once_with(staged)
self.assertEqual(
result,
os.path.join(root, "WoW_Modernized.exe"),
)
args = captured["args"]
self.assertIn("--fov", args)
self.assertIn("--fov-patch", args)
self.assertIn("--soundchannels", args)
self.assertIn("--soundchannels-patch", args)
self.assertIn("--quickloot", args)
self.assertIn("--sound-in-background", args)
def test_vanilla_tweaks_skips_package_when_output_and_revision_match(self):
tool = setup_tool_dynamic.ModernWowSetupTool.__new__(