Skip to content

Getting started

Requirements

  • .NET SDK 10.0 or later.
  • The DreamLuau solution and NuGet restore access.
  • Godot .NET 4.7 only when using DreamLuau.Godot.

The packages are configured for NuGet but are not published yet. You can use project references from this checkout or build local packages as described in the NuGet guide.

dotnet add path\to\YourApp.csproj reference .\src\DreamLuau\DreamLuau.csproj
dotnet add path\to\YourApp.csproj reference .\src\DreamLuau.NuLua\DreamLuau.NuLua.csproj

Run your first script

using DreamLuau;
using DreamLuau.NuLua;

await using var runtime = new DreamRuntime(new NuLuaBackend());
await using var context = runtime.CreateContext();

using var result = await context.ExecuteStringAsync("return 40 + 2", "hello.luau");
Console.WriteLine(result.Values[0].As<double>()); // 42

DreamRuntime owns configuration and tracks contexts. Each call to CreateContext() creates an independent VM and global environment. Dispose both runtime and contexts; disposing the runtime also disposes its contexts.

Build and test this repository

dotnet restore .\DreamLuau.sln
dotnet build .\DreamLuau.sln --no-restore
dotnet test .\DreamLuau.sln --no-build

For API examples, continue to Bindings, Execution and lifecycle, and Sandbox and modules.