game-template

Generated by Rojo 7.7.0.

Getting Started

To build the place from scratch, use:

rojo build -o "game-template.rbxlx"

Next, open game-template.rbxlx in Roblox Studio and start the Rojo server:

rojo serve

For more help, check out the Rojo documentation.

Run tests

Install dependencies with lute scripts/install.luau. Copy .env.example to .env and fill in an Open Cloud API key and the IDs of a dedicated test universe and place. Existing environment variables take precedence over .env.

The key needs universe-places:write and universe.place.luau-execution-session:write permissions for the test universe. See place publishing and Luau execution.

Add tests named *.spec.luau under src, then run:

lute scripts/test.luau

You can also supply the key with --apiKey KEY or -k KEY. ROBLOX_API_KEY takes precedence over the flag.

The script builds tests.project.json, uploads a saved version to the configured test place, and runs Jest against that version. It prints the task logs, removes the local tests.rbxl, and exits with code 0 when tests pass or 1 when they fail. The template has no tests yet.

The runner and its helpers are adapted from Roblox/gear. Their license is in scripts/ROBLOX-GEAR-LICENSE.txt.