Refactor internals of CelesteTAS

.editorconfig

@@ -118,12 +118,28 @@ csharp_style_prefer_readonly_struct = true
 csharp_style_prefer_readonly_struct_member = true
 
 # Code-block preferences
-csharp_prefer_braces = false:silent
+csharp_prefer_braces = true:suggestion
 csharp_prefer_simple_using_statement = true
 csharp_style_namespace_declarations = file_scoped
 csharp_style_prefer_method_group_conversion = true
 csharp_style_prefer_primary_constructors = true
 csharp_style_prefer_top_level_statements = true
+resharper_braces_for_ifelse = required
+resharper_braces_for_dowhile = required
+resharper_braces_for_fixed = required
+resharper_braces_for_for = required
+resharper_braces_for_foreach = required
+resharper_braces_for_lock = required
+resharper_braces_for_using = required
+resharper_braces_for_while = required
+resharper_enforce_if_statement_braces_highlighting = suggestion
+resharper_enforce_dowhile_statement_braces_highlighting = required
+resharper_enforce_fixed_statement_braces_highlighting = required
+resharper_enforce_for_statement_braces_highlighting = required
+resharper_enforce_foreach_statement_braces_highlighting = required
+resharper_enforce_lock_statement_braces_highlighting = required
+resharper_enforce_using_statement_braces_highlighting = required
+resharper_enforce_while_statement_braces_highlighting = required
 
 # Expression-level preferences
 csharp_prefer_simple_default_expression = true

.github/workflows/Build.CelesteStudio.yml

@@ -20,7 +20,7 @@ jobs:
       - name: Setup .NET
         uses: actions/setup-dotnet@v4
         with:
-          dotnet-version: '8.0'
+          dotnet-version: '9.0'
 
       - name: Set version suffix (release)
         run: sed -i "s/-dev//" Studio/CelesteStudio/Studio.cs
@@ -69,7 +69,7 @@ jobs:
       - name: Setup .NET
         uses: actions/setup-dotnet@v4
         with:
-          dotnet-version: '8.0'
+          dotnet-version: '9.0'
 
       - name: Set version suffix (release)
         run: sed -i "s/-dev//" Studio/CelesteStudio/Studio.cs
@@ -118,7 +118,7 @@ jobs:
       - name: Setup .NET
         uses: actions/setup-dotnet@v4
         with:
-          dotnet-version: '8.0'
+          dotnet-version: '9.0'
       - name: Install macOS workflow
         run: dotnet workload install macos
       - name: Switch XCode

.github/workflows/Build.yml

@@ -39,7 +39,7 @@ jobs:
       - name: Setup .NET
         uses: actions/setup-dotnet@v4
         with:
-          dotnet-version: '8.0'
+          dotnet-version: '9.0'
 
       - name: Download Studio builds
         uses: actions/download-artifact@v4

.github/workflows/Release.yml

@@ -74,7 +74,7 @@ jobs:
       - name: Setup .NET
         uses: actions/setup-dotnet@v4
         with:
-          dotnet-version: '8.0'
+          dotnet-version: '9.0'
       - name: Setup Python
         uses: actions/[email protected]
         with:

CelesteTAS-EverestInterop/CelesteTAS-EverestInterop.csproj

@@ -5,6 +5,7 @@
         <RootNamespace>TAS</RootNamespace>
         <TargetFramework>net7.0</TargetFramework>
         <LangVersion>latest</LangVersion>
+        <Nullable>enable</Nullable>
 
         <CelestePrefix Condition="'$(CelestePrefix)' == '' And Exists('../../../Celeste.dll')">../../..</CelestePrefix>
         <CelestePrefix Condition="'$(CelestePrefix)' == ''">lib-stripped</CelestePrefix>
@@ -28,21 +29,24 @@
 
     <ItemGroup>
         <Reference Include="$(CelestePrefix)\Celeste.dll" Publicize="true" />
-        <Reference Include="$(CelestePrefix)\FNA.dll" />
+        <Reference Include="$(CelestePrefix)\FNA.dll" Publicize="true" />
         <Reference Include="$(CelestePrefix)\MMHOOK_Celeste.dll" />
 
         <Reference Include="lib-stripped\SpeedrunTool.dll" />
         <Reference Include="lib-stripped\TASRecorder.dll" />
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="MonoMod.RuntimeDetour" Version="22.01.04.03" />
+        <PackageReference Include="CelesteAnalyzer" Version="*" />
+
+        <PackageReference Include="MonoMod.RuntimeDetour" Version="25.0.2" />
         <PackageReference Include="BepInEx.AssemblyPublicizer.MSBuild" Version="0.4.1" PrivateAssets="all" />
 
         <PackageReference Include="SharpZipLib" Version="1.4.2" IncludeAssets="all" />
         <PackageReference Include="YamlDotNet" Version="13.1.1" />
 
-        <PackageReference Include="JetBrains.Profiler.Api" Version="1.1.8" Condition="'$(Configuration)' == 'Debug'" />
+        <PackageReference Include="JetBrains.Annotations" Version="2024.2.0" />
+        <PackageReference Include="JetBrains.Profiler.Api" Version="1.4.6" Condition="'$(Configuration)' == 'Debug'" />
     </ItemGroup>
 
     <!-- Assemblies -->
@@ -54,18 +58,22 @@
 
         <Copy SourceFiles="$(OutputPath)ICSharpCode.SharpZipLib.dll" DestinationFolder="..\bin" />
         <Copy SourceFiles="$(OutputPath)MemoryPack.Core.dll" DestinationFolder="..\bin" />
+
         <Copy SourceFiles="$(OutputPath)JetBrains.Profiler.Api.dll" DestinationFolder="..\bin" Condition="'$(Configuration)' == 'Debug'" />
+        <Copy SourceFiles="$(OutputPath)JetBrains.HabitatDetector.dll" DestinationFolder="..\bin" Condition="'$(Configuration)' == 'Debug'" />
+        <Copy SourceFiles="$(OutputPath)JetBrains.FormatRipper.dll" DestinationFolder="..\bin" Condition="'$(Configuration)' == 'Debug'" />
     </Target>
 
-    <!-- Assets (use symlinks in debug builds on POSIX, since MSBuild is useless) -->
+    <!-- Assets (use symlinks in debug builds - only on UNIX, since MSBuild is useless) -->
     <Target Name="LinkAssets" AfterTargets="Build" Condition="'$(Configuration)' == 'Debug' and '$(OS)' == 'Unix' and $(UseSymlinks) != false">
         <Copy SourceFiles="" DestinationFiles="..\bin\env.lua" UseSymboliclinksIfPossible="true" />
 
-        <Exec Command="rm -rf ../bin/env.lua &amp;&amp; ln -s CelesteTAS-EverestInterop/Source/EverestInterop/Lua/env.lua ../bin/env.lua"/>
+        <Exec Command="rm -rf ../bin/env.lua &amp;&amp; ln -s ../CelesteTAS-EverestInterop/Source/EverestInterop/Lua/env.lua ../bin/env.lua"/>
 
-        <Exec Command="rm -rf ../everest.yaml &amp;&amp; ln -s CelesteTAS-EverestInterop/everest.yaml ../everest.yaml"/>
-        <Exec Command="rm -rf ../Dialog &amp;&amp; ln -s CelesteTAS-EverestInterop/Dialog ../Dialog"/>
-        <Exec Command="rm -rf ../Graphics &amp;&amp; ln -s CelesteTAS-EverestInterop/Graphics ../Graphics"/>
+        <!-- Replace with symlinks if they aren't already -->
+        <Exec Command="if [ ! -L ../everest.yaml ]; then rm -rf ../everest.yaml &amp;&amp; ln -s CelesteTAS-EverestInterop/everest.yaml ../everest.yaml; fi"/>
+        <Exec Command="if [ ! -L ../Dialog ]; then rm -rf ../Dialog &amp;&amp; ln -s CelesteTAS-EverestInterop/Dialog ../Dialog; fi"/>
+        <Exec Command="if [ ! -L ../Graphics ]; then rm -rf ../Graphics &amp;&amp; ln -s CelesteTAS-EverestInterop/Graphics ../Graphics; fi"/>
     </Target>
     <Target Name="CopyAssets" AfterTargets="Build" Condition="'$(Configuration)' != 'Debug' or '$(OS)' != 'Unix' or $(UseSymlinks) == false">
         <ItemGroup>

CelesteTAS-EverestInterop/Dialog/English.txt

@@ -103,6 +103,11 @@ TAS_RESTORE_SETTINGS=                Restore All Settings when TAS Stop
 TAS_LAUNCH_STUDIO_AT_BOOT=           Launch Studio at Boot
 TAS_ATTEMPT_TO_CONNECT_TO_STUDIO=    Attempt To Connect To Studio
 TAS_SHOW_STUDIO_UPDATE_BANNER=       Show Studio Update Banner
+TAS_OPEN_CONSOLE_IN_TAS=             Allow Opening Console in TAS
+TAS_SCROLLABLE_HISTORY_LOG=          Scrollable Console History Log
+TAS_BETTER_INVINCIBILITY=            Better Invincibility
+TAS_BETTER_INVINCIBLE_DESCRIPTION=   Running "Set Invincible true" will still prevent dying, but avoids gameplay changes like bouncing of the death plane,{n}
+                                     to avoid accidentally desyncing the TAS. Applies only while a TAS is active.
 TAS_HIDE_FREEZE_FRAMES=              Hide Freeze Frames during TAS
 TAS_HIDE_FREEZE_FRAMES_DESCRIPTION_1=When a freeze frame is encountered, run it and continue to the next frame
 TAS_HIDE_FREEZE_FRAMES_DESCRIPTION_2=before rendering. Applies only while a TAS is active.

CelesteTAS-EverestInterop/Dialog/Simplified Chinese.txt

@@ -101,6 +101,11 @@ TAS_CENTER_CAMERA_HORIZONTALLY_ONLY= 镜头只水平居中
 TAS_RESTORE_SETTINGS=                TAS 停止时恢复所有设置
 TAS_LAUNCH_STUDIO_AT_BOOT=           启动游戏时打开 Studio
 TAS_ATTEMPT_TO_CONNECT_TO_STUDIO=    尝试连接 Studio
+TAS_OPEN_CONSOLE_IN_TAS=             允许在 TAS 中打开控制台
+TAS_SCROLLABLE_HISTORY_LOG=          可滚动的控制台历史记录
+TAS_BETTER_INVINCIBILITY=            更好的无敌
+TAS_BETTER_INVINCIBLE_DESCRIPTION=   运行 "Set Invincible true" 既会阻止死亡, 同时也会避免例如在掉落致死时自动弹跳的游戏物理变化,{n}
+                                     从而避免 TAS 意外 desync. 仅在 TAS 运行期间生效.
 TAS_HIDE_FREEZE_FRAMES=              TAS 时跳过冻结帧
 TAS_HIDE_FREEZE_FRAMES_DESCRIPTION_1=运行到冻结帧时自动跳过进入下一帧
 TAS_HIDE_FREEZE_FRAMES_DESCRIPTION_2=仅在 TAS 时启用

CelesteTAS-EverestInterop/Source/Communication/CommunicationAdapterCeleste.cs

@@ -10,13 +10,13 @@
 using StudioCommunication.Util;
 using TAS.EverestInterop;
 using TAS.EverestInterop.InfoHUD;
+using TAS.InfoHUD;
 using TAS.Input;
 using TAS.Input.Commands;
+using TAS.ModInterop;
 using TAS.Module;
 using TAS.Utils;
 
-#nullable enable
-
 namespace TAS.Communication;
 
 public sealed class CommunicationAdapterCeleste() : CommunicationAdapterBase(Location.Celeste) {
@@ -28,7 +28,7 @@ protected override void FullReset() {
     protected override void OnConnectionChanged() {
         if (Connected) {
             // Stall until input initialized to avoid sending invalid hotkey data
-            while (Hotkeys.KeysDict == null) {
+            while (Hotkeys.AllHotkeys == null) {
                 Thread.Sleep(UpdateRate);
             }
 
@@ -44,15 +44,15 @@ protected override void HandleMessage(MessageID messageId, BinaryReader reader)
                 string path = reader.ReadString();
                 LogVerbose($"Received message FilePath: '{path}'");
 
-                InputController.StudioTasFilePath = path;
+                Manager.AddMainThreadAction(() => Manager.Controller.FilePath = path);
                 break;
 
             case MessageID.Hotkey:
                 var hotkey = (HotkeyID)reader.ReadByte();
                 bool released = reader.ReadBoolean();
                 LogVerbose($"Received message Hotkey: {hotkey} ({(released ? "released" : "pressed")})");
 
-                Hotkeys.KeysDict[hotkey].OverrideCheck = !released;
+                Hotkeys.AllHotkeys[hotkey].OverrideCheck = !released;
                 break;
 
             case MessageID.SetCustomInfoTemplate:
@@ -82,7 +82,6 @@ protected override void HandleMessage(MessageID messageId, BinaryReader reader)
                 object? arg = gameDataType switch {
                     GameDataType.ConsoleCommand => reader.ReadBoolean(),
                     GameDataType.SettingValue => reader.ReadString(),
-                    GameDataType.RawInfo => reader.ReadObject<(string, bool)>(),
                     GameDataType.CommandHash => reader.ReadObject<(string, string[], string, int)>(),
                     _ => null,
                 };
@@ -114,9 +113,6 @@ protected override void HandleMessage(MessageID messageId, BinaryReader reader)
                             case GameDataType.CustomInfoTemplate:
                                 gameData = !string.IsNullOrWhiteSpace(TasSettings.InfoCustomTemplate) ? TasSettings.InfoCustomTemplate : string.Empty;
                                 break;
-                            case GameDataType.RawInfo:
-                                gameData = InfoCustom.GetRawInfo(((string, bool))arg!);
-                                break;
                             case GameDataType.GameState:
                                 gameData = GameData.GetGameState();
                                 break;
@@ -158,18 +154,14 @@ protected override void HandleMessage(MessageID messageId, BinaryReader reader)
                                     writer.Write((string?)gameData ?? string.Empty);
                                     break;
 
-                                case GameDataType.RawInfo:
-                                    writer.WriteObject(gameData);
-                                    break;
-
                                 case GameDataType.GameState:
                                     writer.WriteObject((GameState?)gameData);
                                     break;
 
                                 case GameDataType.CommandHash:
                                     writer.Write((int)gameData!);
                                     break;
-                                
+
                                 case GameDataType.LevelInfo:
                                     writer.WriteObject((LevelInfo)gameData!);
                                     break;
@@ -317,42 +309,45 @@ public void WriteCommandList(CommandInfo[] commands) {
     }
 
     private void ProcessRecordTAS(string fileName) {
-        if (!TASRecorderUtils.Installed) {
+        if (!TASRecorderInterop.Installed) {
             WriteRecordingFailed(RecordingFailedReason.TASRecorderNotInstalled);
             return;
         }
-        if (!TASRecorderUtils.FFmpegInstalled) {
+        if (!TASRecorderInterop.FFmpegInstalled) {
             WriteRecordingFailed(RecordingFailedReason.FFmpegNotInstalled);
             return;
         }
 
-        Manager.Controller.RefreshInputs(enableRun: true);
-        if (RecordingCommand.RecordingTimes.IsNotEmpty()) {
-            AbortTas("Can't use StartRecording/StopRecording with \"Record TAS\"");
-            return;
-        }
-        Manager.NextStates |= States.Enable;
+        Manager.AddMainThreadAction(() => {
+            Manager.Controller.RefreshInputs();
+            if (RecordingCommand.RecordingTimes.IsNotEmpty()) {
+                AbortTas("Can't use StartRecording/StopRecording with \"Record TAS\"");
+                return;
+            }
+            Manager.EnableRun();
 
-        int totalFrames = Manager.Controller.Inputs.Count;
-        if (totalFrames <= 0) return;
+            int totalFrames = Manager.Controller.Inputs.Count;
+            if (totalFrames <= 0) return;
 
-        TASRecorderUtils.StartRecording(fileName);
-        TASRecorderUtils.SetDurationEstimate(totalFrames);
+            TASRecorderInterop.StartRecording(fileName);
+            TASRecorderInterop.SetDurationEstimate(totalFrames);
 
-        if (!Manager.Controller.Commands.TryGetValue(0, out var commands)) {
-            return;
-        }
-        bool startsWithConsoleLoad = commands.Any(c =>
-            c.Is("Console") &&
-            c.Args.Length >= 1 &&
-            ConsoleCommand.LoadCommandRegex.Match(c.Args[0].ToLower()) is { Success: true });
-
-        if (startsWithConsoleLoad) {
-            // Restart the music when we enter the level
-            Audio.SetMusic(null, startPlaying: false, allowFadeOut: false);
-            Audio.SetAmbience(null, startPlaying: false);
-            Audio.BusStopAll(Buses.GAMEPLAY, immediate: true);
-        }
+            if (!Manager.Controller.Commands.TryGetValue(0, out var commands)) {
+                return;
+            }
+
+            bool startsWithConsoleLoad = commands.Any(c =>
+                c.Attribute.Name.Equals("Console", StringComparison.OrdinalIgnoreCase) &&
+                c.Args.Length >= 1 &&
+                ConsoleCommand.LoadCommandRegex.Match(c.Args[0].ToLower()) is {Success: true});
+
+            if (startsWithConsoleLoad) {
+                // Restart the music when we enter the level
+                Audio.SetMusic(null, startPlaying: false, allowFadeOut: false);
+                Audio.SetAmbience(null, startPlaying: false);
+                Audio.BusStopAll(Buses.GAMEPLAY, immediate: true);
+            }
+        });
     }
 
     protected override void LogInfo(string message) => Logger.Log(LogLevel.Info, "CelesteTAS/StudioCom", message);

CelesteTAS-EverestInterop/Source/Communication/CommunicationWrapper.cs

@@ -71,7 +71,7 @@ public static void SendCurrentBindings() {
             return;
         }
 
-        Dictionary<int, List<int>> nativeBindings = Hotkeys.KeysInteractWithStudio.ToDictionary(pair => (int) pair.Key, pair => pair.Value.Cast<int>().ToList());
+        Dictionary<int, List<int>> nativeBindings = Hotkeys.StudioHotkeys.ToDictionary(pair => (int) pair.Key, pair => pair.Value.Cast<int>().ToList());
         comm.WriteCurrentBindings(nativeBindings);
     }
     public static void SendRecordingFailed(RecordingFailedReason reason) {

CelesteTAS-EverestInterop/Source/EverestInterop/AreaCompleteInfo.cs

@@ -10,6 +10,7 @@
 using StudioCommunication;
 using TAS.Input;
 using TAS.Input.Commands;
+using TAS.ModInterop;
 using TAS.Module;
 using TAS.Utils;
 using Comment = TAS.Input.Comment;
@@ -18,7 +19,7 @@ namespace TAS.EverestInterop;
 
 public static class AreaCompleteInfo {
     private class Meta : ITasCommandMeta {
-        public string Insert => $"CompleteInfo{CommandInfo.Separator}[0;A 1]";
+        public string Insert => $"CompleteInfo{CommandInfo.Separator}[0;A{CommandInfo.Separator}1]";
         public bool HasArguments => true;
     }
 
@@ -176,25 +177,20 @@ private static void CompleteInfoCommand(CommandLine commandLine, int studioLine,
             key = new AreaKey(id, mode).ToString();
         }
 
-        if (!completeInfos.TryGetValue(key, out StringBuilder info)) {
+        if (!completeInfos.TryGetValue(key, out var info)) {
             completeInfos[key] = info = new StringBuilder();
         }
 
         info.Clear();
-        if (Manager.Controller.Comments.TryGetValue(filePath, out List<Comment> comments)) {
+
+        if (Manager.Controller.CurrentComments is { Count: > 0 } comments) {
             bool firstComment = true;
-            foreach (Comment comment in comments.Where(c => c.Line > fileLine)) {
-                if (fileLine + 1 == comment.Line) {
-                    if (!firstComment) {
-                        info.AppendLine();
-                    }
-
-                    firstComment = false;
-                    info.Append($"{comment.Text}");
-                    fileLine++;
-                } else {
-                    break;
+            foreach (var comment in comments) {
+                if (!firstComment) {
+                    info.AppendLine();
                 }
+
+                info.AppendLine(comment.Text);
             }
         }
     }

CelesteTAS-EverestInterop/Source/EverestInterop/AutoMute.cs

@@ -67,8 +67,8 @@ private static readonly IDictionary<WeakReference<EventInstance>, int>
 
     private static bool settingMusic;
     private static bool hasMuted;
-    private static bool ShouldBeMuted => Manager.FrameLoops >= 2 && !settingMusic;
-    private static bool FrameStep => Manager.Running && (Manager.States & States.FrameStep) != 0;
+    private static bool ShouldBeMuted => Manager.PlaybackSpeed >= 2.0f && !settingMusic;
+    private static bool FrameStep => Manager.CurrState == Manager.State.Paused;
     private static WeakReference<EventInstance> dummy;
 
     private static EventInstance DummyEventInstance {
@@ -197,4 +197,4 @@ private static void CelesteOnUpdate(On.Celeste.Celeste.orig_Update orig, Celeste
             }
         }
     }
-}
+}