plugins.presence-nvim.enable
Whether to enable presence-nvim.
Type: boolean
Default:
false
Example:
true
Declared by:
plugins.presence-nvim.enableLineNumber
Displays the current line number instead of the current project.
Type: null or boolean or raw lua code
Default:
null
Plugin default: false
Declared by:
plugins.presence-nvim.package
The presence-nvim package to use.
Type: package
Default:
pkgs.vimPlugins.presence-nvim
Declared by:
plugins.presence-nvim.autoUpdate
Update activity based on autocmd events.
If false
, map or manually execute
:lua package.loaded.presence:update()
Type: null or boolean or raw lua code
Default:
null
Plugin default: true
Declared by:
plugins.presence-nvim.blacklist
A list of strings or Lua patterns that disable Rich Presence if the current file name, path, or workspace matches.
Type: null or (list of (string or raw lua code))
Default:
null
Plugin default: [ ]
Declared by:
plugins.presence-nvim.clientId
Use your own Discord application client id. (not recommended)
Type: null or string or raw lua code
Default:
null
Plugin default: "793271441293967371"
Declared by:
plugins.presence-nvim.debounceTimeout
Number of seconds to debounce events.
(or calls to :lua package.loaded.presence:update(<filename>, true)
)
Type: null or signed integer or floating point number or raw lua code
Default:
null
Plugin default: 10
Declared by:
plugins.presence-nvim.editingText
String rendered when an editable file is loaded in the buffer.
Can also be a lua function:
function(filename: string): string
Type: null or string or raw lua code
Default:
null
Plugin default: "Editing %s"
Declared by:
plugins.presence-nvim.extraOptions
These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.
Type: attribute set of anything
Default:
{ }
Declared by:
plugins.presence-nvim.fileAssets
Custom file asset definitions keyed by file names and extensions.
List elements for each attribute (filetype):
name
: The name of the asset shown as the title of the file in Discord.
source
: The source of the asset, either an art asset key or the URL of an image asset.
Example:
{
# Use art assets uploaded in Discord application for the configured client id
js = [ "JavaScript" "javascript" ];
ts = [ "TypeScript" "typescript" ];
# Use image URLs
rs = [ "Rust" "https://www.rust-lang.org/logos/rust-logo-512x512.png" ];
go = [ "Go" "https://go.dev/blog/go-brand/Go-Logo/PNG/Go-Logo_Aqua.png" ];
};
Type: null or (attribute set of list of string)
Default:
null
Declared by:
plugins.presence-nvim.fileExplorerText
String rendered when browsing a file explorer.
Can also be a lua function:
function(file_explorer_name: string): string
Type: null or string or raw lua code
Default:
null
Plugin default: "Browsing %s"
Declared by:
plugins.presence-nvim.gitCommitText
String rendered when committing changes in git.
Can also be a lua function:
function(filename: string): string
Type: null or string or raw lua code
Default:
null
Plugin default: "Committing changes"
Declared by:
plugins.presence-nvim.lineNumberText
String rendered when enableLineNumber
is set to true
to display the current line number.
Can also be a lua function:
function(line_number: number, line_count: number): string
Type: null or string or raw lua code
Default:
null
Plugin default: "Line %s out of %s"
Declared by:
plugins.presence-nvim.logLevel
Log messages at or above this level.
Type: null or one of “debug”, “info”, “warn”, “error” or raw lua code
Default:
null
Plugin default: null
Declared by:
plugins.presence-nvim.mainImage
Main image display.
Type: null or one of “neovim”, “file” or raw lua code
Default:
null
Plugin default: "neovim"
Declared by:
plugins.presence-nvim.neovimImageText
Text displayed when hovered over the Neovim image.
Type: null or string or raw lua code
Default:
null
Plugin default: "The One True Text Editor"
Declared by:
plugins.presence-nvim.pluginManagerText
String rendered when managing plugins.
Can also be a lua function:
function(plugin_manager_name: string): string
Type: null or string or raw lua code
Default:
null
Plugin default: "Managing plugins"
Declared by:
plugins.presence-nvim.readingText
String rendered when a read-only/unmodifiable file is loaded into the buffer.
Can also be a lua function:
function(filename: string): string
Type: null or string or raw lua code
Default:
null
Plugin default: "Reading %s"
Declared by:
plugins.presence-nvim.showTime
Show the timer.
Type: null or boolean or raw lua code
Default:
null
Plugin default: true
Declared by:
plugins.presence-nvim.workspaceText
String rendered when in a git repository.
Can also be a lua function:
function(project_name: string|nil, filename: string): string
Type: null or string or raw lua code
Default:
null
Plugin default: "Working on %s"
Declared by: