gamepad

name

gamepad

description

Add on-screen touch controls (virtual joystick + buttons) to browser games using @vibedgames/gamepad. Use when the user wants mobile/touch controls, a virtual joystick or d-pad, on-screen action buttons, or to make a desktop game playable on phones. Triggers on: 'add touch controls', 'mobile controls', 'make it work on mobile', 'virtual joystick', 'on-screen buttons', 'd-pad', 'thumbstick', 'gamepad'.

Vibedgames Gamepad

Add on-screen touch controls — a floating analog joystick plus action buttons — to any browser game with @vibedgames/gamepad. Framework-agnostic core, with drop-in adapters that wire the input and render the overlay for you: one for Phaser, one for the DOM (Three.js, canvas, anything else).

Install

npm install @vibedgames/gamepad

phaser is an optional peer dependency — only needed if you use the /phaser adapter. The core and /dom adapter have no engine dependency.

Three entry points

• @vibedgames/gamepad/phaser — attachVirtualGamepad(scene, options) for Phaser games
• @vibedgames/gamepad/dom — attachDomGamepad(options) for everything else (Three.js, canvas, vanilla). Prefer this over the raw core.
• @vibedgames/gamepad — framework-agnostic VirtualGamepad class, for custom event routing / custom renderers only

Core concepts

• Floating stick — the first free touch anchors a virtual analog stick wherever the finger lands; dragging from the anchor steers. Reads back as angle + magnitude (0–1 thrust after a dead zone).
• Action buttons — either fixed (a circle pinned on-screen, e.g. a bottom-right bomb/jump button) or "rest" (no position — catches any touch that isn't the stick or a fixed button; this is the "any second finger fires" model).
• Touch is the overlay. The adapter ignores the mouse, so a desktop game keeps whatever controls it already had. isTouch flips true the first time a finger lands — use it to switch control schemes or swap an on-screen hint.

Touch routing

Each touch-down is routed in order: fixed buttons → the stick → a "rest" button. This one model covers both common layouts — a stick + rest "fire" button (twin-stick: move one thumb, any other finger fires), and a stick + fixed action button (grid/platformer: move with the stick, tap to bomb/jump). Both are shown below.

Phaser quickstart (twin-stick shooter)

import { attachVirtualGamepad } from "@vibedgames/gamepad/phaser";

class GameScene extends Phaser.Scene {
  private gamepad!: ReturnType<typeof attachVirtualGamepad>;

  create() {
    this.gamepad = attachVirtualGamepad(this, {
      buttons: [{ id: "fire" }], // rest button: any non-stick finger fires
      onFirstTouch: () => this.hint?.destroy(),
    });
    this.events.once(Phaser.Scenes.Events.SHUTDOWN, () => this.gamepad.destroy());
  }

  update() {
    this.gamepad.update(); // ALWAYS call once per frame: reconciles + redraws

    const stick = this.gamepad.getStick();
    if (stick.active && !stick.inDeadZone) {
      this.(stick., stick.); 
    }
     (..()) .();
  }
}

update() every frame is mandatory. It reconciles touches whose up event was lost (finger slid off-canvas) and redraws the overlay. Skip it and the joystick "sticks" on.

Phaser recipe: grid game (joystick → 4-way + a bomb button)

import { attachVirtualGamepad, stickDirection4 } from "@vibedgames/gamepad/phaser";

this.gamepad = attachVirtualGamepad(this, {
  buttons: [
    {
      id: "bomb",
      // re-anchors on resize; viewport is the live canvas size
      position: ({ width, height }) => ({ x: width - 84, y: height - 84 }),
      radius: 52,
    },
  ],
  render: { depth: 1000, blendMode: Phaser.BlendModes.NORMAL }, // NORMAL for bright scenes
  onButtonDown: (id) => {
    if (id === "bomb") this.placeBomb(); // edge-triggered: fires once per tap
  },
});

// in update(), after this.gamepad.update():
const dir = stickDirection4(this.gamepad.getStick()); // "up"|"down"|"left"|"right"|null
if (dir) this.step(dir);

Held vs. edge input:

• Held (movement, continuous fire): read isButtonDown(id) / getStick() each frame.
• Edge (place a bomb, jump once per tap): use the onButtonDown(id) / onButtonUp(id) callbacks, or poll justPressed(id) / justReleased(id) after update() — polling fits fixed-timestep sims where input is sampled once per tick.

DOM adapter (Three.js / canvas / vanilla)

attachDomGamepad renders the stick + buttons as DOM elements in a pointer-events: none overlay and listens on window for touch pointers (mouse is ignored, same as Phaser). Taps on interactive elements (button, a, inputs, [data-gamepad-ignore]) are left to the page, so it won't swallow your HUD.

import { attachDomGamepad, stickDirection4 } from "@vibedgames/gamepad/dom";

const gamepad = attachDomGamepad({
  visible: "coarse", // pre-show fixed buttons on touch devices — discoverable before first touch
  buttons: [
    {
      id: "jump",
      label: "JUMP",
      position: (v) => ({ x: v.width - 72 - v.inset.right, y: v.height - 72 - v.inset.bottom }),
    },
    { id: "fire" }, // rest button: any non-stick finger
  ],
});

// in your rAF game loop:
gamepad.update(); // ALWAYS once per frame: reconcile + edges + redraw
const stick = gamepad.getStick();
if (gamepad.justPressed("jump")) jump();
if (gamepad.isButtonDown("fire")) shoot();

// on teardown:
gamepad.destroy();

Requirements: your game surface needs touch-action: none (else the browser scrolls instead of delivering moves), and setTint takes a CSS color string here ("#22d3ee"), not a number.

Safe areas (notch / home indicator)

Position resolvers receive viewport.inset — the device safe-area insets. Subtract them for bottom/side-anchored buttons (see the JUMP example above) so controls clear the iOS home indicator. Non-zero values require viewport-fit=cover in the page's viewport meta tag:

<meta
  name="viewport"
  content="width=device-width, initial-scale=1.0, user-scalable=no, viewport-fit=cover"
/>

Visibility

By default the overlay renders only after the first touch. Fixed buttons that don't exist until you touch the screen are undiscoverable — pass visible: "coarse" (either adapter) to pre-show them on touch-capable devices. Desktop with a mouse still never sees them.

Keep desktop controls; touch is additive

The gamepad never touches the mouse path, so wire it alongside your existing keyboard/mouse code and read whichever is active:

private readDir(): Dir | null {
  if (this.keys.left.isDown) return "left";
  // … other keys …
  return stickDirection4(this.gamepad.getStick()); // falls through to touch
}

For aim-style games, branch on isTouch:

if (this.gamepad.isTouch) {
  const s = this.gamepad.getStick();
  if (s.active) this.aim(s.angle, s.magnitude);
} else {
  this.aimAtCursor(this.input.activePointer);
}

Tuning

attachVirtualGamepad(this, {
  stick: {
    radius: 64, // drag distance (px) that maps to full magnitude
    deadZone: 8, // no thrust / no re-aim within this drag (parked thumb)
    knobRadius: 26, // visual puck size
  },
  // stick: false,   // disable the stick entirely (buttons-only)
  // extraPointers defaults to buttons + 2, so simultaneous holds aren't dropped
  visible: "coarse", // pre-show fixed buttons on touch devices (default "touch")
  render: {
    depth: 95, // above the world, below a DOM HUD
    tint: 0xffffff, // knob + button color
    blendMode: Phaser.BlendModes.ADD, // ADD glows on dark scenes; NORMAL for bright
  },
});

// Recolor at runtime (e.g. to the local player's color), e.g. each frame:
this.gamepad.setTint(this.myPlayerColor());

Pass render: false to suppress the built-in renderer and draw it yourself from gamepad.pad (getStickGeometry(), getStick(), getButtonLayout()).

Framework-agnostic core (custom routing / custom renderer)

Reach for the raw core only when the DOM adapter doesn't fit (custom event sources, in-engine rendering). Coordinates are CSS pixels — use clientX/clientY, never offsetX against canvas.width (a HiDPI canvas buffer is larger than its on-screen size, which mis-anchors fixed buttons).

import { VirtualGamepad, safeAreaInset, stickDirection8 } from "@vibedgames/gamepad";

const pad = new VirtualGamepad({ buttons: [{ id: "jump" }] });
pad.setViewport(window.innerWidth, window.innerHeight, safeAreaInset()); // re-call on resize

window.addEventListener("pointerdown", (e) => pad.pointerDown(e.pointerId, e.clientX, e.clientY));
window.addEventListener("pointermove", (e) => pad.pointerMove(e.pointerId, e.clientX, e.clientY));
window.addEventListener("pointerup", (e) => pad.pointerUp(e.pointerId));
window.addEventListener("pointercancel", (e) => pad.pointerUp(e.pointerId));

// each frame:
pad.([...activePointerIds]); 
pad.(); 
 stick = pad.();
 dir = (stick); 
 jumping = pad.();

Anti-patterns

❌ Forgetting gamepad.update() (or pad.reconcile()). Lost up events leave the stick/button stuck on. Call it every frame.

❌ Reading a held button for a one-shot action. isButtonDown("bomb") is true for the whole press — you'll drop a bomb every frame. Use onButtonDown or justPressed for tap actions.

❌ Forcing a joystick onto a game with a better native gesture. Tap-anywhere (flappy), swipe (pacman-style turns), or absolute drag (pong paddles) beat a virtual stick. The package is for games that need held directional movement + action buttons; keep superior gestures as they are.

❌ Driving steering off angle while in the dead zone. A parked thumb has a noisy angle. Gate on stick.active && !stick.inDeadZone (or just use stickDirection4/8, which already return null in the dead zone).

❌ Re-implementing the mouse path inside the adapter. The adapter is touch-only by design. Keep desktop controls in your own code and read the gamepad as the touch source.

❌ Forgetting to destroy() on scene shutdown. Leaves pointer listeners and the overlay Graphics dangling. Tie it to SHUTDOWN.

❌ Attaching the Phaser pad to a zoomed-camera scene. setScrollFactor(0) does not exempt the overlay from camera zoom — the stick/buttons render zoom-transformed (often off-screen). Attach the pad in a parallel un-zoomed HUD scene instead; input still reaches it because Phaser processes scene input top-down, and gameplay scenes can read the same pad object (share it via the scene registry or a module).

Deploy

vg deploy ./dist --slug my-game → live at https://my-game.vibedgames.com. See the deploy skill for the full flow (use npx vibedgames deploy if vg isn't on PATH).

See also

• multiplayer (@vibedgames/multiplayer) — real-time sync, shared/player state, and host-authoritative logic. Pairs naturally: tint the stick/buttons to each player's color via setTint.