Skip to main content

Setup

You'll need to do a couple of things get this all set up, including:

  • GitHub
  • Rojo
  • Wally
  • And more!

First-time stuff​

You'll need to do a few things as a one-time thing, if you have not already. You only need to do these once for them to work for all of your projects!

Installing Rokit​

You will need Rokit to use Rojo, Wally, and Lune.

To download Rokit on macOS or Linux, run this in your terminal:

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

To download Rokit on Windows, run this in PowerShell:

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

Initializing each project​

First, you'll need to publish your repository on GitHub. To do so, do the following in order:

  • Create GitHub repository
  • Clone repository locally (such as through GitHub desktop)
  • Copy-paste everything from the template into the clone directory

Installing tools​

To install the tools included with the project, run rokit install in the folder's terminal.

Generating initial sourcemap​

To generate the initial sourcemap, run this in your terminal:

rojo sourcemap default.project.json --output sourcemap.json

Customizing your stuff​

It's recommended you do the following to customize your repository further:

Setting up GitHub secrets​

You will need to set up secrets for automated publishing.

On Roblox​

First, go to the Roblox Creator page, click All tools, and click API Keys.

Create an API Key, naming it something like "automated publishing".

Scroll down to Permissions, and add the following permissions:

  • universe-places (write)

You may choose to restrict by experience and/or IP addresses. Make sure the key does not expire.

On the security warning popup, click the "I understand the security risks" checkbox, and then save & generate key. Save this key by clickikng "copy key to clipboard".

warning

Make sure to save your key! It will go away once you leave the page.

On GitHub​

Now that you have your Roblox API key, go to your project, then settings, then secrets and variables > actions.

You are going to create three new repository secrets, each created by clicking "new repository secret".

For the first secret, use these details:

  • Name: ROBLOX_API_KEY
  • Secret: Your API key

For the second secret, use these details:

  • Name: UNIVERSE_ID
  • Secret: Your universe ID (also known as "game" or "experience" id, this it not your place ID)

Lastly, you'll need a secret with these details:

  • Name: PLACE_ID
  • Secret: Your main place ID (not the universe ID)