https://github.com/observeroftime/nvimcord
Another Neovim Discord RPC plugin
https://github.com/observeroftime/nvimcord
discord discord-rpc neovim neovim-plugin nvim-lua
Last synced: 8 months ago
JSON representation
Another Neovim Discord RPC plugin
- Host: GitHub
- URL: https://github.com/observeroftime/nvimcord
- Owner: ObserverOfTime
- License: bsd-2-clause
- Created: 2022-03-19T13:34:35.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-23T10:33:00.000Z (9 months ago)
- Last Synced: 2025-04-30T22:49:36.881Z (8 months ago)
- Topics: discord, discord-rpc, neovim, neovim-plugin, nvim-lua
- Language: Lua
- Homepage:
- Size: 61.5 KB
- Stars: 19
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# nvimcord
A Discord Rich Presence plugin for Neovim written in Lua.
## Installation
### lazy.nvim
```lua
{
'ObserverOfTime/nvimcord',
opts = {
...
}
}
```
### pckr.nvim
```lua
{
'ObserverOfTime/nvimcord',
config = function()
require('nvimcord').setup {
...
}
end
}
```
## Configuration
These are the default values:
```lua
-- Start the RPC manually (boolean)
autostart = false
-- Set the client ID (string)
client_id = '954365489214291979'
-- Update workspace on chdir (boolean)
dynamic_workspace = false
-- Use the filetype as the large icon (boolean)
large_file_icon = true
-- Set the log level (vim.log.levels.*)
log_level = vim.log.levels.INFO
-- Get the workspace name (function|string)
workspace_name = function()
return --[[git root or cwd basename]]
end
-- Get the workspace URL (function|string)
workspace_url = function()
return --[[git remote URL]]
end
```
Options can also be configured using Vim variables.
This can be useful when using [exrc] or a project plugin.
```vim
let g:nvimcord#autostart = v:false
let g:nvimcord#client_id = '954365489214291979'
let g:nvimcord#dynamic_workspace = v:false
let g:nvimcord#large_file_icon = v:true
let g:nvimcord#log_level = 2
" NOTE: these can only be defined as strings
let g:nvimcord#workspace_name = ''
let g:nvimcord#workspace_url = ''
```
[exrc]: https://neovim.io/doc/user/starting.html#exrc
### Filetypes
```lua
local fts = require 'nvimcord.filetypes'
-- NOTE: the asset can also be an image URL
-- override options
fts.filetype['vim'].name = 'Vim Script'
fts.filetype['vim'].asset = 'neovim'
-- new filetype
fts.filetype['teal'] = {name = 'Teal', asset = 'lua'}
-- new pattern
fts.pattern['^%.gitkeep$'] = {name = 'git keep', asset = 'git'}
-- ignore filetype
fts.ignore.filetype['vim'] = true
-- ignore filename
fts.ignore.filename['init.vim'] = true
```
## Commands
#### :NvimcordUpdate
Start or update the rich presence.
#### :NvimcordStop
Stop the rich presence.
#### :NvimcordFiletypes
List the supported filetypes.
#### :NvimcordAssets
List the supported assets.
## TODO
* [x] Ignore by filename
* [ ] Cache filename patterns
* [x] Detect workspace through git
* [x] Warn when pipe doesn't exist
* [ ] Set idle status after some time
## Assets
The assets are available [here][disroot].
### Sources
- [file-icons/icons](https://github.com/file-icons/icons)
- [file-icons/DevOpicons](https://github.com/file-icons/DevOpicons)
- [file-icons/MFixx](https://github.com/file-icons/MFixx)
- [primer/octicons](https://github.com/primer/octicons)
### Palette
The icons use the basic colours from [file-icons/atom][colours].
-  red
-  green
-  yellow
-  blue
-  maroon
-  purple
-  orange
-  cyan
-  pink
-  grey
[disroot]: https://cloud.disroot.org/s/3HCpppopkrcR6iK
[colours]: https://github.com/file-icons/atom/blob/master/styles/colours.less#L10-L19
## Alternatives
- [amiralies/coc-discord] (TypeScript)
- [andweeb/presence.nvim] (Lua)
- [aurieh/discord.nvim] (Remote Python)
- [or my own fork][ObserverOfTime/discord.nvim]
- [Cyuria/discord.nvim] (Lua + C++)
- [GabeFrahm/vim-presence] (Python)
- [goopey7/vdrpc] (VimL + C)
- [IogaMaster/neocord] (Lua)
- [LeonardSSH/coc-discord-rpc] (TypeScript)
- [lpturmel/discord.nvim] (Lua + Rust)
- [SamJakob/coc-discord-presence] (TypeScript)
- [sardonicism-04/nvim-rich-presence] (VimL + Rust)
- [Stoozy/vimcord] Python
- [TCL100K/vim-discord-rpc] (Python)
- [vbe0201/vimdiscord] (Python)
- [vyfor/cord.nvim] (Lua + Rust)
[amiralies/coc-discord]: https://github.com/amiralies/coc-discord
[andweeb/presence.nvim]: https://github.com/andweeb/presence.nvim
[aurieh/discord.nvim]: https://github.com/aurieh/discord.nvim
[Cyuria/discord.nvim]: https://github.com/Cyuria/discord.nvim
[GabeFrahm/vim-presence]: https://github.com/GabeFrahm/vim-presence
[goopey7/vdrpc]: https://github.com/goopey7/vdrpc
[IogaMaster/neocord]: https://github.com/IogaMaster/neocord
[LeonardSSH/coc-discord-rpc]: https://github.com/LeonardSSH/coc-discord-rpc
[lpturmel/discord.nvim]: https://github.com/lpturmel/discord.nvim
[ObserverOfTime/discord.nvim]: https://github.com/ObserverOfTime/discord.nvim
[SamJakob/coc-discord-presence]: https://github.com/SamJakob/coc-discord-presence
[sardonicism-04/nvim-rich-presence]: https://github.com/sardonicism-04/nvim-rich-presence
[Stoozy/vimcord]: https://github.com/Stoozy/vimcord
[TCL100K/vim-discord-rpc]: https://github.com/TCL100K/vim-discord-rpc
[vbe0201/vimdiscord]: https://github.com/vbe0201/vimdiscord
[vyfor/cord.nvim]: https://github.com/vyfor/cord.nvim