Godot 4.

Scripts in Godot 4 games, through a Lua add-on.

This page is generated from the SDK's platform registry (sdk/environments.json) and the adapter's SETUP.md. The Godot 4 page on the site is the short version.

How it runs

An autoload node, ScriptGoHost, creates a Lua state through the lua-gdextension addon, runs the core in it and ticks it from _process. Server and local client share the game process.

The adapter's code and README: sdk/adapters/godot.

Set up

Measured with Godot 4.5.2 and lua-gdextension 0.7.0 (0.8.x needs Godot 4.6).

1. Copy addons/lua-gdextension from the lua-gdextension release into the project.

2. Copy scriptgo_host.gd and scriptgo_watchdog.gd from sdk/adapters/godot/ to res://addons/scriptgo/ and register them as autoloads, watchdog first:

   iniCopy

   [autoload]
   ScriptGoWatchdog="*res://addons/scriptgo/scriptgo_watchdog.gd"
   ScriptGoHost="*res://addons/scriptgo/scriptgo_host.gd"

3. Import once (Godot --headless --import --path <project>, or open the editor) so the extension is registered.

4. Point the host at the SDK (sdk_root, --scriptgo-sdk <dir>, or a copy under res://addons/scriptgo/sdk/), then boot it:

   gdscriptCopy

   func _ready():
       ScriptGoHost.boot({ "config": { "permissions": { "1": ["inventory.*"] } } })
       ScriptGoHost.add_search_path(ScriptGoHost.sdk_path + "packages")
       ScriptGoHost.add_resource(ScriptGoHost.sdk_path + "packages/sg_inventory")
       ScriptGoHost.start_all()
       ScriptGoHost.join(1, "Player")

The host ticks from _process. There is no HTTP yet, so licensed packages do not run on Godot.

Capabilities

What the adapter provides. See SDK and capabilities for what each one is.

Protection

Licence check and signed releases, once the adapter has HTTP. The adapter is script-level, so the operator can read what it loads; a native GDExtension loader would be a later upgrade.

See Protect your work for what protection does and does not do.

Assets

Maps, models, textures, sounds and other files players download. See Selling assets.

No game client downloads anything: assets are files of the resource.

Asset escrow: The host can read containers itself, but its operator holds the key: at-rest encryption only.

Limits

• Needs the lua-gdextension addon, 0.7.0 for Godot 4.5 (it declares 4.4 as its minimum; the 0.8.x binaries are built for Godot 4.6 and refuse 4.5.2).
• No HTTP, so no online license checks.
• Single-player only: no real network between server and client.
• Measured with Godot 4.5.2 on Windows x86_64, headless and windowed, with the Lua 5.4 and LuaJIT builds of lua-gdextension 0.7.0; exported builds, macOS, Linux, mobile and Web are not measured yet.

Real runs

Each row is a scriptgo verify run on Godot 4 itself, not on a mock or an emulator: the package started there and its own tests reported back. Rows marked probe are SCRIPT//GO's conformance probes, which exercise the runtime and are never published as packages. See how a status is earned.