RoGrid

Typed client/server events for Roblox. Declare a receiver in Luau, and the RoGrid CLI generates its callers, payload validation, and startup wiring. This package supplies the runtime used by that generated code.

Development status: RoGrid is unfinished and under active development. Breaking changes can occur in any release. Review changes before upgrading.

Getting started

With Rokit and Roblox Studio installed, create a project:

rokit add --global RoGrid-HQ/rogrid
rogrid init my-game --package-manager pesde --tool-manager rokit
cd my-game
rojo plugin install
rogrid dev

Connect the Rojo plugin in Studio and press Play. The starter installs this package as ReplicatedStorage.Packages.rogrid and calls RoGrid.start() on both sides. Installing the runtime package alone does not generate callers or add startup scripts to a game.

Example

-- src/server/events/Lobby.luau
--!strict
local RoGrid = require(game:GetService("ReplicatedStorage").Packages.rogrid)

return {
    setReady = RoGrid.event(function(player: Player, ready: boolean)
        player:SetAttribute("Ready", ready)
    end),
}

After startup, the client can call:

local Server = require(game:GetService("ReplicatedStorage").RoGridGenerated.Server)
Server.Lobby.setReady.fire(true)

Server handlers receive the sending Player automatically. Payload arguments support string, boolean, and number. Client receivers generate server callers with .fire(player, ...) and .fireAll(...).

Documentation

These guides are included in the package for Pesde and can also be read in the repository:

• Getting started
• Event guide
• Configuration
• CLI reference
• API reference
• Troubleshooting
• Package managers
• Project status

The runtime is published as rogrid/rogrid on Pesde and rogrid-hq/rogrid on Wally. The CLI pins the matching runtime version when creating a project. Use --package-manager wally during init to choose Wally.

License

MIT