How to make clean lua integration in my wof c# mvvm app using moonsharp
- User
How to make clean lua integration in my wof c# mvvm app using moonsharp
Assistant
Integrating Lua scripting into a WPF C# MVVM application using MoonSharp is a great way to add extensibility and dynamic behavior. MoonSharp is a Lua interpreter for .NET, so it's perfect for this use case.
Here's a step-by-step guide to cleanly integrate Lua via MoonSharp in your WPF MVVM app:
🧱 1. Setup Your Project
✅ Prerequisites:
- A working WPF MVVM project
- Install MoonSharp via NuGet:
Install-Package MoonSharp
📁 2. Basic Architecture Overview (MVVM + Lua)
You’ll want to keep the Lua integration clean and decoupled from your UI and ViewModel logic.
Structure suggestion:
/Scripts/ example_script.lua /Services/ LuaService.cs /ViewModels/ MainViewModel.cs
🔧 3. Create a Lua Service
This class will manage all Lua execution logic and expose it to ViewModels or Commands.
LuaService.csusing MoonSharp.Interpreter; public class LuaService { private Script _script; public LuaService() { _script = new Script(); // Optional: Register global functions or inject objects here } /// <summary> /// Executes a Lua script string and returns output as a string. /// </summary> public string ExecuteScript(string luaCode) { try { DynValue result = _script.DoString(luaCode); return result.ToString(); } catch (ScriptRuntimeException ex) { return $"Lua Error: {ex.DecoratedMessage}"; } catch (Exception ex) { return $"Error: {ex.Message}"; } } /// <summary> /// Load and execute a script from file /// </summary> public string ExecuteScriptFromFile(string filePath) { if (!File.Exists(filePath)) return "File not found."; string code = File.ReadAllText(filePath); return ExecuteScript(code); } /// <summary> /// Expose C# object to Lua /// </summary> public void RegisterGlobalObject(string name, object obj) { _script.Globals[name] = obj; } }
🧠 4. Integrate with ViewModel (MVVM Pattern)
Use
ICommandto bind Lua execution to buttons or menu items.Example:
MainViewModel.csusing System.Windows.Input; public class MainViewModel : INotifyPropertyChanged { private readonly LuaService _luaService; private string _luaOutput; private string _luaInput = "-- Write your Lua code here"; public MainViewModel() { _luaService = new LuaService(); // Optionally register some C# objects for Lua to interact with _luaService.RegisterGlobalObject("viewModel", this); RunScriptCommand = new RelayCommand(ExecuteLuaScript); } public ICommand RunScriptCommand { get; } public string LuaInput { get => _luaInput; set { _luaInput = value; OnPropertyChanged(); } } public string LuaOutput { get => _luaOutput; set { _luaOutput = value; OnPropertyChanged(); } } private void ExecuteLuaScript(object param) { LuaOutput = _luaService.ExecuteScript(LuaInput); } // INotifyPropertyChanged implementation public event PropertyChangedEventHandler PropertyChanged; protected void OnPropertyChanged([CallerMemberName] string name = null) { PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(name)); } }
🖥️ 5. Bind UI Elements in XAML
Example of binding input/output fields and a button:
MainWindow.xaml
<Window x:Class="YourApp.MainWindow" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" Title="Lua Integration" Height="450" Width="800"> <DockPanel> <TextBox DockPanel.Dock="Top" Text="{Binding LuaInput}" AcceptsReturn TextWrapping="Wrap" VerticalScrollBarVisibility="Auto" Height="150"/> <Button DockPanel.Dock="Top" Content="Run Lua Script" Command="{Binding RunScriptCommand}" Margin="5"/> <TextBox DockPanel.Dock="Bottom" Text="{Binding LuaOutput}" IsReadOnly="True" Background="LightGray" Height="150"/> </DockPanel> </Window>
🧪 6. Example Lua Script
Try this in your input box:
print("Hello from Lua!") local a = 5 local b = 10 return "Sum = " .. (a + b)Expected Output:
Hello from Lua! Sum = 15
🔄 7. Optional: Two-Way Communication
You can allow Lua scripts to call back into C# by exposing methods or objects:
In C#:
public class LuaApi { public void ShowMessage(string msg) { MessageBox.Show(msg); } }Then register it:
_luaService.RegisterGlobalObject("api", new LuaApi());Now in Lua:
api:ShowMessage("Hello from Lua!")
🧼 8. Clean Up Tips
- Keep Lua scripts modular and isolated.
- Handle errors gracefully.
- Use
RelayCommandor similar pattern for testable commands. - Consider sandboxing scripts if allowing user-defined scripts.
📦 Bonus: Load Scripts From Disk
You can load
.luafiles from disk at runtime like:string scriptPath = @"C:\path\to\your_script.lua"; LuaOutput = _luaService.ExecuteScriptFromFile(scriptPath);Make sure to handle relative paths correctly using
AppDomain.CurrentDomain.BaseDirectory.
✅ Summary
Step Description 1 Install MoonSharp via NuGet 2 Create a LuaServiceto encapsulate Lua logic3 Inject Lua results into ViewModel 4 Bind UI elements using standard MVVM bindings 5 Allow two-way communication between Lua and C# 6 Handle errors and provide feedback
Would you like an example GitHub repo structure or downloadable template?
Other models, same or similar prompt
Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.