https://github.com/tamton-aquib/duck.nvim

A duck that waddles arbitrarily in neovim.
https://github.com/tamton-aquib/duck.nvim

lua neovim neovim-plugin

Last synced: 3 days ago
JSON representation

A duck that waddles arbitrarily in neovim.

• Host: GitHub
• URL: https://github.com/tamton-aquib/duck.nvim
• Owner: tamton-aquib
• License: mit
• Created: 2021-11-18T09:53:20.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-08T13:46:59.000Z (8 months ago)
• Last Synced: 2024-08-01T22:54:09.570Z (3 months ago)
• Topics: lua, neovim, neovim-plugin
• Language: Lua
• Homepage:
• Size: 29.3 KB
• Stars: 614
• Watchers: 5
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# duck.nvim

A duck that waddles between your codes

![Peek 2021-11-18 15-43](https://user-images.githubusercontent.com/77913442/142396581-787616c0-92c9-4ddd-aa15-7bd218f6011b.gif)

> Coding? release the duck. 


> bored? release the duck. 


> not bored? release the duck. 


### Install and Configure

```lua

{

    'tamton-aquib/duck.nvim',

    config = function()

        vim.keymap.set('n', 'dd', function() require("duck").hatch() end, {})

        vim.keymap.set('n', 'dk', function() require("duck").cook() end, {})

        vim.keymap.set('n', 'da', function() require("duck").cook_all() end, {})

    end

}

```

To set custom character:

```lua

nnoremap dd :lua require("duck").hatch("ඞ")

```

> popular candidates: 🦆 ඞ  🦀 🐈 🐎 🦖 🐤 

You can also specify how fast a duck moves (measured in steps per second):

```lua

vim.keymap.set('n', 'dd', function() require("duck").hatch("🦆", 10) end, {}) -- A pretty fast duck

vim.keymap.set('n', 'dc', function() require("duck").hatch("🐈", 0.75) end, {}) -- Quite a mellow cat

```

### Features

- can release multiple ducks.

- does not load on startup.

- Light weight, <100 LOC

- Its a duck