Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vimsence/vimsence
Discord Rich Presence plugin for Vim
https://github.com/vimsence/vimsence
discord rich-presence vim
Last synced: about 2 months ago
JSON representation
Discord Rich Presence plugin for Vim
- Host: GitHub
- URL: https://github.com/vimsence/vimsence
- Owner: vimsence
- License: mit
- Fork: true (anned20/vimsence)
- Created: 2019-04-28T16:20:03.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-17T07:51:11.000Z (7 months ago)
- Last Synced: 2024-07-31T15:10:41.231Z (5 months ago)
- Topics: discord, rich-presence, vim
- Language: Python
- Homepage:
- Size: 89.8 KB
- Stars: 194
- Watchers: 4
- Forks: 24
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
VimSence
## Getting Started
These instructions will get you a copy of the project up and running on your local machine.
More help about the plugin itself can be found [here](doc/vimsence.txt).
### Prerequisites
You need to have Vim/NeoVim with Python3 support
### Installing
#### [Vim-Plug](https://github.com/junegunn/vim-plug)
1. Add `Plug 'vimsence/vimsence'` to your vimrc file.
2. Reload your vimrc or restart
3. Run `:PlugInstall`
#### [Vundle](https://github.com/VundleVim/Vundle.vim) or similar
1. Add `Plugin 'vimsence/vimsence'` to your vimrc file.
2. Reload your vimrc or restart
3. Run `:BundleInstall`
#### [NeoBundle](https://github.com/Shougo/neobundle.vim)
1. Add `NeoBundle 'vimsence/vimsence'` to your vimrc file.
2. Reload your vimrc or restart
3. Run `:NeoUpdate`
#### [Dein.vim](https://github.com/Shougo/dein.vim)
1. Add `call dein#add('vimsence/vimsence')` to your vimrc file.
2. Reload your vimrc or restart
3. Run `:call dein#install()`
#### [Pathogen](https://github.com/tpope/vim-pathogen)
```sh
cd ~/.vim/bundle
git clone https://github.com/vimsence/vimsence.git
```
#### Vim8 packages
```sh
git submodule add https://github.com/vimsence/vimsence.git vimsence
```
## Configuration
You can configure the messages of VimSence in your `.vimrc` with these options:
```vim
let g:vimsence_client_id = '439476230543245312'
let g:vimsence_small_text = 'NeoVim'
let g:vimsence_small_image = 'neovim'
let g:vimsence_editing_details = 'Editing: {}'
let g:vimsence_editing_state = 'Working on: {}'
let g:vimsence_file_explorer_text = 'In NERDTree'
let g:vimsence_file_explorer_details = 'Looking for files'
let g:vimsence_custom_icons = {'filetype': 'iconname'}
```
## Development
First create a virtual environment.
If you don’t already have a preferred way to do this,
take some time to look at tools like pew, virtualfish, and virtualenvwrapper.
Install the development dependencies:
```sh
pip install -r requirements-dev.txt
```
To avoid committing code that violates our style guide, we strongly advise you to install [pre-commit](https://pre-commit.com/) hooks:
```sh
pre-commit install
```
You can also run them anytime using:
```sh
pre-commit run --all-files
```
## Authors
| Contributor | What has been done |
|-------------------------------------------------------------------------------------------------------------------------------------|-----------------------|
| 
[Anne Douwe Bouma](https://github.com/anned20) | Original work |
| 
[Hugo Lageneste](https://github.com/hugolgst) | Maintaining this fork |
See also the list of [contributors](https://github.com/vimsence/vimsence/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details