Installation

Install the Luau LSP visual studio code extension. If you are running a version <1.33.1 you will need to find and replace Enum. with Enum in the global.d.luau file, make sure you are not in regex mode, as that would cause issues.

Install lune, a luau runtime, note, only install this when the steps require you to, and install it within the specified directory.

Optional

Install rokit, a toolchain manager.

Install selene, a luau linter.

Install darklua, which has a luau file bundler.

Steps

git clone https://github.com/ArvidSilverlock/Pilot.lua-Luau-LSP.git
cd Pilot.lua-Luau-LSP

Once you are within the Pilot.lua-Luau-LSP directory, you need to install lune.

Then run:

lune run pilot-generate

You should then open the generated workspace folder as the root folder in visual studio code.

Due to lune you have to add -- after pilot-generate for any command options to work (i.e., lune run pilot-generate -- -o ./workspace).

Command Options

• --notypes - don't generate Pilot.lua type definitions.
• --nodocs - don't generate Pilot.lua documentation.
• --nomodules - don't generate Pilot.lua module definitions.
• --novscode - don't add a .vscode/settings.json and .vscode/extensions.json.
• --darklua - generate a .darklua.json.
• --selene - generate a selene.toml and pilot.yml.
• --rokit - setup rokit.toml.
• --wiki - generates all the wiki markdown files in the wiki docs directory.
• -o <path> - location to generate everything in, defaults to ./workspace.
• --types-dir=<type-directory> - subdirectory of the output location to place the types, docs and modules in, defaults to types.

Credits

The source code for several roblox related projects are included within the pilot-modules directory, these include:

• cxmeel/sift, under an MIT license.
• evaera/roblox-lua-promise, under an MIT license.
• Ozzypig/repr, under a WTFPL license.
• jaipack17/Nature2D, under an MIT license.
• Sleitnick/rbxts-octo-tree, under an MIT license (which is listed here rather than on the github).

The following are from Sleitnick/RbxUtil and are all under an MIT license.

• Signal
• Symbol
• TableUtil
• Trove