https://github.com/AndrewRadev/typewriter.vim

Make cool typewriter sounds in insert mode
https://github.com/AndrewRadev/typewriter.vim

sound typewriter vim

Last synced: about 2 months ago
JSON representation

Make cool typewriter sounds in insert mode

• Host: GitHub
• URL: https://github.com/AndrewRadev/typewriter.vim
• Owner: AndrewRadev
• License: mit
• Created: 2023-04-01T08:04:19.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-07T07:48:40.000Z (9 months ago)
• Last Synced: 2024-07-03T14:58:22.676Z (3 months ago)
• Topics: sound, typewriter, vim
• Language: Vim Script
• Homepage:
• Size: 397 KB
• Stars: 80
• Watchers: 4
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
## Demo (sound on)

https://user-images.githubusercontent.com/124255/229273984-9b5ac7f2-11f4-400d-a6dd-e38b12c769ee.mp4

## Usage

To enable typewriter sounds, trigger `:TypewriterEnable`. To stop, use `:TypewriterDisable`. `:TypewriterToggle` will switch on an off and might be useful for a mapping. You can set `g:typewriter_enabled` to `v:true` to start with typewriter mode on.

Going into insert mode will trigger a carriage return, exiting insert mode will ding and typing makes clicking sounds. That's probably not realistic, but it sounds kind of nice.

The clicks are randomized and throttled to a maximum of 6 at a time, since that sounded like the right limit to me. You can adjust `g:typewriter_throttle` or set it to 0 to avoid throttling and get all the clicks at a time you can manage to produce.

## Requirements

You'll need Vim9 with `+sound`. This should be included in the "huge" build by default, so if you don't have it, look for a more inclusive build in your package manager.

Neovim doesn't have `+sound` at the time of writing, but I might accept a PR that spawns an external sound player on neovim.

## References

The [vim-keysound](https://github.com/skywind3000/vim-keysound) plugin by @skywind3000 has a greater variety of sounds, but it requires python and SDL2 to run. It could be a good option for older Vims or Neovim.

Another program that listens to key presses in X11, not necessarily tied to Vim (also requires SDL2, zig): .

There's an existing colorcheme called `typewriter-vim`: . I'd be open to renaming the project to avoid confusion, but I'd appreciate a good naming suggestion.

The sounds are from freesound.org:

- Ding: 

- Clicks: 

- Carriage return: 

## Contributing

Pull requests are welcome. Be sure to abide by the [CODE_OF_CONDUCT.md](https://github.com/AndrewRadev/typewriter.vim/blob/master/CODE_OF_CONDUCT.md).