refactor(sfx): rename synthetic tree root to "SFX"

Author: guanzo

cue_lib/audio/file_tree_rows.py

@@ -230,7 +230,7 @@ def row_buttons(self, item, target_ok, target_tt, unplayable):  # pyright: ignor
         in intensity add-mode appends to the active (group, level).  An empty
         folder gets no buttons (matches the current tree UI).
 
-        Display paths carry the synthetic wrapper ("SFX Folder/..." for
+        Display paths carry the synthetic wrapper ("SFX/..." for
         built-in, "ExtA/..." for external); every action that feeds a path
         uses ref_from_display to get the stored ref.  The file [+] is
         index-based and stays."""

cue_lib/audio/sfx_manager.py

@@ -350,7 +350,7 @@ class CueSfxLibraryTree(CueAudioTreeManager):
 
     _scan_label = "audio folder"
     _log_tag = "AUDIO"
-    # The synthetic "SFX Folder" root opens by default like music's roots;
+    # The synthetic "SFX" root opens by default like music's roots;
     # persisted toggles still win via _restore_expansion.
     _auto_expand_roots = True
     _persist_key = CUE_PERSIST_SFX_TREE_EXPANDED
@@ -422,7 +422,7 @@ def _discover(self, results_set):
     def scan(self):
         # type: () -> None
         """Scan every source (built-in audio dir + external folders), then
-        merge the per-source trees under a synthetic "SFX Folder" root.
+        merge the per-source trees under a synthetic "SFX" root.
 
         Mirror of CueMusicTree.scan.  A built-in scan failure leaves that
         source's files/tree empty and sets its scan_error; external folders
@@ -464,7 +464,7 @@ def ref_from_display(self, display_path):
         # type: (str) -> str
         """Stored ref for a merged display path.
 
-        Inverts the merged tree: the synthetic "SFX Folder" root maps back to
+        Inverts the merged tree: the synthetic "SFX" root maps back to
         the audio-relative ref; an external source label maps to the bare
         absolute payload.  Any other path passes through unchanged (row
         builders feed untagged paths in tests and for legacy trees)."""
@@ -494,7 +494,7 @@ def _merged_tree(self):
         # type: () -> List[Dict[str, Any]]
         """Build the combined nested tree from the per-source trees.
 
-        Built-in files wrap under the synthetic "SFX Folder" root; external
+        Built-in files wrap under the synthetic "SFX" root; external
         sources render as additional top-level entries below it.  A source
         with no files (missing folder) still appears so its warning row is
         reachable."""
@@ -516,7 +516,7 @@ def _file_node(self, item, full, depth):
         # type: (Dict[str, Any], str, int) -> Dict[str, Any]
         """File row with ref/index/enabled for the SFX Library.
 
-        ``full`` is the merged display path ("SFX Folder/g1/x.ogg" for
+        ``full`` is the merged display path ("SFX/g1/x.ogg" for
         built-in, "ExtA/g1/x.ogg" for external); the stored ref inverts it so
         both built-in AND external rows get valid indices and disabled
         membership without changing the [+] index path."""

cue_lib/constants.py

@@ -148,7 +148,7 @@ class CueContextType(object):
 
 # Display-only synthetic root for built-in SFX files in the SFX Library tree,
 # so the audio dir renders like an external folder (sfx_manager.py).
-CUE_SFX_FOLDER = "SFX Folder/"
+CUE_SFX_FOLDER = "SFX/"
 
 # Default pool / preset volume (1.0 = identity).  CueVolumeManager.VOL_DEFAULT
 # aliases this for legacy _cue.volume.VOL_DEFAULT references.

cue_lib/constants.pyi

@@ -22,7 +22,7 @@ CUE_MY_MUSIC_FOLDER: Final = "My Music/"
 CUE_GAME_MUSIC_FOLDER: Final = "Game Music/"
 CUE_MUSIC_USER_TAG: Final = "u:"
 CUE_MUSIC_GAME_TAG: Final = "g:"
-CUE_SFX_FOLDER: Final = "SFX Folder/"
+CUE_SFX_FOLDER: Final = "SFX/"
 CUE_VOLUME_DEFAULT: Final = 1.0
 
 CUE_INTENSITY_PRESET_TYPE: Final = "intensity"

test_game/templates/testcases_legacy.rpy

@@ -1641,7 +1641,7 @@ testcase sfx_external_tree_renders:
     $ _cue.is_overlay_visible = True
     run Jump("start")
     pause 2.0
-    # The SFX library wraps built-ins in the synthetic "SFX Folder/" root and
+    # The SFX library wraps built-ins in the synthetic "SFX/" root and
     # appends external folders below it; rendering the SFX page under that
     # state exercises the per-source tree rows.
     $ _md, _sd = _cue_external_dirs()
@@ -1650,7 +1650,7 @@ testcase sfx_external_tree_renders:
     $ _ok = len(_cue.sfx.library.external_files) == 1
     $ _ok = _ok and _cue.sfx.library.external_sources[0]["label"] == "ExtSfx"
     $ _ok = _ok and len(_cue.sfx.library.tree) >= 2
-    $ _ok = _ok and _cue.sfx.library.tree[0]["name"] == "SFX Folder/"
+    $ _ok = _ok and _cue.sfx.library.tree[0]["name"] == "SFX/"
     $ _ok = _ok and any(_e.get("name") == "ExtSfx/" for _e in _cue.sfx.library.tree)
     run Function(_cue_set_page, CuePage.SFX)
     pause 0.5

test_game/templates/testcases_modern.rpy

@@ -1356,7 +1356,7 @@ testcase music_external_tree_renders:
 testcase sfx_external_tree_renders:
     run Jump("start")
     $ _cue_test_reset()
-    # The SFX library wraps built-ins in the synthetic "SFX Folder/" root and
+    # The SFX library wraps built-ins in the synthetic "SFX/" root and
     # appends external folders below it; rendering the SFX page under that
     # state exercises the per-source tree rows.
     $ _md, _sd = _cue_external_dirs()
@@ -1365,7 +1365,7 @@ testcase sfx_external_tree_renders:
     assert eval (len(_cue.sfx.library.external_files) == 1)
     assert eval (_cue.sfx.library.external_sources[0]["label"] == "ExtSfx")
     assert eval (len(_cue.sfx.library.tree) >= 2)
-    assert eval (_cue.sfx.library.tree[0]["name"] == "SFX Folder/")
+    assert eval (_cue.sfx.library.tree[0]["name"] == "SFX/")
     assert eval (any(_e.get("name") == "ExtSfx/" for _e in _cue.sfx.library.tree))
     run Function(_cue_set_page, CuePage.SFX)
     assert eval (_cue.overlay_active_page == CuePage.SFX)

tests/test_audio_tree.py

@@ -518,14 +518,14 @@ def test_sfx_scan_missing_external_folder_keeps_warning(sfx, tmp_path):
 
 
 def test_sfx_external_label_disambiguated(sfx):
-    assert sfx._external_label("E:/SFX Folder", []) == "SFX Folder (2)"
+    assert sfx._external_label("E:/SFX", []) == "SFX (2)"
     assert sfx._external_label("E:/Music", []) == "Music"
     assert sfx._external_label("E:/Music", ["Music"]) == "Music (2)"
 
 
 def test_sfx_ref_from_display(sfx):
     sfx.external_sources = [{"label": "ExtA", "abs_root": "E:/SFX/A", "tree": [], "files": [], "scan_error": ""}]
-    assert sfx.ref_from_display("SFX Folder/g1/drip.ogg") == "g1/drip.ogg"
+    assert sfx.ref_from_display(CUE_SFX_FOLDER + "g1/drip.ogg") == "g1/drip.ogg"
     assert sfx.ref_from_display("ExtA/g1/drip.ogg") == "E:/SFX/A/g1/drip.ogg"
     assert sfx.ref_from_display("ExtA/g1/") == "E:/SFX/A/g1/"
     # Unknown paths (legacy / unqualified rows) pass through unchanged.
@@ -542,7 +542,7 @@ def test_sfx_file_node_ref_index_enabled(sfx):
     sfx.external_sources = [{"label": "ExtA", "abs_root": "E:/SFX/A", "tree": [], "files": [], "scan_error": ""}]
     sfx._file_index = {"g1/drip.ogg": 2, "E:/SFX/A/x.ogg": 3}
     sfx.disabled_files = {"E:/SFX/A/x.ogg"}
-    builtin = sfx._file_node({"name": "drip.ogg"}, "SFX Folder/g1/drip.ogg", 1)
+    builtin = sfx._file_node({"name": "drip.ogg"}, CUE_SFX_FOLDER + "g1/drip.ogg", 1)
     assert builtin["ref"] == "g1/drip.ogg"
     assert builtin["index"] == 2
     assert builtin["enabled"] is True
@@ -1014,7 +1014,7 @@ def test_sfx_row_buttons_use_refs(sfx):
     sfx.external_sources = [{"label": "ExtA", "abs_root": "E:/SFX/A", "tree": [], "files": [], "scan_error": ""}]
     sfx.visible_tree = [
         {"type": "folder", "name": "ExtA/", "full_path": "ExtA/", "depth": 0, "has_files": True},
-        {"type": "file", "name": "drip.ogg", "full_path": "SFX Folder/g1/drip.ogg", "depth": 1, "index": 0},
+        {"type": "file", "name": "drip.ogg", "full_path": CUE_SFX_FOLDER + "g1/drip.ogg", "depth": 1, "index": 0},
     ]
     rows = sfx.tree_rows(True, "tt", {})
     ext_folder, builtin_file = rows
@@ -1742,7 +1742,7 @@ def _discover(results):
 
     monkeypatch.setattr(sfx, "_discover", _discover)
     sfx.scan()
-    assert sfx.expanded_folders == {"SFX Folder/": True}
+    assert sfx.expanded_folders == {CUE_SFX_FOLDER: True}
 
 
 def test_sfx_scan_restores_expansion(sfx, monkeypatch):
@@ -1752,7 +1752,7 @@ def _discover(results):
     monkeypatch.setattr(sfx, "_discover", _discover)
     persistent._cue[CUE_PERSIST_SFX_TREE_EXPANDED] = {"sub/": True}
     sfx.scan()
-    assert sfx.expanded_folders == {"SFX Folder/": True, "sub/": True}
+    assert sfx.expanded_folders == {CUE_SFX_FOLDER: True, "sub/": True}
 
 
 def test_sfx_file_ref_expand_persists(sfx):