Skip to main content

Installation

VluxySF is installed with Wally, a package manager for Roblox, and synced into Studio with Rojo.

1. Add the package​

If your project does not use Wally yet, run wally init in your project directory first.

Then add VluxySF under [dependencies] in your wally.toml:

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

[dependencies]
VluxySF = "greenviper126/vluxysf@^2"

Run wally install in your project. Wally creates a Packages folder that contains VluxySF.

Upgrading from 1.x​

Change the version to @^2 and run wally install again. Your code keeps working, with these differences:

  • Startup.InitClient(0) no longer waits for the preloads or warns. Other scripts waiting with WaitForSchema resume as soon as the schema arrives, before the preloads finish.
  • Calling InitServer or InitClient twice throws an error.
  • The companion VS Code extension is gone. Sound names are plain strings.

The full list is in the changelog.

2. Sync the package into Studio​

VluxySF runs on both the server and the client, so the Packages folder has to be somewhere both can reach. ReplicatedStorage is the usual place.

Add the Packages folder to your Rojo project file:

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

3. Require it​

With the setup above, you can require the library from any script:

local ReplicatedStorage = game:GetService("ReplicatedStorage")

local VluxySF = require(ReplicatedStorage.Packages.VluxySF)

Every example in these docs uses this path. If your Packages folder is somewhere else, change the path to match.

Next step​

The library needs sounds to work with. Continue to Folder Setup.