GitHub - jackplus-xyz/player-one.nvim: A plugin that adds 8-bit sound effects to Neovim.

Note

Make sure you have sounds on!

Warning

This plugin is currently in beta. If you encounter any issues, please:

1. Run :checkhealth player-one and copy the output
2. Open an issue with the health check results and steps to reproduce

{
  "jackplus-xyz/player-one.nvim",
  ---@type PlayerOne.Config
  opts = {
    -- your configuration comes here
    -- or leave it empty to use the default settings
    -- refer to the configuration section below
  }
}

---@class PlayerOne.Config
{
  ---@type boolean Whether the plugin is enabled (default: true)
  is_enabled = true,

  ---@type number Minimum interval between sounds in seconds (default: 0.05)
  ---Prevents sound overlapping and potential audio flooding when
  ---multiple keystrokes happen in rapid succession
  min_interval = 0.05,

  ---@type string|PlayerOne.Theme Theme name or custom sounds table (default: "chiptune")
  ---Available presets: "chiptune", "crystal", "synth"
  theme = "chiptune",

  ---@type number Master volume for all sounds (0.0-1.0, default: 0.5)
  ---This multiplies with each sound's individual volume
  master_volume = 0.5,

  ---@type table<string, table<string, boolean>> Theme-specific sound disables
  ---Only specify sounds you want to disable (all sounds enabled by default)
  theme_config = {
    -- Example: disable specific sounds for specific themes
    -- chiptune = {
    --   CursorMoved = false,    -- Disable cursor movement sounds for chiptune
    --   TextChangedI = false,   -- Disable typing sounds for chiptune
    -- },
    -- synth = {
    --   VimEnter = false,       -- Disable startup melody for synth theme
    -- },
  },

  ---@type boolean Whether to print debug messages (default: false)
  debug = false,

  ---@class PlayerOne.BinaryConfig
  binary = {
    -- Automatically download updates (default: true)
    auto_update = true,

    -- Version cache timeout in seconds (default: 3600)
    cache_timeout = 3600,

    -- Download timeout in seconds (default: 60)
    download_timeout = 60,

    -- Verify binary checksums (default: true)
    verify_checksum = true,

    -- Use development build if available (default: true)
    use_development = true,

    -- GitHub API token for higher rate limits (default: nil)
    github_api_token = nil,

    -- Proxy configuration
    proxy = {
      -- Proxy URL (default: nil)
      url = nil,

      -- Use system proxy settings (default: true)
      from_env = true,
    },
  },
}

{
  "jackplus-xyz/player-one.nvim",
  opts = {
    is_enabled = false, -- Start with sounds disabled until explicitly enabled
    min_interval = 0.1, -- Increase delay between sounds to 100ms
    theme = "synth",    -- Use the synthesizer sound theme
    master_volume = 0.7, -- Set master volume to 70%
  }
}

{
  "jackplus-xyz/player-one.nvim",
  opts = {
    theme = "chiptune",
    theme_config = {
      chiptune = {
        CursorMoved = false,    -- Disable cursor sounds (most common!)
        TextChangedI = false,   -- Disable typing sounds
      },
      synth = {
        VimEnter = false,       -- Disable startup melody for synth theme
        CmdlineChanged = false, -- Disable command line typing
      },
      crystal = {
        -- Maybe you love all crystal sounds, so leave this empty!
      }
    }
  }
}

-- Option 1: Add to flash configuration
require("flash").setup({
  action = function(match, state)
    -- Play sound before jumping
    require("player-one").play({
      wave_type = 1,
      base_freq = 1200,
      env_decay = 0.05
    })
    -- Continue with default jump behavior
    require("flash.jump").jump(match, state)
  end
})

-- Option 2: Add to flash keymaps
vim.keymap.set("n", "s", function()
  require("player-one").play({
    wave_type = 2,
    base_freq = 800,
    env_decay = 0.1
  })
  require("flash").jump()
end)

-- Add sounds for mode transitions
vim.api.nvim_create_autocmd("ModeChanged", {
  callback = function()
    local new_mode = vim.v.event.new_mode
    if new_mode == "i" then
      -- Entering insert mode
      require("player-one").play({
        wave_type = 1,
        base_freq = 659.25,
        env_decay = 0.1
      })
    elseif new_mode == "n" then
      -- Entering normal mode
      require("player-one").play({
        wave_type = 2,
        base_freq = 329.63,
        env_decay = 0.1
      })
    end
  end
})