In-Game Overlay¶

Opt-in LÖVE performance overlay rendered through Feather plugin hooks. This plugin is a copy of the overlayStats.lua in Oval-Tutu/bootstrap-love2d-project.

The overlay draws after the game by using the plugin manager's onDraw callback, so your game does not need to call a draw function manually.

When Feather runtime work is suspended from the session bar, the visible overlay keeps updating and drawing inside the game. Normal Feather telemetry/plugin sampling stays paused, but the overlay can continue showing local performance samples because it runs through the suspended overlay lane. Expensive overlay metrics are sampled on a short interval and reused while drawing so the HUD stays much cheaper than a per-frame profiler.

Enable¶

return {
  include = { "ingame-overlay" },
}

Controls¶

• F3 toggles the overlay.
• F5 toggles VSync while the overlay is visible.
• Gamepad Back + A toggles the overlay.
• Gamepad Back + B toggles VSync while the overlay is visible.
• On touch devices, double-tap the top-right corner to toggle the overlay.
• Double-tap inside the visible overlay to toggle VSync.

Options¶

pluginOptions = {
  ["ingame-overlay"] = {
    visible = false,
    sampleSize = 60,
    sampleInterval = 0.1,
    touchCornerSize = 80,
    doubleTapThreshold = 0.5,
  },
}