# Pulse

> A build system and reactive framework for Roblox Lua scripts. Write modular .rblua components, compile everything into one obfuscated .lua file — one push to GitHub, one loadstring URL, no per-module obfuscation mess.

Pulse is used to build structured Roblox Lua scripts. The rb CLI compiles .rblua source files into a single flat script. Components have signals (reactive state), on handlers (event subscriptions), func blocks (public methods), and ui blocks (Linoria widget declarations).

## Getting Started

- [Introduction](https://pulse-rb.vercel.app/docs/intro): What Pulse is, the deployment problem it solves, honest state of the project
- [Quick Start](https://pulse-rb.vercel.app/docs/quick-start): Install rb with one command, scaffold a project, build and inject
- [Mental Model](https://pulse-rb.vercel.app/docs/mental-model): How compilation works, what Pulse handles vs what you write

## Setup

- [Environment Setup](https://pulse-rb.vercel.app/docs/setup/environment): PC requirement, VS Code, Python, Lua, alt account setup
- [Choosing an Executor](https://pulse-rb.vercel.app/docs/setup/executor): Potassium recommendation, UNC compliance, why Xeno/Solara don't work
- [Development Workflow](https://pulse-rb.vercel.app/docs/setup/dev-workflow): Dev mode, watch loop, dev overlay, build cycle, compat builds

## Scripting School

- [Executor Context](https://pulse-rb.vercel.app/docs/school/executor-context): What executors do, LocalScript context, UNC APIs, thread model
- [Lua for Exploit Scripts](https://pulse-rb.vercel.app/docs/school/lua-for-scripts): Lua crash course — tables, closures, metatables, pcall, task library
- [Roblox API Essentials](https://pulse-rb.vercel.app/docs/school/roblox-api): Players, RunService, UserInputService, CoreGui, Instance API
- [The Game Tree](https://pulse-rb.vercel.app/docs/school/game-tree): Where things live in the hierarchy, finding entities and remotes
- [Dex Explorer Guide](https://pulse-rb.vercel.app/docs/school/dex-guide): Browsing instances, reading properties, finding hidden values
- [Capturing Remotes (rSpy)](https://pulse-rb.vercel.app/docs/school/rspy-guide): Intercepting remote traffic, reading arguments, replay attacks
- [Reading Game Scripts](https://pulse-rb.vercel.app/docs/school/reading-scripts): require() ModuleScripts, reading .Source, decompiling, tracing logic
- [Remote Events & Functions](https://pulse-rb.vercel.app/docs/school/remotes): FireServer, InvokeServer, OnClientEvent, common patterns
- [Hooking & Intercepting](https://pulse-rb.vercel.app/docs/school/hooking-remotes): hookfunction, hookmetamethod __namecall, blocking, modifying arguments
- [Instance Manipulation](https://pulse-rb.vercel.app/docs/school/instance-manipulation): Reading/writing properties, CFrame, client vs server, ChildAdded
- [Values & Configs](https://pulse-rb.vercel.app/docs/school/values-and-configs): StringValue, IntValue, BoolValue, Changed events, leaderstats
- [Executor APIs](https://pulse-rb.vercel.app/docs/school/executor-apis): getgc, getrawmetatable, hookfunction, readfile/writefile, getsenv
- [Drawing & Visuals](https://pulse-rb.vercel.app/docs/school/drawing-and-visuals): Drawing API, Highlight instances, BillboardGui labels, health bars
- [Input & Camera](https://pulse-rb.vercel.app/docs/school/input-and-camera): UserInputService, Mouse object, raycasting, camera control
- [Why Pulse?](https://pulse-rb.vercel.app/docs/school/why-pulse): The GitHub ban problem, monolithic files, why rb compiles everything
- [Components & Signals](https://pulse-rb.vercel.app/docs/school/pulse-components): Component syntax, signals, on handlers, guard, func, init, bind
- [Reactive UI](https://pulse-rb.vercel.app/docs/school/pulse-ui-and-signals): UI widgets, signal reactivity, CharacterAdded pattern, cross-component
- [Examples: Player](https://pulse-rb.vercel.app/docs/school/examples-player): Speed, fly, noclip, FOV, teleport — complete Pulse components
- [Examples: Visuals](https://pulse-rb.vercel.app/docs/school/examples-visuals): Player ESP, name/health labels, box ESP with Drawing API
- [Examples: Remotes](https://pulse-rb.vercel.app/docs/school/examples-remotes): Ability spam, auto-buy, remote spy, argument modification

## Core Concepts (Pulse Reference)

- [Your First Feature](https://pulse-rb.vercel.app/docs/core/your-first-feature): Full tutorial building a real component
- [Signals](https://pulse-rb.vercel.app/docs/core/signals): Reactive state — declare, read, write, react
- [Components](https://pulse-rb.vercel.app/docs/core/components): Full component syntax, lifecycle, connection tracking
- [Event Handlers](https://pulse-rb.vercel.app/docs/core/event-handlers): on blocks, when/every modifiers, character locals
- [UI Blocks](https://pulse-rb.vercel.app/docs/core/ui): Widget declarations, defaults, Linoria integration

## Patterns

- [What Pulse Handles](https://pulse-rb.vercel.app/docs/patterns/what-pulse-handles): Framework boundary — what you write vs what Pulse handles
- [Common Mistakes](https://pulse-rb.vercel.app/docs/patterns/common-mistakes): Top errors with fixes
- [Roblox Gotchas](https://pulse-rb.vercel.app/docs/patterns/roblox-gotchas): Replication, load guards, executor differences
- [Cross-Component Communication](https://pulse-rb.vercel.app/docs/patterns/cross-component): Signals, watch, Pulse.Store

## Helpers (Pulse.*)

- [Helpers Overview](https://pulse-rb.vercel.app/docs/helpers): All Pulse.* helpers index
- [Pulse.Log](https://pulse-rb.vercel.app/docs/helpers/log): Structured logging, live dashboard
- [Pulse.Loop](https://pulse-rb.vercel.app/docs/helpers/loop): Managed intervals
- [Pulse.Draw](https://pulse-rb.vercel.app/docs/helpers/draw): Highlights, circles, selection boxes
- [Pulse.Aim](https://pulse-rb.vercel.app/docs/helpers/aim): FOV, camera snap, findNearest, locker
- [Pulse.Hitbox](https://pulse-rb.vercel.app/docs/helpers/hitbox): Resize and restore hitbox parts
- [Pulse.Team](https://pulse-rb.vercel.app/docs/helpers/team): Friend/enemy resolver
- [Pulse.Store](https://pulse-rb.vercel.app/docs/helpers/store): Cross-component reactive KV store
- [Pulse.Cooldown](https://pulse-rb.vercel.app/docs/helpers/cooldown): Rate limiting
- [Pulse.Track](https://pulse-rb.vercel.app/docs/helpers/track): Entity lifecycle tracking
- [Pulse.Cache](https://pulse-rb.vercel.app/docs/helpers/cache): Timed caching
- [Pulse.World](https://pulse-rb.vercel.app/docs/helpers/world): Safe workspace navigation
- [Pulse.Restore](https://pulse-rb.vercel.app/docs/helpers/restore): Save/restore instance properties

## Debugging & AI

- [Dev Overlay](https://pulse-rb.vercel.app/docs/debugging/dev-overlay): Log viewer, feature toggles, config snapshot
- [Known Limitations](https://pulse-rb.vercel.app/docs/debugging/known-limitations): Honest list of limitations and rough edges
- [Using AI](https://pulse-rb.vercel.app/docs/ai/using-ai): Claude Code setup, llms.txt, prompt patterns
- [Example Prompts](https://pulse-rb.vercel.app/docs/ai/example-prompts): Ready-to-use AI prompt templates
- [CLI Reference](https://pulse-rb.vercel.app/docs/cli): All rb commands

## Full context for AI

- [llms-full.txt](https://pulse-rb.vercel.app/llms-full.txt): Complete syntax, helpers API, and patterns — paste into any AI context window