Installation
Getting started
What is Unify's Framework?
Unify Framework is a Roblox framework built with purpose. Designed for speed by default, lightweight for efficiency, and engineered for stability. Crafted specifically for developers.
Required Tools
Before using Unify — whether through the CLI or manual setup — make sure you have the following installed:
- Rojo – Sync files between your filesystem and Roblox Studio
- Wally – Dependency manager for Roblox development
You must have these tools installed globally before continuing.
Automatic installation
The fastest way to get started with Unify is using create-unify-project
. To create a project, run:
npx create-unify-project@latest
Heads up!
Make sure you have Node.js installed before using the npx
command.
Manual Installation
If you prefer to set up Unify manually or want to integrate it into an existing project:
- Add Unify to your
wally.toml
:
[dependencies]Unify = "sunkenball/unify@x.x.x"
- Run:
wally install
This installs Unify into the Packages/
folder, ready to be synced using Rojo.
Warning
Manually implementing Unify in your project withou wally may lead to unexpected errors. It's recommended to use wally or the CLI for the most reliable setup.