Skip to main content

Installation

VluxyAI is published on Wally.

Wally​

Add it to your project's wally.toml under [dependencies]. The package is shared realm, so it can live in a folder both server and client see; only the server needs to build agents, but the types, the runner and the scoring are safe to require anywhere.

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

[dependencies]
VluxyAI = "greenviper126/vluxyai@0.12.0"

Run wally install. Wally creates a Packages folder holding VluxyAI. It has no dependencies of its own.

Rojo​

Sync the Packages folder somewhere both realms can reach:

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

Then in a server script:

local ReplicatedStorage = game:GetService("ReplicatedStorage")
local VluxyAI = require(ReplicatedStorage.Packages.VluxyAI)

Types across the package boundary​

Wally's link files do not carry Luau types by default. If you want VluxyAI.Agent, VluxyAI.Brain and friends to resolve in your editor, run wally-package-types after wally install:

rojo sourcemap default.project.json -o sourcemap.json
wally-package-types --sourcemap sourcemap.json Packages/