Skip to content

Latest commit

 

History

History
72 lines (58 loc) · 2.19 KB

README.adoc

File metadata and controls

72 lines (58 loc) · 2.19 KB

daktilo.nvim

License GitHub issues GitHub pull requests Code Coverage

This is a plugin for Neovim that provides additional functionality for daktilo.

🔥
This plugin is still in early development and is not ready for use. The required features in daktilo are not yet merged and are still subject to change.

1. Features

  • Reports the current column number to daktilo while in insert mode. This can be used to play sounds depending on the column number ding.

1.1. Planned

  • Report active / inactive to switch between editor / char based mode in daktilo (not supported by daktilo yet).

  • Report current workspace to daktilo (not supported by daktilo yet).

1.2. Known issues

  • Daktilo needs to be started before Neovim. Otherwise the plugin will not work.

  • Occasionally crashes nvim 😖.

2. Installation

Currently you need to download the plugin binary and import it using lua require. This will be changed in the future.

require('daktilo-nvim').start()

3. Configuration

The plugin can be configured by passing a table to the start function.

require('daktilo-nvim').start({
  -- The port to use for the gRPC server in daktilo.
  rpc_port = 50051,
})

4. Contributing

Contributions are welcome. Please open an issue to discuss the changes you would like to make.

5. License

This plugin is licensed under the GPL-3.0 license. See the LICENSE file for more information.