Skip to content

Commit 0184bae

Browse files
committed
Document the new cursor settings
1 parent 03b7183 commit 0184bae

File tree

1 file changed

+24
-7
lines changed

1 file changed

+24
-7
lines changed

website/docs/configuration.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -832,17 +832,30 @@ this happens too often accidentally to you, set this to a higher value like `0.3
832832
VimScript:
833833

834834
```vim
835-
let g:neovide_cursor_animation_length = 0.13
835+
let g:neovide_cursor_animation_length = 0.2
836836
```
837837

838838
Lua:
839839

840840
```lua
841-
vim.g.neovide_cursor_animation_length = 0.13
841+
vim.g.neovide_cursor_animation_length = 0.2
842842
```
843843

844844
Setting `g:neovide_cursor_animation_length` determines the time it takes for the cursor to complete
845-
it's animation in seconds. Set to `0` to disable.
845+
its animation in seconds. Set to `0` to disable.
846+
847+
Note that the perceived length is shorter than the configured one, and greatly depends on the
848+
animation trail size.
849+
850+
Here are some example configurations you can try:
851+
852+
| neovide_cursor_animation_length | neovide_cursor_trail_size | result |
853+
|---------------------------------|---------------------------|--------|
854+
| 0.75 | 0.5 | Almost like Neovide 0.14.1 and earlier |
855+
| 0.1 | 0.6 | Responsive, with a long streak to help tracking cursor movements |
856+
| 0.05 | 0.8 | More responsive version of the above |
857+
| 0.8 | 0.1 | Responsive with a short streak |
858+
| 0.2 | 0.4 | More responsive version of the above (default) |
846859

847860
#### Animation Trail Size
848861

@@ -855,17 +868,21 @@ it's animation in seconds. Set to `0` to disable.
855868
VimScript:
856869

857870
```vim
858-
let g:neovide_cursor_trail_size = 0.8
871+
let g:neovide_cursor_trail_size = 0.4
859872
```
860873

861874
Lua:
862875

863876
```lua
864-
vim.g.neovide_cursor_trail_size = 0.8
877+
vim.g.neovide_cursor_trail_size = 0.4
865878
```
866879

867-
Setting `g:neovide_cursor_trail_size` determines how much the trail of the cursor lags behind the
868-
front edge.
880+
Setting `g:neovide_cursor_trail_size` changes the acceleration profile of the cursor animation, so
881+
that the trail appears shorter or longer. The range is between 0.0 and 1.0, where 1.0 is a long
882+
trail, while 0 is a non-existent trail, effectively disabling the animation.
883+
884+
See: [Animation Trail Size](#animation-trail-size) for some examples of how the values interact with
885+
each other.
869886

870887
#### Antialiasing
871888

0 commit comments

Comments
 (0)