improve example scripts and surrounding system

Author: Elektryk-Andrzej

Code/FileSystem/FileSystem.cs

@@ -108,6 +108,13 @@ public static void GenerateExamples()
         {
             var path = Path.Combine(exampleDir.FullName, $"{kvp.Key}.ser");
             if (File.Exists(path)) continue;
+            
+            string? directory = Path.GetDirectoryName(path);
+            if (!string.IsNullOrEmpty(directory))
+            {
+                Directory.CreateDirectory(directory);
+            }
+            
             using var sw = File.CreateText(path);
             sw.Write(kvp.Value);
         }

Code/Helpers/ExampleHandler.cs

@@ -1,4 +1,5 @@
 using System.Reflection;
+using SER.Code.Extensions;
 using SER.Code.Helpers.ResultSystem;
 using SER.Code.ScriptSystem;
 
@@ -7,50 +8,70 @@ namespace SER.Code.Helpers;
 public static class ExampleHandler
 {
     private static Dictionary<string, string>? _cachedExamples;
+    private const string RootFolder = "Example_Scripts";
 
-    [UsedImplicitly]
     public static Dictionary<string, string> GetAllExamples()
     {
         if (_cachedExamples != null) return _cachedExamples;
-        
+
         var assembly = Assembly.GetExecutingAssembly();
+        // Look for resources that contain our root folder and end with .ser
         var resourceNames = assembly.GetManifestResourceNames()
-            .Where(n => n.EndsWith(".ser"));
+            .Where(n => n.Contains(RootFolder) && n.EndsWith(".ser"));
 
         var examples = new Dictionary<string, string>();
         foreach (var name in resourceNames)
         {
             using var stream = assembly.GetManifestResourceStream(name);
             if (stream == null) continue;
+            
             using var reader = new StreamReader(stream);
             string content = reader.ReadToEnd();
-            string[] parts = name.Split('.');
-            if (parts.Length < 2) continue;
-            string fileName = parts[^2];
-            examples[fileName] = content;
+            
+            string relativePath = GetRelativePath(name);
+            examples[relativePath] = content;
         }
 
         return _cachedExamples = examples;
     }
 
-    public static string? GetExample(string name)
+    private static string GetRelativePath(string resourceName)
+    {
+        // 1. Find where the "Example Scripts" folder starts in the namespace string
+        int rootIndex = resourceName.IndexOf(RootFolder, StringComparison.InvariantCulture);
+        if (rootIndex == -1) return resourceName;
+
+        // 2. Get everything after "Example Scripts."
+        string pathWithExtension = resourceName[(rootIndex + RootFolder.Length + 1)..];
+
+        // 3. Remove the .ser extension
+        int lastDot = pathWithExtension.LastIndexOf(".ser", StringComparison.InvariantCulture);
+        string pathWithoutExtension = pathWithExtension[..lastDot];
+
+        // 4. Convert dots to directory separators (optional, but cleaner for "folders")
+        // e.g., "UI.Inventory" instead of "UI/Inventory" if you prefer keeping it as a key
+        return pathWithoutExtension.Replace('.', '/');
+    }
+
+    public static string? GetExample(string path)
     {
-        return GetAllExamples().TryGetValue(name, out var content) ? content : null;
+        return GetAllExamples().TryGetValue(path, out var content) ? content : null;
     }
 
     [UsedImplicitly]
-    public static string Verify()
+    public static (string?, string[]) Verify()
     {
         var examples = GetAllExamples();
 
         foreach (var example in examples)
         {
+            // example.Key now contains the folder path (e.g., "Combat/Fireball")
             if (Script.CreateAnonymous(example.Key, example.Value).Compile().HasErrored(out var error))
             {
-                return new Result(false, $"in example '{example.Key}'") + error;
+                return (new Result(false, $"in example '{example.Key}'") + error.AsError(), examples.Keys.ToArray());
             }
         }
 
-        return string.Empty;
+        return (null, examples.Keys.ToArray());
     }
 }

Example Scripts/anonymousRadio.ser

@@ -1,3 +1,5 @@
+# this script makes the name into ??? when talking on the radio
+
 !-- OnEvent Joined
 -- require @evPlayer
 

Example Scripts/breach.ser

@@ -1,3 +1,5 @@
+# this script adds a fully functioning coin with custom behaviors
+
 !-- OnEvent FlippingCoin
 
 # formats of broadcasts, used to not repeat the same things in different broadcasts
@@ -25,10 +27,10 @@ end
 # select a random effect of the coin, from 9 available
 $effect = Random 1 9 int
 
-# russian rulette with a full gun :trollface:
+# russian roulette with a full gun :trollface:
 if $effect is 1
     GiveItem @evPlayer GunRevolver
-    Broadcast @evPlayer 5s "{$baseText}Let's play russian rulette!"
+    Broadcast @evPlayer 5s "{$baseText}Let's play russian roulette!"
     stop
 end
 
@@ -47,7 +49,7 @@ if $effect is 3
     *room = @evPlayer -> roomRef
 
     # explode player if he isnt in a room
-    if {*room -> isInvalid}
+    if *room is invalid
         Explode @evPlayer
         stop
     end
@@ -63,11 +65,11 @@ if $effect is 3
     SetLightColor *room #000000
 
     repeat 5
-        TransitionLightColor *room #ff0000ff .5s
+        SetLightColor *room #ff0000 _ .5s
         wait .5s
-        TransitionLightColor *room #00ff00ff .5s
+        SetLightColor *room #00ff00 _ .5s
         wait .5s
-        TransitionLightColor *room #0000ffff .5s
+        SetLightColor *room #0000ff _ .5s
         wait .5s
     end
 

Example Scripts/chaosCoin.ser

@@ -0,0 +1,8 @@
+# when a player with any custom role is spawned, 
+# this will tell the player the role he has
+
+!-- OnCRole spawned
+
+wait 6s
+
+AnimatedBroadcast @evPlayer 10s "Your custom role is:<br><br><br><size=60><b><wait=2s><charwait=300ms>{@evCRole -> displayName}"

Example Scripts/custom roles/genericOnSpawned.ser

@@ -0,0 +1,8 @@
+# registers the janitor custom role 
+# when the server is ready to accept players
+
+!-- OnEvent WaitingForPlayers
+
+*spawnSystem = CRole.CreateChanceSpawnSystem ClassD 20%
+CRole.Register janitor "LCZ Janitor" ClassD *spawnSystem
+

Example Scripts/custom roles/janitor.ser

@@ -0,0 +1,5 @@
+!-- OnCRole spawned
+-- forRoles janitor
+
+TPRoom @evPlayer LczToilets
+GiveItem @evCRole KeycardJanitor

Example Scripts/custom roles/janitorOnSpawned.ser

@@ -0,0 +1,13 @@
+# registers the senior guard custom role 
+# when the server is ready to accept players
+
+!-- OnEvent WaitingForPlayers
+
+# CRole.CreateProceduralSpawnSystem arguments
+# 1) role to replace
+# 2) per-player spawn chance
+# 3) conversion limit
+# 4) minimum required players
+*spawnSystem = CRole.CreateProceduralSpawnSystem FacilityGuard 70% 1 3
+
+CRole.Register senior_guard "Senior Guard" FacilityGuard *spawnSystem

Example Scripts/custom roles/seniorGuard.ser

@@ -0,0 +1,11 @@
+!-- OnCRole spawned
+-- forRoles senior_guard
+
+ClearInventory @evPlayer
+GiveItem @evPlayer KeycardMTFPrivate
+GiveItem @evPlayer Radio
+GiveItem @evPlayer Medkit
+GiveItem @evPlayer GrenadeHE
+GiveItem @evPlayer Ammo9x19 3
+GiveItem @evPlayer ArmorCombat
+GiveItem @evPlayer GunFSP9