https://github.com/xenira/daktilo.nvim
Nvim Plugin for daktilo
https://github.com/xenira/daktilo.nvim
daktilo keyboard nvim nvim-plugin plugin typewriter
Last synced: about 1 year ago
JSON representation
Nvim Plugin for daktilo
- Host: GitHub
- URL: https://github.com/xenira/daktilo.nvim
- Owner: Xenira
- License: gpl-3.0
- Created: 2023-10-28T11:36:38.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-05-06T07:45:09.000Z (about 1 year ago)
- Last Synced: 2025-05-07T04:46:44.998Z (about 1 year ago)
- Topics: daktilo, keyboard, nvim, nvim-plugin, plugin, typewriter
- Language: Rust
- Homepage:
- Size: 651 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.adoc
Awesome Lists containing this project
README
= daktilo.nvim
v0.1.0
ifdef::env-github[]
:toc:
:toc-placement!:
:caution-caption: :fire:
endif::[]
ifndef::env-github[]
:toc: left
:icons: font
endif::[]
:toclevels: 2
:sectnums:
:source-highlighter: highlight.js
image:https://img.shields.io/github/license/Xenira/daktilo.nvim[License]
image:https://img.shields.io/github/issues/Xenira/daktilo.nvim[GitHub issues]
image:https://img.shields.io/github/issues-pr/Xenira/daktilo.nvim[GitHub pull requests]
image:https://codecov.io/gh/Xenira/daktilo.nvim/graph/badge.svg?token=2QIMJV3L6F["Code Coverage", link="https://codecov.io/gh/Xenira/daktilo.nvim"]
ifdef::env-github[]
++++
++++
endif::[]
ifndef::env-github[]
image::assets/daktilo-nvim-logo.png[Logo, width=200, align="center"]
endif::[]
This is a plugin for Neovim that provides additional functionality for link:https://github.com/orhun/daktilo[daktilo].
CAUTION: 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.
ifdef::env-github[]
toc::[]
endif::[]
== 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*.
=== 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).
=== Known issues
- Daktilo needs to be started before Neovim. Otherwise the plugin will not work.
- Occasionally crashes nvim :confounded:.
== Installation
Currently you need to download the plugin binary and import it using lua require. This will be changed in the future.
```lua
require('daktilo-nvim').start()
```
== Configuration
The plugin can be configured by passing a table to the start function.
```lua
require('daktilo-nvim').start({
-- The port to use for the gRPC server in daktilo.
rpc_port = 50051,
})
```
== Contributing
Contributions are welcome. Please open an issue to discuss the changes you would like to make.
== License
This plugin is licensed under the GPL-3.0 license. See the LICENSE file for more information.