Builds & bundles TypeScript source files into a Lua script, which you can use on Roblox.
Make sure the following are installed:
The following are automatically installed; if it fails, install manually:
It's recommended you also install the following VSCode extensions:
If you installed pnpm
, use that instead of npm
for the following steps.
-
Create Project
Run the following in a terminal, and follow the instructions:
(p)npm create roblox-ts-script
-
Develop
Once the script has created your project, open it in an IDE, preferably VSCode.
In the VSCode Terminal, you can execute
npm run dev / pnpm dev
. Now you can edit files insrc
, and it will compile toout
when you save. -
Build
If you'd like to manually start the build process, instead of running the dev script, run
npm run build / pnpm build
which will build once.