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:
-
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
pnpm dev / npm run 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. -
Sync (optional)
If you want to test your script on Roblox Studio, run the following once:
rojo plugin install
.Then, simply run
pnpm dev-sync / npm run dev-sync
and connect on Roblox Studio (look for Rojo in the Plugins section). -
Deploy (optional)
If you chose to initialize a git repository, and have it connected to a remote GitHub repo, you can run
pnpm release / npm run release
to create a release with the script attached.Only do this once you've made changes and pushed them to the
main
branch. Otherwise, it won't do anything. -
Packages (optional)
You can install roblox-ts packages like usual, through your package manager. An example of a package is
@rbxts/vide
.If the package is not under the
@rbxts
scope, usepnpm scope / npm run scope
to add the scope of the package.Here's an example of a package being used:
import greet from "@snipcola/greet-test"; greet("world");