Nvsr is a screen reader for Neovim, the best cross-platform console text editor. NVSR stands for NeoVim Screen Reader. Nvsr is a fully refactored and improved fork of Neoreader.
- Reads characters, words and lines when you navigate them;
- Reads characters and words as you type;
- Announces when you enter and leave insert mode;
- Reads output of NeoVim's commands (with some limitations);
- On Microsoft Windows uses either SAPI5 or your preffered screen reader;
- On Linux uses speech-dispatcher;
- On MacOS uses VoiceOver (we have plans to adapt it for usage without VoiceOver).
Nvsr requires Neovim with if_python3.
If :echo has("python3") returns 1, then you're fine; otherwise, see below.
You can enable the Python 3 interface with pip:
`pip install neovim`
You must be using Python 3.6 or newer.
For vim-plug, add
Plug 'a11cf0/nvsr'to your configuration, and execute :PlugInstall.
Execute :UpdateRemotePlugins and restart Neovim.
" Original Neoreader configurations are present. They are not refactored and may be changed or deleted in future
nnoremap <Leader>q :SpeakLine<cr>
nnoremap <Leader>w :SpeakLineDetail<cr>
nnoremap <Leader>e :SpeakLineExplain<cr>
vnoremap <Leader>a :SpeakRange<cr>
vnoremap <Leader>s :SpeakRangeDetail<cr>
vnoremap <Leader>d :SpeakRangeExplain<cr>
" defaults
let g:enable_at_startup = 1
let g:interpet_generic_infix = 1
let g:speak_brackets = 0
let g:speak_keypresses = 1
let g:speak_words = 1
let g:speak_mode_transitions = 0
let g:speak_completions = 0
let g:auto_speak_line = 1
let g:speak_indent = 0
let g:auto_speak_output = 1
let g:pitch_multiplier = 1
let g:speak_speed = 350
let g:use_espeak = 0
let g:use_ao2 = 1
let g:speak_voice = ''We have been trying to use many different Vi-like text editors for several years, and every time a new flavor of Vim appeared, we hoped that it would be more accessible for screen reader users.
Some day we realized that Neovim is the most accessible one. So we started researching about how we could improve its usage with the NVDA screen reader.
We found several verry useful config options, such as :set noruler or :set eb but they were still insufficient for best experience.
Some day we found a plugin called "Neoreader, Neovim screenreader" and tried it only to realize that Neoreader is more of a prototype than a fully working screen reader. And so we decided to improve it, to fix bugs, add features and give it a new life.