breakdown.nvim

Turn debugging into a spectator sport. One command and your code yeets itself across Neovim like it rage-quit before you could. This plugin doesn't fix your stress... it commits to the bit and falls apart with you... in buttery-smooth 60 FPS.

Features

• Realistic physics simulation - Characters fall with gravity, mass variation, and collision detection
• Syntax highlighting preservation - Colors stay intact during the breakdown
• Restore on keypress - Press any key to restore your buffer
• Highly configurable - Customize gravity, speed, and physics parameters
• Performance optimized - Smooth 60 FPS animation

Demo

[Add GIF/video here]

Installation

Using lazy.nvim

{
  "yourusername/breakdown.nvim",
  config = function()
    require("breakdown").setup()
  end,
}

Using packer.nvim

use {
  "yourusername/breakdown.nvim",
  config = function()
    require("breakdown").setup()
  end
}

Using vim-plug

Plug 'yourusername/breakdown.nvim'

Then in your init.lua:

require("breakdown").setup()

Usage

Trigger the breakdown animation with:

:Breakdown

Or call it from Lua:

require("breakdown").breakdown()

After the animation completes, press any key to restore your buffer.

Configuration

Default Configuration

require("breakdown").setup({
  -- Animation frame rate (frames per second)
  fps = 60,

  -- Gravity strength - higher = faster fall
  gravity = 50.0,

  -- Particle mass range - affects fall speed variation
  mass_min = 0.7,
  mass_max = 1.7,

  -- Horizontal velocity range for drift effect
  drift_max = 1.5,

  -- Initial vertical velocity range
  initial_velocity_max = 2.0,

  -- Air resistance coefficient (0-1, where 1 = no resistance)
  air_resistance = 0.98,

  -- Collision padding when particles stack (rows)
  collision_padding = 0.3,

  -- Collision detection distance (horizontal)
  collision_distance = 1.5,
})

Example Configurations

Slower, more dramatic breakdown:

require("breakdown").setup({
  gravity = 20.0,
  mass_min = 0.5,
  mass_max = 1.0,
  drift_max = 3.0,
})

Fast rage quit:

require("breakdown").setup({
  gravity = 100.0,
  mass_min = 1.5,
  mass_max = 2.5,
  drift_max = 0.5,
})

How It Works

1. Capture - Grabs all visible characters with their syntax highlighting
2. Simulate - Applies realistic physics (gravity, mass, collision, air resistance)
3. Render - Displays particles as virtual text overlays at 60 FPS
4. Restore - Waits for keypress, then restores original buffer

The plugin uses Neovim's extmark system for rendering and vim.inspect_pos() for accurate syntax highlighting capture, ensuring compatibility with all colorschemes and syntax systems (treesitter, LSP semantic tokens, traditional syntax).

Requirements

• Neovim >= 0.9.0

Credits

Inspired by frustration and the universal developer experience of wanting to flip a table.

License

MIT License - see LICENSE file for details