Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Getting Started

Requirements

  • Windows 10/11 (64-bit), macOS (Apple Silicon or Intel), or Linux (x86_64)
  • A supported MCU (Teensy 4.0 or 4.1)
  • A USB mouse and/or keyboard to capture
  • An active Rebind license

Install or update

You can install or update Rebind with a single command. Re-running the command will update your client to the latest version.

Windows

Open PowerShell as Administrator and paste:

irm https://rebind.gg/install.ps1 | iex

macOS

Open the Terminal app and paste:

curl -fsSL https://rebind.gg/install.sh | sh

Linux

curl -fsSL https://rebind.gg/install.sh | sh

Flash your device

This installs the latest firmware on a supported MCU (Teensy 4.0 or 4.1).

  1. Open Rebind with your device plugged in
  2. Click the terminal icon in the lower right corner
  3. Type device list and locate your device
  4. Type device flash <BUS ID> (the bus ID is a value like 1-2 or 2-4)

The device will reboot with the latest firmware once flashing completes.

Activate your device

You only need to do this once per device. Requires a valid license key.

  1. With Rebind open and your device flashed (see above)
  2. Click the terminal icon in the lower right corner
  3. Type activate <LICENSE KEY>

Your license is tied to your hardware device. Once activated, it works offline.

Confirm it’s working

  1. Click the terminal icon in the lower right corner
  2. Type reauth
  3. Type device info to confirm everything is working

If device info shows your device as authenticated, you’re ready to go.

Attach your devices

  1. Open the Rebind UI
  2. Go to the Devices tab
  3. Click Auto-Detect to find your mouse and keyboard
  4. Click Attach All

Once attached, your devices are captured through the Rebind pipeline. Detach at any time to restore normal operation.

Kill switch: Press Ctrl+Alt+K at any time to immediately stop all scripts and release all held keys.

Your first script

Scripts are written in Luau, a fast typed variant of Lua. Here’s a simple example that inverts your mouse direction at 8kHz:

  1. Open the Rebind UI
  2. Go to the Scripts tab
  3. Click Create and paste the following:
-- rebind: name=Mouse Inverter
-- rebind: mouse_block=true
-- rebind: tick_rate=8000

function OnMove(dx, dy)
    HID.Move(-dx, -dy)
    return false
end
  1. Click Save and then Run

Move your mouse – it now moves in the opposite direction. Every input event passes through your script at up to 8,000 times per second before reaching the system.

How it works

  • -- rebind: lines configure the script (name, tick rate, input blocking)
  • mouse_block=true prevents raw mouse input from passing through (so only your script’s output reaches the OS)
  • OnMove(dx, dy) fires on every mouse movement with the raw delta
  • HID.Move(-dx, -dy) sends the inverted movement through the Rebind device
  • return false blocks the original input from passing through

Press Ctrl+Alt+K to stop the script and restore normal mouse behavior.

See the Scripting Guide for the full hook reference, coroutines, timers, and more.

Next steps