GitHub Template

roblox-rojo-wally-template

English 日本語

What is this?

This is a template for a modern development environment for Roblox (Luau) using VSCode.

• VSCode 👉 Roblox Studio Sync: Rojo
• Linter: Selene
• Formatter: StyLua
• Package Manager: Wally
• Manager for Rojo and Wally: Rokit

ℹ️ Warning

CI/CD is not included: CI/CD

Installation

💡 Tip

You can use this via the “Use this template” button.

Installing Rokit

Windows (PowerShell)

1

Invoke-RestMethod https://raw.githubusercontent.com/rojo-rbx/rokit/main/scripts/install.ps1 | Invoke-Expression

macOS / Linux

1

curl -fsSL https://raw.githubusercontent.com/rojo-rbx/rokit/main/scripts/install.sh | sh

Installing Rojo, Wally, etc.

1
2
3

rokit add rojo
rokit add wally
rokit add wally-package-types

Installing Packages

1
2
3
4
5

wally install
rojo sourcemap default.project.json --output sourcemap.json
wally-package-types -s sourcemap.json Packages/
wally-package-types -s sourcemap.json ServerPackages/
wally-package-types -s sourcemap.json DevPackages/

Installing VSCode Extensions

When you open this project in VSCode, you will be prompted to install the following recommended extensions. Please install them.

• Rojo
• Luau Language Server
• Selene
• StyLua

Usage

Rojo from VSCode

Press Ctrl + Shift + P

Select Rojo: Open Menu

ℹ️ Note

If this is your first time, launch Roblox Studio and install the Roblox Studio Plugin.

Select ▶ default.project.json

Rojo from Roblox Studio

Go to the “Plugins” tab.

In the “Rojo” ribbon, click the “Connect” button.

Adding Packages with Wally

Edit wally.toml in VSCode.

Find the package you want on wally.run and copy its name from the “Install” section.

The sections are categorized as follows:

[dependencies] is for both client and server. [server-dependencies] is for server-only. [dev-dependencies] is for development and testing only.

Once you’ve finished editing, run the package installation steps again.

References

How Big Studios Develop on Roblox