https://github.com/melmass/echo.nvim

🔊 Seamlessly integrate sound into your Neovim workflow
https://github.com/melmass/echo.nvim

neovim neovim-plugin rust

Last synced: 23 days ago
JSON representation

🔊 Seamlessly integrate sound into your Neovim workflow

• Host: GitHub
• URL: https://github.com/melmass/echo.nvim
• Owner: melMass
• Created: 2024-03-09T12:07:12.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-06-06T21:07:34.000Z (6 months ago)
• Last Synced: 2024-08-01T16:49:01.492Z (4 months ago)
• Topics: neovim, neovim-plugin, rust
• Language: Rust
• Homepage:
• Size: 621 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# echo.nvim

[![canary-status](https://img.shields.io/github/actions/workflow/status/melmass/echo.nvim/release.yml?style=flat-square&&label=canary)](https://github.com/melMass/echo.nvim/releases/tag/canary)

[![latest-tag](https://img.shields.io/github/v/tag/melmass/echo.nvim?label=latest-stable&&style=flat-square&color=black)](https://github.com/melMass/echo.nvim/releases/)

*Experiment to try the rust bindings for neovim.*

Cross platform sound player for neovim (supports wav & mp3)  

Tested on **Native Windows** and **macOS** (should work fine under linux too)

## Limitations

- I doesn't work under [WSL](https://github.com/microsoft/WSL/issues/1631)

## Usage

You can quickly register events from the

[configuration](#configuration)'s `event` field.

You can also use the module in lua:

```lua

local echo = require("echo")

-- Play a sound from path

echo.play_sound("/path/to/file.mp3")

-- Play a sound from the builtins

echo.play_sound("builtin:SUCCESS_2")

-- List builtin sounds

print(vim.inspect(echo.list_builtin_sounds())

-- { "ALERT_1", "ALERT_2", "ALERT_3", "ALERT_4", "ALERT_5", "BUTTON_1", "BUTTON_2", "BUTTON_3", "BUTTON_4", "BUTTON_5", "BUTTON_6", "BUTTON_7", "BUTTON3", "CANCEL_1", "CANCEL_2", "COLLAPSE", "COMPLETE_1", "COMPLETE_2", "COMPLETE_3", "ERROR_1", "ERROR_2", "ERROR_3", "ERROR_4", "ERROR_5", "EXPAND", "NOTIFICATION_1", "NOTIFICATION_2", "NOTIFICATION_3", "NOTIFICATION_4", "NOTIFICATION_5", "NOTIFICATION_6", "NOTIFICATION_7", "NOTIFICATION_8", "NOTIFICATION_9", "SUCCESS_1", "SUCCESS_2", "SUCCESS_3", "TAB_1", "TAB_2", "TAB_3" }

```

## Features

- [x] Performant and cross platform SFX player (using rodio).

- [x] [Overseer](https://github.com/stevearc/overseer.nvim/blob/master/doc/components.md) component (wip): allow you to bind sounds to task statuses on completion.

- [x] Rust <-> Lua Options

  - [x] Basic Override defaults from Lua

  - [ ] Live update (should just work but not exposed properly yet)

- [ ] Proper Lazy build step:

    - [ ] If possible add a `from_source` option, if not provided the build script should instead download it from github releases.

## Configuration

```lua

opts = {

  amplify = 0.5, -- the default level of amplification if not provided

                 -- (defaults to 1.0)

  demo = false,  -- install the demo events (the ones from the video demo)

  -- custom table of event -> sound mapping)

  events = {

    BufRead = { path = "builtin:EXPAND", amplify = 1.0 },

    BufWrite = { path = "builtin:SUCCESS_2", amplify = 1.0 },

    CursorMovedI = { path = "builtin:BUTTON_3", amplify = 0.45 },

    ExitPre = { path = "builtin:COMPLETE_3", amplify = 1.0 },

    InsertLeave = { path = "builtin:NOTIFICATION_5", amplify = 0.5 },

  }

}

```

- With **lazy**:

*As of version 0.0.1 this will not work since you need the built binary (found

in release), this will be the first thing to be solved for the next version.*

```lua

{

  'melmass/echo.nvim',

  opts = {

    demo = true,

  },

}

```

- Manually:

```lua

require("echo").setup(opts)

```

### Telescope Integration:

There is a telescope picker to preview the builtin sounds:

To register it run: 

```lua

require("telescope").register_extension("echo")

```

You can then call the command: `:Telescope echo`