Merge pull request #2 from SrLicht/13.1-update

* Added a command that allows you to spawn a SCP-575 to chase a specified player for any amount of time you want

* Now the Audios folder is located inside the SCP-575 configuration folder.

* Added a setting to loop the audio until the SCP-575 disappears.

* Added a setting that if the player is running and is in the MediumDistance range, the speed of the 575 will increase.

* Completely changed the way SCP-575 spawns by adding a Dummies API and other changes (you can copy it and use it in your plugins if you want, I don't care)

* Recompiled to run in SCP:SL 13.1

* It is now possible to make it so that if the SCP-575 disappears before the end of the blackout, the blackout will end.

Author: SrLicht-1

Cerberus.props

@@ -16,7 +16,7 @@
 
   <PropertyGroup>
     <!-- This is the global version and is used for all projects that don't have a version -->
-    <Version Condition="$(Version) == ''">1.0.9</Version>
+    <Version Condition="$(Version) == ''">1.1.0</Version>
     <!-- Enables public beta warning via the PUBLIC_BETA constant -->
     <PublicBeta>false</PublicBeta>
 

README.md

@@ -14,6 +14,11 @@ This plugin only works for [NWAPI](https://github.com/northwood-studios/NwPlugin
 
 This plugin uses as dependency [SCPSLAudioApi](https://github.com/CedModV2/SCPSLAudioApi)
 
+# Dependency problem with SCPSLAudioApi
+Because of how NWAPI loads the plugin dependencies if more than one plugin installed uses SCPSLAudioApi it will give error and will not start the server, to solve this you will have to put ``NVorbis.dll`` in the dependencies folder.
+
+**NVorbis.dll is included in a separate .zip file in the latest versions.**
+
 # Sounds
 This plugin allows you to make the SCP-575 play sounds of your choice, the sound files must be placed in the ``%appdata%/SCP Secret Laboratory/PluginAPI/plugins/Scp575Sounds`` folder.
 

SCP575/Command/Scp575Command.cs

@@ -0,0 +1,131 @@
+using CommandSystem;
+using Interactables.Interobjects.DoorUtils;
+using MapGeneration;
+using MEC;
+using PluginAPI.Core;
+using SCP575.Resources;
+using System;
+using System.Linq;
+using UnityEngine;
+using VoiceChat;
+
+namespace SCP575.Command
+{
+    [CommandHandler(typeof(RemoteAdminCommandHandler))]
+    internal class Scp575Command : ICommand, IUsageProvider
+    {
+        public string Command => "scp575";
+
+        public string[] Aliases => new string[] { "575" };
+
+        public string Description => "This command allows you to spawn instances of SCP-575.";
+
+        public string[] Usage { get; } = { "Player ID", "Duration" };
+
+        public bool Execute(ArraySegment<string> arguments, ICommandSender sender, out string response)
+        {
+            if (sender != null)
+            {
+                if (!Round.IsRoundStarted)
+                {
+                    response = Scp575.Instance.Config.CommandResponses.RoundHasNotStarted;
+                    return false;
+                }
+                // Display help response.
+                if (arguments.Count < 1 || arguments.IsEmpty() || arguments.Count > 2)
+                {
+                    var text = string.Format(Scp575.Instance.Config.CommandResponses.HelpResponse, this.DisplayCommandUsage());
+                    response = text;
+                    return false;
+                }
+
+                if (!int.TryParse(arguments.At(0), out int playerId))
+                {
+                    response = string.Format(Scp575.Instance.Config.CommandResponses.InvalidPlayerId, arguments.At(0));
+                    return false;
+                }
+
+                var victim = Player.Get(playerId);
+                if (victim is null)
+                {
+                    response = Scp575.Instance.Config.CommandResponses.PlayerNotFound;
+                    return false;
+                }
+
+                if (!int.TryParse(arguments.At(1), out var duration))
+                {
+                    response = string.Format(Scp575.Instance.Config.CommandResponses.InvalidDuration, arguments.At(1));
+                    return false;
+                }
+
+                SpawnScp575(victim, duration);
+
+                response = string.Format(Scp575.Instance.Config.CommandResponses.Spawning, victim.Nickname, duration);
+                return true;
+            }
+            else
+            {
+                response = "Sender is null";
+                return false;
+            }
+        }
+
+        public void SpawnScp575(Player victim, float duration)
+        {
+            var scp575 = Dummies.CreateDummy("Scp575", "SCP-575");
+
+            scp575.ReferenceHub.nicknameSync.ShownPlayerInfo &= ~PlayerInfoArea.Role;
+
+            scp575.ReferenceHub.nicknameSync.ViewRange = Scp575.Instance.Config.Scp575.ViewRange;
+
+            scp575.Nickname = Scp575.Instance.Config.Scp575.Nickname;
+
+            scp575.Role = Scp575.Instance.Config.Scp575.RoleType;
+
+            scp575.IsGodModeEnabled = true;
+
+            Timing.CallDelayed(0.3f, () =>
+            {
+                var room = victim.Room;
+
+                if (room.Name == RoomName.Lcz173)
+                {
+                    scp575.Position = room.ApiRoom.Position + new Vector3(0f, 13.5f, 0f);
+                }
+                else if (room.Name == RoomName.HczTestroom)
+                {
+                    if (DoorVariant.DoorsByRoom.TryGetValue(room, out var hashSet))
+                    {
+                        var door = hashSet.FirstOrDefault();
+                        if (door != null) scp575.Position = door.transform.position + Vector3.up;
+                    }
+                }
+                else
+                {
+                    scp575.Position = room.ApiRoom.Position + Vector3.up;
+                }
+            });
+
+            var comp = scp575.GameObject.AddComponent<Resources.Components.Scp575Component>();
+            comp.Victim = victim;
+            comp.Destroy(duration);
+
+            if (!Scp575.Instance.Config.Scp575.PlaySounds) return;
+
+            if (!Extensions.AudioFileExist())
+                Log.Error($"There is no .ogg file in the folder {Scp575.Instance.Config.PathToAudios}");
+            scp575.AudioPlayerBase.LogDebug = Scp575.Instance.Config.AudioDebug;
+
+            var audioFile = Extensions.GetRandomAudioFile();
+
+            if (string.IsNullOrEmpty(audioFile))
+            {
+                Log.Error("AudioFile is null audio file no longer exists in the folder or something is broken");
+                return;
+            }
+
+            scp575.PlayAudio(audioFile, channel: VoiceChatChannel.RoundSummary, volume: Scp575.Instance.Config.Scp575.SoundVolume);
+            Log.Debug($"Playing sound {audioFile}", Scp575.Instance.Config.Debug);
+        }
+    }
+}

SCP575/Config.cs

@@ -1,7 +1,9 @@
-using System.Collections.Generic;
-using System.ComponentModel;
 using MapGeneration;
 using PlayerRoles;
+using System.Collections.Generic;
+using System.ComponentModel;
+using System.IO;
+using YamlDotNet.Serialization;
 
 namespace SCP575
 {
@@ -13,6 +15,9 @@ public class Config
         [Description("Enable the Logs.Debug of light points and other logs.")]
         public bool Debug { get; set; } = false;
 
+        [Description("Path to the folder where the audios are located")]
+        public string PathToAudios { get; set; } = Path.Combine(ConfigPath, "Audios");
+
         [Description("Enable the Logs.Debug of SCPSLAudioApi, warning can be very spammy.")]
         public bool AudioDebug { get; set; } = false;
 
@@ -39,16 +44,22 @@ public class Config
 
         [Description("All configuration related to the SCP-575")]
         public Scp575Config Scp575 { get; set; } = new Scp575Config();
+
+        [Description("Here you can translate the responses given by the command when executed, unfortunately due to NWAPI limitations I cannot give a configuration to change the command description.")]
+        public ResponseCommandConfig CommandResponses { get; set; } = new ResponseCommandConfig();
+
+        [YamlIgnore]
+        private static string ConfigPath => Path.Combine(PluginAPI.Helpers.Paths.LocalPlugins.Plugins, "SCP-575");
     }
 
     public class BlackoutConfig
     {
         [Description("After this time, the constant blackouts will begin to be executed.")]
         public float InitialDelay { get; set; } = 300f;
-        
+
         [Description("If this value is true initial_delay will be ignored and a calculation will be made between initial_max_delay and initial_min_delay which will result in the delay")]
         public bool RandomInitialDelay { get; set; } = false;
-        
+
         [Description("The maximum time that the main delay can have")]
         public float InitialMaxDelay { get; set; } = 250f;
 
@@ -67,13 +78,16 @@ public class BlackoutConfig
         [Description("The minimum duration of a delay after a blackout")]
         public int MaxDelay { get; set; } = 400;
 
+        [Description("If the SCP-575 disappears before the duration of the blackout should the blackout end?")]
+        public bool EndBlackoutWhenDisappearing { get; set; } = true;
+
         [Description("Before starting the blackout Cassie will say this message")]
         public string CassieMessage { get; set; } =
             "facility power system failure in 3 . pitch_.80 2 . pitch_.60 1 . pitch_.49 . .g1 pitch_.42  .g2 pitch_.31  .g5";
 
         [Description("I have no idea what it does")]
         public bool CassieIsHold { get; set; } = false;
-        
+
         [Description("Enable o disable bells in cassie announcement")]
         public bool CassieIsNoise { get; set; } = true;
 
@@ -99,6 +113,9 @@ public class BlackoutConfig
 
     public class Scp575Config
     {
+        [Description("Enabling this will activate the patch that prevents the server from making the SCP-575 not float, causing a rather strange movement.  I thought it was fun to leave it as an option")]
+        public bool WeirdMovement { get; set; } = false;
+
         [Description("The name the dummy will have")]
         public string Nickname { get; set; } = "SCP-575-B";
 
@@ -121,6 +138,9 @@ public class Scp575Config
             "Should SCP-575 play the sounds files found in its folder? | The sound file must be .ogg need to be mono channel and have a frequency of 48000 Hz")]
         public bool PlaySounds { get; set; } = false;
 
+        [Description("The audio track replayed by the SCP-575 will loop until it is destroyed.")]
+        public bool AudioIsLooped { get; set; } = false;
+
         [Description("The volume of the sound to be reproduced by the SCP-575, high values violate the VSR.")]
         public float SoundVolume { get; set; } = 85f;
 
@@ -135,8 +155,7 @@ public class Scp575Config
             "The maximum distance that SCP-575 can be from its victim, remember that it must be greater than 16")]
         public float MaxDistance { get; set; } = 28f;
 
-        [Description(
-            "If the distance is equal to or greater than this value, the speed that is movement_speed_fast will be applied to the SCP-575.")]
+        [Description("If the distance is equal to or greater than this value, the speed that is movement_speed_fast will be applied to the SCP-575.")]
         public float MediumDistance { get; set; } = 16f;
 
         [Description(
@@ -155,6 +174,12 @@ public class Scp575Config
             "If the distance between SCP-575 and its victim is equal to or greater than 5, it will have this movement speed")]
         public float MovementSpeed { get; set; } = 22;
 
+        [Description("Enabling this setting if the victim is running and is in the MediumDistance range the 575 will move faster.")]
+        public bool ChangeMovementSpeedIfRun { get; set; } = false;
+
+        [Description("At what speed will the SCP-575 move if the target is running if ChangeMovementSpeedIfRun is false this will not be used.")]
+        public float MovementSpeedRunning { get; set; } = 25;
+
         [Description(
             "This is complicated to explain, so I'll just tell you what I do in the code. If a player has a flashlight on and points it at SCP-575 I fire a ray of light that if it touches SCP-575 adds a point of light, when it reaches a certain point of light SCP-575 disappears. The coroutine that checks these points is executed every 0.1s.")]
         public int LightPoints { get; set; } = 85;
@@ -163,4 +188,19 @@ public class Scp575Config
             "When a player makes SCP-575 disappear using the LightPoints, this message will be sent to the player.")]
         public string LightPointKillMessage { get; set; } = "SCP-575 disappears for now";
     }
+
+    public class ResponseCommandConfig
+    {
+        public string RoundHasNotStarted { get; set; } = "You cannot use this command if the round has not started.";
+
+        public string InvalidPlayerId { get; set; } = "{0} is not an valid player id";
+        public string PlayerNotFound { get; set; } = "Player not found";
+
+        public string InvalidDuration { get; set; } = "{0} is not an valid duration";
+
+        public string Spawning { get; set; } = "Spawning a SCP-575 to hunt {0} for {1} seconds";
+
+        [YamlMember(ScalarStyle = YamlDotNet.Core.ScalarStyle.DoubleQuoted)]
+        public string HelpResponse { get; set; } = "Correct use of the command {0}\nPlayer ID | It is a numerical ID that changes with each new round and each time someone connects to the server again.\nDuration | The time (in seconds) that the SCP-575 will hunt someone\n\nNote that this command does not turn off the lights, so if the SCP-575 is in a lit room for more than 5 seconds it will disappear.";
+    }
 }

SCP575/Patch/AvoidCentralServers.cs SCP575/Patches/AvoidCentralServers.csSCP575/Patch/AvoidCentralServers.cs renamed to SCP575/Patches/AvoidCentralServers.cs

@@ -1,7 +1,8 @@
-using System.Collections.Generic;
-using System.Reflection.Emit;
 using HarmonyLib;
 using NorthwoodLib.Pools;
+using SCP575.Resources;
+using System.Collections.Generic;
+using System.Reflection.Emit;
 
 namespace SCP575.Patch
 {
@@ -22,12 +23,12 @@ private static IEnumerable<CodeInstruction> Transpiler(IEnumerable<CodeInstructi
 
             newInstructions.InsertRange(0, new List<CodeInstruction>()
             {
-                new(OpCodes.Ldsfld, AccessTools.Field(typeof(Scp575), nameof(Scp575.Dummies))),
+                new(OpCodes.Ldsfld, AccessTools.Field(typeof(Dummies), nameof(Dummies.AllDummies))),
                 new(OpCodes.Ldarg_0),
                 new(OpCodes.Ldfld,
                     AccessTools.Field(typeof(CharacterClassManager), nameof(CharacterClassManager._hub))),
                 new(OpCodes.Callvirt,
-                    AccessTools.Method(typeof(List<ReferenceHub>), nameof(List<ReferenceHub>.Contains))),
+                    AccessTools.Method(typeof(HashSet<ReferenceHub>), nameof(HashSet<ReferenceHub>.Contains))),
                 new(OpCodes.Brfalse_S, skip),
                 new(OpCodes.Ldc_I4_2),
                 new(OpCodes.Starg_S, 1),

SCP575/Patch/DummyRotationPatch.cs SCP575/Patches/DummyRotationPatch.csSCP575/Patch/DummyRotationPatch.cs renamed to SCP575/Patches/DummyRotationPatch.cs

@@ -1,9 +1,9 @@
-using System.Collections.Generic;
-using System.Reflection.Emit;
 using HarmonyLib;
 using NorthwoodLib.Pools;
 using PlayerRoles.FirstPersonControl;
 using SCP575.Resources;
+using System.Collections.Generic;
+using System.Reflection.Emit;
 
 namespace SCP575.Patch
 {

SCP575/Patches/InstanceModeSetterPatch.cs

@@ -0,0 +1,9 @@
+namespace SCP575.Patch
+{
+    /*[HarmonyPatch(typeof(CharacterClassManager), nameof(CharacterClassManager.InstanceMode), MethodType.Setter)]
+    public class InstanceModeSetterPatch
+    {
+        public static bool Prefix(CharacterClassManager __instance)
+            => !Extensions.IsDummy(__instance._hub);
+    }*/
+}

SCP575/Patches/UpdateFloatingPatch.cs

@@ -0,0 +1,20 @@
+using HarmonyLib;
+using PlayerRoles.FirstPersonControl;
+using SCP575.Resources;
+
+namespace SCP575.Patch
+{
+    [HarmonyPatch(typeof(FpcMotor), nameof(FpcMotor.UpdateFloating))]
+    public class UpdateFloating
+    {
+        public static bool Prefix(FpcMotor __instance)
+        {
+            if (Scp575.Instance.Config.Scp575.WeirdMovement && Extensions.IsDummy(__instance.Hub))
+            {
+                return false;
+            }
+
+            return true;
+        }
+    }
+}