repository·main·Indexed 19 days ago
https://github.com/sleitnick/rbxutilA comprehensive suite of utility libraries for Roblox developers. RbxUtil provides specialized modules for networking (Net, Comm, TypedRemote), data manipulation (BufferUtil, Ser, TableUtil), physics (PID, Spring, Quaternion), and lifecycle management (Trove). The libraries are available via Wally and npm (@rbxutil) and are compatible with Rojo and roblox-ts.
To enable type checking and autocompletion for @rbxutil modules, add the @rbxutil directory to the typeRoots array in your tsconfig.json file. The @rbxts directory should also be present in this list.
"typeRoots": ["node_modules/@rbxts", "node_modules/@rbxutil"]After installing dependencies with Wally, you must configure Rojo to sync the Packages folder into your Roblox DataModel (typically ReplicatedStorage). Add a mapping for the Packages directory in your default.project.json file.
{
"name": "rbx-util-example",
"tree": {
"$className": "DataModel",
"ReplicatedStorage": {
"$className": "ReplicatedStorage",
"Packages": {
"$path": "Packages"
}
}
}
}RbxUtil modules are published under the @rbxutil NPM organization and can be installed like any other roblox-ts package. To install a specific library, such as the quaternion library, use npm install with the package name prefixed by @rbxutil.
$ npm install @rbxutil/quaternionRbxUtil modules are distributed via Wally, a package manager for Roblox.
wally init in your project directory to initialize a wally.toml file.[dependencies] section in wally.toml.wally install to download the dependencies into a Packages folder.[package]
name = "your_name/your_project"
version = "0.1.0"
registry = "https://github.com/UpliftGames/wally-index"
realm = "shared"
[dependencies]
Signal = "sleitnick/signal@^1"
TableUtil = "sleitnick/table-util@^1"To ensure that @rbxutil modules are correctly included in your Roblox project, you must add the @rbxutil directory to your default.project.json file. It is recommended to place it in ReplicatedStorage alongside the @rbxts directory.
"node_modules": {
"$className": "Folder",
"@rbxts": {
"$path": "node_modules/@rbxts"
},
"@rbxutil": {
"$path": "node_modules/@rbxutil"
}
}A Sequent is a signal-like structure that executes connected callbacks in a serial manner. Unlike standard signals where all callbacks run concurrently or independently, each connection in a Sequent must fully complete before the next one begins.
Key characteristics:
Sequent is created with cancellable set to true, a callback can call event:Cancel() to prevent the event from propagating to any subsequent connections in the sequence.Fire method yields until all connections have completed.local sequent = Sequent.new(true) -- true enables event cancellation
sequent:Connect(function(event)
print("First connection")
event:Cancel() -- Stops subsequent connections from running
end, Sequent.Priority.Highest)
sequent:Connect(function(event)
print("This won't print!")
end, Sequent.Priority.Lowest)
sequent:Fire("Test")The Shake module allows you to create realistic procedural shake effects for cameras or objects.
To use it:
Shake.new().Amplitude, Frequency, and FadeInTime.shake:Start().shake:OnSignal(signal, callback) or shake:BindToRenderStep(name, priority, callback).Shakes automatically stop and clean up their connections once they complete. If you need to run multiple shakes with the same configuration simultaneously, use shake:Clone() to create a new instance from a preset.
Note: shake:Start() must be called before Update, OnSignal, or BindToRenderStep.
local priority = Enum.RenderPriority.Last.Value
local shake = Shake.new()
shake.FadeInTime = 0
shake.Frequency = 0.1
shake.Amplitude = 5
shake.RotationInfluence = Vector3.new(0.1, 0.1, 0.1)
shake:Start()
shake:BindToRenderStep(Shake.NextRenderName(), priority, function(pos, rot, isDone)
camera.CFrame *= CFrame.new(pos) * CFrame.Angles(rot.X, rot.Y, rot.Z)
end)You can initialize a Stream using several methods depending on your source data:
stream.create(size): Creates a new stream with a fresh buffer of the specified size in bytes.stream.frombuffer(buf): Wraps an existing buffer in a stream.stream.fromstring(str): Converts a string into a buffer and wraps it in a stream.local s = stream.create(4)
local s_from_buf = stream.frombuffer(existing_buffer)
local s_from_str = stream.fromstring("hello")Use Signal.new() to create a fresh Signal instance for event-driven programming. This implementation is batched and yield-safe, meaning handlers can yield without significant performance overhead.
local signal = Signal.new()
-- Subscribe to a signal:
signal:Connect(function(msg)
print("Got message:", msg)
end)
-- Dispatch an event:
signal:Fire("Hello world!")To use the installed modules, reference the Packages folder (usually located in ReplicatedStorage) and use require() on the specific module.
Example workflow:
Packages folder in ReplicatedStorage.require the module.-- Reference folder with packages:
local Packages = game:GetService("ReplicatedStorage").Packages
-- Require the utility modules:
local Signal = require(Packages.Signal)
local TableUtil = require(Packages.TableUtil)
-- Use the modules:
local signal = Signal.new()
signal:Connect(function(data)
local randomizedData = TableUtil.Shuffle(data)
print(randomizedData)
end)
signal:Fire({"A", "B", "C"})Use the following properties to customize the behavior of a Shake instance:
Amplitude (number): The overall magnitude of the shake. Defaults to 1.Frequency (number): The speed of the shake. Defaults to 1.FadeInTime (number): Duration in seconds to fade in to max amplitude. Defaults to 1.FadeOutTime (number): Duration in seconds to fade out after sustain/completion. Defaults to 1.SustainTime (number): How long the shake stays at full amplitude before fading out. Defaults to 0.Sustain (boolean): If true, the shake lasts indefinitely until shake:StopSustain() is called. Defaults to false.PositionInfluence (Vector3): Multiplier for the position offset vector. Defaults to Vector3.one.RotationInfluence (Vector3): Multiplier for the rotation offset vector. Defaults to Vector3.one.TimeFunction (function): A function returning the current time (defaults to time or os.clock).