Skip to content
Public template

About

A module loader framework for Roblox that provides simple and fast module lookup, cyclic dependency support, a customizable initialization sequence, and more!

Resources

Stars

20 stars

Watchers

1 watching

Forks

Repository files navigation

banner

Getting Started

The following instructions will get you up and running with an Order-powered experience! This assumes that you have at least a basic understanding of Roblox Studio.

1) Download VS Code and Rojo

  1. Download and install VS Code from here
  2. From VS Code, install the extension Rojo from the Extensions tab on the left sidebar or through this link.
  3. In Roblox Studio, search for and add the plugin for Rojo through the toolbox, or use this link.

2) Create a new repository based on this template

  1. At the top of this page, click the green "Use this template" button and select "Create a new repository"
  2. Select the proper owner, add a name, choose your desired visiblity options, and click "Create repository from template"
  3. Using the software of your choice (I typically use VS Code's Source Control menu), clone your new repository to your computer

3) Install packages with Forest (recommended)

  1. Install Rokit, then run rokit install in your new project's directory. This installs Rojo, StyLua and the Forest CLI at the versions in rokit.toml.
  2. Run forest install. Forest reads forest.json and installs shared packages into Packages and server-only packages into ServerPackages.
  3. Commit the generated forest-lock.json so every machine installs the same versions.
Using Wally instead

Wally is still supported, but Forest is recommended for new projects.

  1. If you don't yet have Wally, you can install it from here or through Rokit or Aftman, which both list it.
  2. Run wally install in your project's directory to get the packages in wally.toml.

Only use one package manager per project: Forest removes Wally's _Index folders the next time it installs. forest init --project can convert an existing wally.toml into a forest.json.

4) Project configuration

  1. Open the new repository in VS Code and then open the default.project.json file
  2. At the top, you'll see a string that reads "New Order Project", replace this with the name of your new project and save the file

5) Sync code into Roblox Studio

  1. In VS Code, click the Rojo button on the bottom right (if you don't see this icon, verify the Rojo extension is installed and restart VS Code)
  2. In the context menu that appears, click on default.project.json at the bottom
  3. In Roblox Studio, create or open a place file that will host your new experience
  4. Switch to the Plugins tab, and select Rojo
  5. In the Rojo window that appears, click "Connect"

You are now up and running with Order! Any code you write in VS Code will be synced into your new game whenever you save the file. If you need further help, you can visit the DevForum, read the Order docs, or check out the Rojo docs!

About

A module loader framework for Roblox that provides simple and fast module lookup, cyclic dependency support, a customizable initialization sequence, and more!

Resources

Stars

20 stars

Watchers

1 watching

Forks

Releases

Contributors

Languages