feat: Add C# scripting support

- Added Roslyn to the project. - Added an example of parsing game logic settings from a .csx file. - Converted extended NPC facilities into scripting .csx files for each NPC.
sebastian-heinz · Dec 20, 2024 · 0448cc8 · 0448cc8
1 parent a0b4c4d
commit 0448cc8
Show file tree

Hide file tree

Showing 15 changed files with 411 additions and 238 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -9,7 +9,7 @@ root = true
 indent_style = space
 
 # Code files
-[*.{cs,sql,json}]
+[*.{cs,sql,json,csx}]
 indent_size = 4
 insert_final_newline = true
 charset = utf-8
diff --git a/Arrowgene.Ddon.Cli/Command/ServerCommand.cs b/Arrowgene.Ddon.Cli/Command/ServerCommand.cs
@@ -5,6 +5,7 @@
 using System.Threading;
 using Arrowgene.Ddon.Database;
 using Arrowgene.Ddon.GameServer;
+using Arrowgene.Ddon.GameServer.Scripting;
 using Arrowgene.Ddon.LoginServer;
 using Arrowgene.Ddon.Rpc.Web;
 using Arrowgene.Ddon.Shared;

diff --git a/Arrowgene.Ddon.Cli/Program.cs b/Arrowgene.Ddon.Cli/Program.cs
@@ -26,6 +26,7 @@
 using System.Text;
 using System.Threading;
 using Arrowgene.Ddon.Cli.Command;
+using Arrowgene.Ddon.GameServer.Scripting;
 using Arrowgene.Ddon.Shared;
 using Arrowgene.Ddon.Shared.Network;
 using Arrowgene.Logging;

diff --git a/Arrowgene.Ddon.GameServer/DdonGameServer.cs b/Arrowgene.Ddon.GameServer/DdonGameServer.cs
@@ -29,6 +29,7 @@
 using Arrowgene.Ddon.GameServer.Dump;
 using Arrowgene.Ddon.GameServer.Handler;
 using Arrowgene.Ddon.GameServer.Party;
+using Arrowgene.Ddon.GameServer.Scripting;
 using Arrowgene.Ddon.GameServer.Shop;
 using Arrowgene.Ddon.Server;
 using Arrowgene.Ddon.Server.Handler;
@@ -52,7 +53,12 @@ public class DdonGameServer : DdonServer<GameClient>
         public DdonGameServer(GameServerSetting setting, IDatabase database, AssetRepository assetRepository)
             : base(ServerType.Game, setting.ServerSetting, database, assetRepository)
         {
+            // This must be first
             Setting = new GameServerSetting(setting);
+            // This must be second
+            ScriptManager = new ScriptManager(this);
+
+            // Rest of server managers
             ClientLookup = new GameClientLookup();
             ChatLogHandler = new ChatLogHandler();
             ChatManager = new ChatManager(this);
@@ -91,6 +97,7 @@ public DdonGameServer(GameServerSetting setting, IDatabase database, AssetReposi
 
         public event EventHandler<ClientConnectionChangeArgs> ClientConnectionChangeEvent;
         public GameServerSetting Setting { get; }
+        public ScriptManager ScriptManager { get; }
         public ChatManager ChatManager { get; }
         public ItemManager ItemManager { get; }
         public CraftManager CraftManager { get; }
@@ -136,7 +143,7 @@ public override void Start()
             {
                 ScheduleManager.StartServerTasks();
             }
-            
+
             LoadChatHandler();
             LoadPacketHandler();
             base.Start();

diff --git a/Arrowgene.Ddon.GameServer/GameServerSetting.cs b/Arrowgene.Ddon.GameServer/GameServerSetting.cs
@@ -7,7 +7,7 @@ namespace Arrowgene.Ddon.GameServer
     public class GameServerSetting
     {
         [DataMember(Order = 1)] public ServerSetting ServerSetting { get; set; }
-        [DataMember(Order = 2)] public GameLogicSetting GameLogicSetting { get; set; }
+        public GameLogicSetting GameLogicSetting { get; set; }
 
         public GameServerSetting()
         {

diff --git a/Arrowgene.Ddon.GameServer/Handler/NpcGetExtendedFacilityHandler.cs b/Arrowgene.Ddon.GameServer/Handler/NpcGetExtendedFacilityHandler.cs
@@ -22,11 +22,13 @@ public NpcGetExtendedFacilityHandler(DdonGameServer server) : base(server)
         public override S2CNpcGetNpcExtendedFacilityRes Handle(GameClient client, C2SNpcGetNpcExtendedFacilityReq request)
         {
             var result = new S2CNpcGetNpcExtendedFacilityRes();
-            if (gNpcExtendedBehavior.ContainsKey(request.NpcId))
+
+            if (Server.ScriptManager.NpcExtendedFacilities.ContainsKey(request.NpcId))
             {
                 result.NpcId = request.NpcId;
-                gNpcExtendedBehavior[request.NpcId](Server, client, result);
+                Server.ScriptManager.NpcExtendedFacilities[request.NpcId].GetExtendedOptions(Server, client, result);
             }
+
             return result;
         }
 

diff --git a/Arrowgene.Ddon.GameServer/Scripting/DdonLibrary.cs b/Arrowgene.Ddon.GameServer/Scripting/DdonLibrary.cs
@@ -0,0 +1,14 @@
+namespace Arrowgene.Ddon.GameServer.Scripting
+{
+    public class DdonLibrary
+    {
+        public DdonLibrary()
+        {
+        }
+
+        public static uint GetValue()
+        {
+            return 1;
+        }
+    }
+}
diff --git a/Arrowgene.Ddon.GameServer/Scripting/INpcExtendedFacility.cs b/Arrowgene.Ddon.GameServer/Scripting/INpcExtendedFacility.cs
@@ -0,0 +1,21 @@
+using Arrowgene.Ddon.Shared.Entity.PacketStructure;
+using Arrowgene.Ddon.Shared.Model;
+
+namespace Arrowgene.Ddon.GameServer.Scripting
+{
+    public abstract class INpcExtendedFacility
+    {
+        /// <summary>
+        /// NPC ID associated with the extended options.
+        /// </summary>
+        public NpcId NpcId { get; protected set; }
+
+        /// <summary>
+        /// Gets extended menu options for the NPC.
+        /// </summary>
+        /// <param name="server"></param>
+        /// <param name="client"></param>
+        /// <param name="result">The result object for the extended NPC options</param>
+        public abstract void GetExtendedOptions(DdonGameServer server, GameClient client, S2CNpcGetNpcExtendedFacilityRes result);
+    }
+}
diff --git a/Arrowgene.Ddon.GameServer/Scripting/ScriptManager.cs b/Arrowgene.Ddon.GameServer/Scripting/ScriptManager.cs
@@ -0,0 +1,122 @@
+using Arrowgene.Ddon.Server;
+using Arrowgene.Ddon.Shared;
+using Arrowgene.Ddon.Shared.Model;
+using Arrowgene.Logging;
+using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.CSharp.Scripting;
+using Microsoft.CodeAnalysis.Scripting;
+using System;
+using System.Collections.Generic;
+using System.IO;
+
+namespace Arrowgene.Ddon.GameServer.Scripting
+{
+    public class Globals
+    {
+        public DdonGameServer Server { get; set; }
+        public GameLogicSetting GameLogicSetting { get; set; }
+    }
+
+    public class ScriptManager
+    {
+        public string ScriptsRoot { get; private set; }
+        public string SettingsPath { get; private set; }
+        public string ExtendedFacilitiesPath { get; private set; }
+
+        public Dictionary<NpcId, INpcExtendedFacility> NpcExtendedFacilities;
+
+        public Script Settings {
+            get {
+                return CompiledScripts["Settings"];
+            }
+            set
+            {
+                CompiledScripts["Settings"] = value;
+            }
+        }
+
+        private Dictionary<string, Script> CompiledScripts;
+        private static readonly ServerLogger Logger = LogProvider.Logger<ServerLogger>(typeof(ScriptManager));
+        private Globals Globals { get; }
+        private DdonGameServer Server { get; }
+
+        public event EventHandler<AssetChangedEventArgs> AssetChanged;
+        private readonly DirectoryInfo ScriptsDirectory;
+        private readonly Dictionary<string, FileSystemWatcher> FileSystemWatchers;
+
+        public ScriptManager(DdonGameServer server)
+        {
+            Server = server;
+
+            ScriptsRoot = $"{server.AssetRepository.AssetsPath}\\scripts";
+            SettingsPath = $"{ScriptsRoot}\\Settings.csx";
+            ExtendedFacilitiesPath = $"{ScriptsRoot}\\extended_facilities";
+
+            NpcExtendedFacilities = new Dictionary<NpcId, INpcExtendedFacility>();
+
+            Globals = new Globals()
+            {
+                Server = server,
+                GameLogicSetting = server.Setting.GameLogicSetting
+            };
+
+            ScriptsDirectory = new DirectoryInfo(ScriptsRoot);
+            if (!ScriptsDirectory.Exists)
+            {
+                Logger.Error($"Could not compile scripts, unable to locate the path '{ScriptsRoot}'");
+                return;
+            }
+
+            FileSystemWatchers = new Dictionary<string, FileSystemWatcher>();
+
+            CompiledScripts = new Dictionary<string, Script>();
+
+            CompileScripts();
+        }
+
+        private void CompileScripts()
+        {
+            var options = ScriptOptions.Default
+                .AddReferences(MetadataReference.CreateFromFile(typeof(DdonGameServer).Assembly.Location))
+                .AddReferences(MetadataReference.CreateFromFile(typeof(GameLogicSetting).Assembly.Location))
+                .AddReferences(MetadataReference.CreateFromFile(typeof(ScriptManager).Assembly.Location))
+                .AddReferences(MetadataReference.CreateFromFile(typeof(WalletType).Assembly.Location))
+                .AddImports("System", "System.Collections", "System.Collections.Generic")
+                .AddImports("Arrowgene.Ddon.Shared")
+                .AddImports("Arrowgene.Ddon.Shared.Model")
+                .AddImports("Arrowgene.Ddon.GameServer")
+                .AddImports("Arrowgene.Ddon.GameServer.Scripting")
+                .AddImports("Arrowgene.Ddon.Shared.Entity.PacketStructure");
+
+            // Load The Game Settings
+            Settings = CSharpScript.Create(
+                code: File.ReadAllText(SettingsPath),
+                options: options,
+                globalsType: typeof(Globals)
+            );
+            // Execute the script file to populate the settings
+            Settings.RunAsync(Globals);
+
+            foreach (var file in Directory.EnumerateFiles(ExtendedFacilitiesPath))
+            {
+                var script = CSharpScript.Create(
+                    code: File.ReadAllText(file),
+                    options: options,
+                    globalsType: typeof(Globals)
+                );
+
+                var result = script.RunAsync(Globals).Result;
+                if (result == null)
+                {
+                    Logger.Error($"Failed to parse {file}. Skipping.");
+                    continue;
+                }
+
+                INpcExtendedFacility extendedFacility = (INpcExtendedFacility)result.ReturnValue;
+                NpcExtendedFacilities[extendedFacility.NpcId] = extendedFacility;
+            }
+
+            // TODO: Load other game functionality we want to have scripted.
+        }
+    }
+}