Skip to main content

Installation

VluxySF can be acquired using Wally, a package manager for Roblox.

Wally Configuration

Once Wally is installed, run wally init on your project directory, and then add VluxySF as a dependency. For example, the following could be a wally.toml file for a project that includes a few of these modules:

[package]
name = "your_name/your_project"
version = "0.1.0"
registry = "https://github.com/UpliftGames/wally-index"
realm = "shared"

[dependencies]
VluxySF = "greenviper126/VluxySF@^1"

To install this dependency, run wally install within your project. Wally will create a Package folder in your directory with the installed dependency.

Rojo Configuration

The Package folder created by Wally should be synced into Roblox Studio through your Rojo configuration. For instance, a Rojo configuration might have the following entry to sync the Packages folder into ReplicatedStorage:

{
"name": "vluxysf",
"tree": {
"$className": "DataModel",
"ReplicatedStorage": {
"$className": "ReplicatedStorage",
"Packages": {
"$path": "Packages"
}
}
}
}