Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skywind3000/vim-keysound
:wine_glass: Play typewriter sound in Vim when you are typing a letter
https://github.com/skywind3000/vim-keysound
Last synced: 14 days ago
JSON representation
:wine_glass: Play typewriter sound in Vim when you are typing a letter
- Host: GitHub
- URL: https://github.com/skywind3000/vim-keysound
- Owner: skywind3000
- License: mit
- Created: 2018-05-01T09:11:51.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-10T18:51:48.000Z (over 1 year ago)
- Last Synced: 2024-08-01T16:56:21.829Z (3 months ago)
- Language: Vim Script
- Homepage:
- Size: 1010 KB
- Stars: 111
- Watchers: 6
- Forks: 16
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# What is it ?
It's cool to play typewriter sound in Vim when you are typing a letter. :sunglasses:
:zap: You can use it along with the [typewriter color scheme](https://github.com/logico-dev/typewriter), and feel like you are really working on a typewriter.
Enjoy the rhythm of your code, gain the power from the sound, become productive in vim. :wine_glass:
See [this video](https://streamable.com/yah0h) by Keefle (there is no audio delay in reality).
# Installation
## vim-plug
```VimL
Plug 'skywind3000/vim-keysound'
```
## vundle
```VimL
Plugin 'skywind3000/vim-keysound'
```
# Configuration
Enable keysound from start:
```VimL
let g:keysound_enable = 1
```
Command `:KeysoundEnable` and `:KeysoundDisable` can be used to manually start/stop the plugin if `g:keysound_enable` is not assigned.
Choose a sound theme:
```VimL
let g:keysound_theme = 'default'
```
Then the plugin will work and you can enjoy sound effect when you are typing in insert mode.
Avaliable themes are:
- `default`
- `typewriter`
- `mario`
- `sword`
- `bubble`
Additional sound themes can be found in `sounds` directory in your `runtimepath`, that is your `~/.vim/sounds` or `/path-to-dotfiles/sounds`.
Change python version:
```VimL
let g:keysound_py_version = 3
```
Both 2 and 3 are available. It is assigned to zero by default, and will choose python automatically, change it to 2 or 3 if you need specify the python version.
Change volume:
```VimL
let g:keysound_volume = 500
```
The volume is initialized to 500 by default, and should be in range of [0, 1000].
# Function
keysound provide a function to allow you play any wav file in vim.
```VimL
keysound#playsound(wavfile, volume)
```
`wavfile` is the path of your `.wav` file, `volume` is an integer with range of 0-1000.
## Requirements
- Python or Python3 integration in vim
- [PySDL2](https://github.com/marcusva/py-sdl2) with SDL2 binaries.
PySDL2 is used to provide low-latency audio playback.
### Ubuntu
Just install `python-sdl2` or `python3-sdl2` with `apt-get`, depend on your python version in vim:
```bash
apt-get install python-sdl2
```
or
```bash
apt-get install python3-sdl2
```
### openSUSE
Install `python-sdl2` or `python3-sdl2` and `libSDL2_mixer-2_0-0` with `zypper`, depend on your python version in vim:
```bash
zypper install python-sdl2 libSDL2_mixer-2_0-0
```
or
```bash
zypper install python3-sdl2 libSDL2_mixer-2_0-0
```
### Windows
Install pysdl2 in python or python3:
```batch
pip install pysdl2
```
or
```batch
pip3 install pysdl2
```
Download `SDL2.dll` from [here](https://www.libsdl.org/download-2.0.php), `SDL2_mixer.dll` from [here](https://www.libsdl.org/projects/SDL_mixer/). Put the two files into your python's installation directory.
You can verify your SDL2 installation by `python -c "import sdl2"`. If there is no exceptions, your installation is fine.
### Mac OS X
Install pysdl2 in python or python3:
```batch
pip install pysdl2
```
or
```batch
pip3 install pysdl2
```
Install sdl2 with brew:
```batch
brew install sdl2
```
In alternative, it is possible to install the `pysdl2-dll`, a package that bundles the binary for `sdl2` for Windows and macOS.
```bash
pip3 install pysdl2-dll
```
# About
TODO