Skip to main content

Get Started

EXPERIMENTAL

This feature is still experimental. Things may change or break over time. We'll post a notice if any breaking changes happen.

The programming language is Luau which is sandboxed, there are no globals between scripts and dangerous functions have been removed.

Scripts are found in ProjectGWN\mods\scripts and each script will have its own folder and it's own state, separated from other scripts.

A valid script should have an entry-point file (__script.json) to be loaded by the game.

Even with the Sandbox encapsulation there are ways to share data using require or events

Script entry-point​

In order for the game to initialize your script it looks inside __script.json for the entry-point and tries to execute that.

ProjectGWN/mods/scripts/TutScript/__script.json {4-4}
{
  "author": "GlorWeeN",
  // It can be any file (no extension)
  "entry": "_init",
  ...
}

VSCode​

Extensions:

And that's it, the script is already configured for VSCode, the scripting api should autocomplete without any other setup.