Quickstart

local ServerStorage = game:GetService("ServerStorage")
local RoControl = require(ServerStorage:WaitForChild("RoControl"))
 
local client = RoControl.init({
	apiKey = ServerStorage.RoControlConfig.ApiKey.Value,
	-- baseUrl defaults to https://api.rocontrol.app
	logLevel = "info", -- use "silent" in production if you prefer
})
 
-- Surface failures without ever stalling gameplay.
client:onFailedOperation(function(failed)
	warn(("[RoControl] %s failed (%s): %s"):format(
		failed.operation,
		failed.error.kind,
		failed.error.message
	))
end)
 
-- 1) Declarative: register a recurring schedule once at server start.
client:registerSchedule({
	key = "world-events",
	timezone = "UTC",
	cycleSeconds = 1800,        -- one event every 30 minutes
	eventDurationSeconds = 300, -- each shows for 5 minutes
	rotation = { kind = "sequential" },
	events = {
		{ key = "Lava", iconAssetId = "rbxassetid://111", durationSeconds = 300 },
		{ key = "Toxic", iconAssetId = "rbxassetid://222", durationSeconds = 300 },
		{ key = "Mirror", iconAssetId = "rbxassetid://333", durationSeconds = 300 },
	},
})
 
-- 2) Imperative: report an ad-hoc event (admin/player/random triggered).
client:reportEvent({
	key = "BlackHole",
	iconAssetId = "rbxassetid://789",
	durationSeconds = 120,
})
 
-- Flush pending work on shutdown.
game:BindToClose(function()
	client:flush()
end)