Getting Started

This walks through a first script, from a plain file write to reading live game state.

Your first script

The simplest thing that proves the runtime works is a file round trip. The file namespace is sandboxed to a per-user workspace directory, so this is safe to run anywhere.

file.write("hello.txt", "conduit is running")
print(file.read("hello.txt"))

Run it with the run command. Output appears immediately. Loading a script on its own is silent; run is the path that prints.

Reading the game

Most scripts read live game state. That needs Conduit attached to a running engine, which you can check with memory.IsEnabled. From there, game behaves like the Roblox DataModel and roblox.FindFirst locates a service or instance by class name.

if not memory.IsEnabled() then
  return print("Conduit is not attached to a running engine")
end

local workspace = roblox.FindFirst("Workspace")
print(#workspace:GetChildren(), "objects in Workspace")

Running every frame

To do work continuously, register a handler with cheat.Register. Use onUpdate for per-frame logic and onPaint for drawing to the overlay.

cheat.Register("onUpdate", function()
  -- runs once per frame
end)

Where to go next

• Core Concepts explains the model behind the API.
• The API Reference documents every namespace, each method with a signature and example. Good starting points are memory, roblox, and draw.