adding "Detect Files" button to Audio settings page by chowell1337 · Pull Request #112 · FireFox2000000/Moonscraper-Chart-Editor

chowell1337 · 2023-08-19T14:42:39Z

~~Prompts the user for a directory (would prefer if this could be auto-detected)~~ Auto-detects the directory of the currently opened chart and automatically assigns files within that directory to the instrument associated iwth their name

…add-detect-files

…ct-files

FireFox2000000 · 2023-11-30T10:41:30Z


+    public void GetInstrumentAudioByFileNames()
+    {
+        // TODO: there HAS to be a way to just detect the current folder, right???


We could get the path of the currently loaded chart file from ChartEditor.Instance.lastLoadedFile (a getter will need to be written to make this public)

thank you for the information! added in commit fd986a3:

FireFox2000000 · 2023-11-30T10:45:27Z

+                default:
+                    // would like to use a switch expression, but since this enum is non-nullable,
+                    // gotta use a continue to skip unwanted files
+                    continue;


This would be better to have a list of the files that were skipped over, and then communicated to the user of which files were invalid and what the correct filenames should be (can send a message via ChartEditor.Instance.errorManager.QueueErrorMessage)

good suggestion, added in commit 61218e5

@FireFox2000000 are there any other filenames that should be considered non-error-worthy, but not be tied to an instrument? e.g. i know "preview.ogg" is used for separate song preview audio files in Clone Hero

Not that I'm aware of.

…ct-files

FireFox2000000 · 2023-12-10T01:25:14Z

        StartCoroutine(_RefreshAllAudioStreams());
    }

+    public void GetInstrumentAudioByFileNames()


This function name should be more specific, would suggest something like "LoadCloneHeroAudioFromDirectory" as the list of audio files are CH-specific.

FireFox2000000 · 2023-12-10T01:26:10Z

+    /// <summary>
+    /// null value indicates a valid filename that doesn't tie to a specific instrument (e.g. the song preview)
+    /// </summary>
+    static readonly Dictionary<string, Song.AudioInstrument?> validFilenames = new Dictionary<string, Song.AudioInstrument?>


This needs more specific naming, as this list of audio files is specific to Rock Band/Clone Hero. Regular guitar hero custom songs are not specific to these audio names.

FireFox2000000 · 2023-12-10T01:28:11Z

+    m_HorizontalOverflow: 0
+    m_VerticalOverflow: 0
+    m_LineSpacing: 1
+  m_Text: Detect Files


Change to "Auto-Detect Clone Hero Files", needs to be specific about the target game.

@FireFox2000000 it seems that the image for the button isn't wide enough to fit that all on one line:

would you be ok with the text being "Auto-Detect CH Files"? if i shrink the font to 12, it fits on one line:

This could be moved so that it's above the first "Load" and "X" buttons, as this really shouldn't be in line with the General/Audio/Advanced tabs in any case.

FireFox2000000 · 2023-12-10T01:31:55Z

+  m_Script: {fileID: 11500000, guid: 635727e25c735994fb6f858716ba8247, type: 3}
+  m_Name: 
+  m_EditorClassIdentifier: 
+  message: Detects audio files from selected folder based on their filenames


This message needs updating as it does not completely reflect the current behaviour after changes.

FireFox2000000 · 2023-12-31T02:22:55Z

+                if (instrument.HasValue)
+                {
+                    LoadInstrumentAudioFromPath(instrument.Value, filePath);
+                }


Note to self, add comment here explaining that the lack of else is a purposeful ignore (see validRBCloneHeroFilenames summary)

FireFox2000000 · 2023-12-31T02:23:23Z

Code side looks good, will need to pull down the branch and evaluate the layout next.

FireFox2000000 · 2024-04-06T02:27:45Z

Bug found-

Auto-detect CH Audio fails to load audio when user is prompted to select a folder via file explorer.

Open Moonscraper in Unity Editor (Windows)
New Song
Audio tab
Select "Auto-Detect CH Files"
Select a song folder containing multiple audio files (Black Window of La Porte was used in testing)
Note audio does not load.
Upon some investigation, line 356 of SongPropertiesPanelController is stripping out 1 level of directories in the call Path.GetDirectoryName(currentDir). For example if the path retrieved is E:/GH3 Customs/11.E John 5 Featuring Jim Root - Black Widow of La Porte, the system tries to load from E:/GH3 Customs instead.

Fix requested

FireFox2000000 · 2024-04-06T02:31:22Z

Bug found-

Multiple assert failures are logged when attempting to use the "Auto-Detect CH Files" button.

Open Moonscraper in Unity Editor (Windows)
Load a song containing multiple audio files (Black Widow of La Porte was used for testing purposes)
Song Properties
Audio tab
Manually clear each stem by clicking the "X" button next to each loaded audio file
Select "Auto-Detect CH Files"
Note assertion failure in console log of Unity Editor for each audio file loaded.

Assertion failed
UnityEngine.Debug:Assert(Boolean)
<KickTasks>d__6:MoveNext() (at Assets/Scripts/Engine/LoadingTasksManager.cs:35)
System.Runtime.CompilerServices.AsyncVoidMethodBuilder:Start(<KickTasks>d__6&)
LoadingTasksManager:KickTasks(IList`1)
<SetAudio>d__51:MoveNext() (at Assets/Scripts/Game/UI/Menus/SongPropertiesPanelController.cs:410)
UnityEngine.MonoBehaviour:StartCoroutine(IEnumerator)
SongPropertiesPanelController:LoadInstrumentAudioFromPath(AudioInstrument, String) (at Assets/Scripts/Game/UI/Menus/SongPropertiesPanelController.cs:332)
SongPropertiesPanelController:LoadCloneHeroAudioFromDirectory() (at Assets/Scripts/Game/UI/Menus/SongPropertiesPanelController.cs:366)
UnityEngine.EventSystems.EventSystem:Update() (at C:/buildslave/unity/build/Extensions/guisystem/UnityEngine.UI/EventSystem/EventSystem.cs:377)

Fix requested.

FireFox2000000 · 2024-04-06T02:32:50Z

+        var currentDir = ChartEditor.Instance.lastLoadedFile;
+        if (string.IsNullOrWhiteSpace(currentDir))
+        {
+            FileExplorer.OpenFolderPanel(out currentDir);


This needs to handle the case of the user cancelling the open folder panel prompt. This should early return upon FileExplorer.OpenFolderPanel returning false.

chowell1337 and others added 5 commits August 13, 2023 11:57

adding detect files button

9ca3b00

using ALL valid file exts, not just ogg

d1eae19

Merge remote-tracking branch 'origin/master' into yeetmeistergeneral-…

65bd165

…add-detect-files

Merge branch 'FireFox2000000:master' into yeetmeistergeneral-add-dete…

570f09c

…ct-files

Merge branch 'FireFox2000000:master' into yeetmeistergeneral-add-dete…

5decb16

…ct-files

FireFox2000000 reviewed Nov 30, 2023

View reviewed changes

chowell1337 and others added 6 commits December 1, 2023 09:35

Merge branch 'FireFox2000000:master' into yeetmeistergeneral-add-dete…

e2044c0

…ct-files

adding invalid filename message

61218e5

auto-detecting directory to detect in

fd986a3

adding accepted file exts to err msg

406d24f

showing folder panel if no lastloadedfile

910c81f

using dict for filename/instrument map

e4079ab

FireFox2000000 requested changes Dec 10, 2023

View reviewed changes

chowell1337 added 2 commits December 11, 2023 10:07

improving variable/method names

a1e3306

improving btn displays

8380aa8

FireFox2000000 reviewed Dec 31, 2023

View reviewed changes

FireFox2000000 requested changes Apr 6, 2024

View reviewed changes

Conversation

chowell1337 commented Aug 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

FireFox2000000 Nov 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chowell1337 Dec 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chowell1337 Dec 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FireFox2000000 Dec 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

FireFox2000000 commented Dec 31, 2023

Uh oh!

FireFox2000000 commented Apr 6, 2024

Uh oh!

FireFox2000000 commented Apr 6, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

chowell1337 commented Aug 19, 2023 •

edited

Loading

FireFox2000000 Nov 30, 2023 •

edited

Loading

chowell1337 Dec 1, 2023 •

edited

Loading

chowell1337 Dec 1, 2023 •

edited

Loading

FireFox2000000 Dec 10, 2023 •

edited

Loading