Merge pull request #1 from SpaceBuddy231/improve-welcome-message-6318945189728686045

Improve WelcomeMessage Plugin with Hints, Delay, and Random Messages

Author: SpaceBuddy231

SB_WelcomeMessage/Config.cs

@@ -1,16 +1,26 @@
-using System.ComponentModel;
-
-namespace SB_WelcomeMessage
-{
-    public class Config
-    {
-        [Description("just de/activates the plugin")]
-        public bool wlcAct { get; set; } = true;
-
-        [Description("Join message delay")]
-        public int JoinMessageDelay { get; set; } = 5;
-        
-        [Description("Join Message Text ({name} specifies the name of the joining player). For Rich Text Editing you can use this Guide -> https://sites.google.com/view/scpsl-config/unity-rich-text")]
-        public string JoinMessage { get; set; } = "<b><color=#E8002A>Welcome on the YOUR COMMUNITY NAME Community</color>,</b> <i><color=#EB0079>{name}</color></i><b>!</b>";
-    }
-}
+using System.Collections.Generic;
+using System.ComponentModel;
+
+namespace SB_WelcomeMessage
+{
+    public class Config
+    {
+        [Description("Is the plugin enabled?")]
+        public bool IsEnabled { get; set; } = true;
+
+        [Description("Delay in seconds before sending the message after the player joins.")]
+        public float Delay { get; set; } = 2.0f;
+
+        [Description("Duration in seconds for the message to be displayed.")]
+        public ushort Duration { get; set; } = 5;
+
+        [Description("If true, sends a Hint instead of a Broadcast.")]
+        public bool UseHint { get; set; } = false;
+
+        [Description("List of Join Messages. One is chosen randomly. ({name} = player name, {userId} = player UserID). For Rich Text Editing see: https://sites.google.com/view/scpsl-config/unity-rich-text")]
+        public List<string> JoinMessages { get; set; } = new List<string>
+        {
+            "<b><color=#E8002A>Welcome to the YOUR COMMUNITY NAME Community</color>,</b> <i><color=#EB0079>{name}</color></i><b>!</b>"
+        };
+    }
+}

SB_WelcomeMessage/Plugin.cs

@@ -1,38 +1,55 @@
-using PluginAPI.Core;
-using PluginAPI.Core.Attributes;
-using PluginAPI.Enums;
-using FormatWith;
-
-namespace SB_WelcomeMessage
-{
-    public class Plugin
-    {
-        public static Plugin Singleton;
-
-        [PluginConfig] public Config Config;
-
-        public const string Version = "1.0.0";
-
-        [PluginPriority(LoadPriority.Highest)]
-        [PluginEntryPoint("JoinMessage-System", Version, "Shows a Broadcast Message in the top of the Screen of the joining player.", "SpaceBuddy")]
-        void LoadPlugin()
-        {
-            Singleton = this;
-            PluginAPI.Events.EventManager.RegisterEvents(this);
-        }
-
-        [PluginEvent(ServerEventType.PlayerJoined)]
-
-        public void OnPlayerJoin(Player player)
-        {
-            if (Config.wlcAct)
-            {
-                string JoinText = Config.JoinMessage.FormatWith(new
-                {
-                    name = player.Nickname
-                });
-                player.SendBroadcast(JoinText, (ushort)Config.JoinMessageDelay);
-            }
-        }
-    }
-}
+using PluginAPI.Core;
+using PluginAPI.Core.Attributes;
+using PluginAPI.Enums;
+using FormatWith;
+using MEC;
+
+namespace SB_WelcomeMessage
+{
+    public class Plugin
+    {
+        public static Plugin Singleton;
+
+        [PluginConfig] public Config Config;
+
+        public const string Version = "1.1.0";
+
+        [PluginPriority(LoadPriority.Highest)]
+        [PluginEntryPoint("JoinMessage-System", Version, "Shows a Broadcast Message or Hint in the top/bottom of the Screen of the joining player.", "SpaceBuddy")]
+        void LoadPlugin()
+        {
+            Singleton = this;
+            PluginAPI.Events.EventManager.RegisterEvents(this);
+        }
+
+        [PluginEvent(ServerEventType.PlayerJoined)]
+        public void OnPlayerJoin(Player player)
+        {
+            if (!Config.IsEnabled || Config.JoinMessages == null || Config.JoinMessages.Count == 0)
+                return;
+
+            Timing.CallDelayed(Config.Delay, () =>
+            {
+                // Verify player still exists and is connected
+                if (player == null || !player.GameObject) return;
+
+                string rawMessage = Config.JoinMessages[UnityEngine.Random.Range(0, Config.JoinMessages.Count)];
+
+                string joinText = rawMessage.FormatWith(new
+                {
+                    name = player.Nickname,
+                    userId = player.UserId
+                });
+
+                if (Config.UseHint)
+                {
+                    player.ReceiveHint(joinText, Config.Duration);
+                }
+                else
+                {
+                    player.SendBroadcast(joinText, Config.Duration);
+                }
+            });
+        }
+    }
+}