Another Neovim Discord RPC plugin
BSD-2-CLAUSE License
A Discord Rich Presence plugin for Neovim written in Lua.
{
'ObserverOfTime/nvimcord',
opts = {
...
}
}
{
'ObserverOfTime/nvimcord',
config = function()
require('nvimcord').setup {
...
}
end
}
These are the default values:
-- 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.
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 = ''
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
Start or update the rich presence.
Stop the rich presence.
List the supported filetypes.
List the supported assets.
The assets are available here.
The icons use the basic colours from file-icons/atom.