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.

Plugin default: false

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.presence-nvim.package

Which package to use for the presence-nvim plugin.

Type: package

Default: <derivation vimplugin-presence.nvim-2023-01-29>

Declared by:

plugins.presence-nvim.autoUpdate

Update activity based on autocmd events. If false, map or manually execute :lua package.loaded.presence:update()

Plugin default: true

Type: null or boolean or raw lua code

Default: null

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.

Plugin default: []

Type: null or (list of string)

Default: null

Declared by:

plugins.presence-nvim.buttons

Button configurations which will always appear in Rich Presence.

Can be a list of attribute sets, each with the following attributes:

label: The label of the button. e.g. "GitHub Profile".

url: The URL the button leads to. e.g. "https://github.com/<NAME>".

Can also be a lua function: function(buffer: string, repo_url: string|nil): table)

Plugin default: []

Type: null or raw lua code or list of (submodule)

Default: null

Declared by:

plugins.presence-nvim.clientId

Use your own Discord application client id. (not recommended)

Plugin default: "793271441293967371"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.presence-nvim.debounceTimeout

Number of seconds to debounce events. (or calls to :lua package.loaded.presence:update(<filename>, true))

Plugin default: 10

Type: null or signed integer or floating point number or raw lua code

Default: null

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

Plugin default: Editing %s

Type: null or string or raw lua code

Default: null

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

Plugin default: Browsing %s

Type: null or string or raw lua code

Default: null

Declared by:

plugins.presence-nvim.gitCommitText

String rendered when committing changes in git.

Can also be a lua function: function(filename: string): string

Plugin default: Committing changes

Type: null or string or raw lua code

Default: null

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

Plugin default: Line %s out of %s

Type: null or string or raw lua code

Default: null

Declared by:

plugins.presence-nvim.logLevel

Log messages at or above this level.

Plugin default: null

Type: null or one of “debug”, “info”, “warn”, “error” or raw lua code

Default: null

Declared by:

plugins.presence-nvim.mainImage

Main image display.

Plugin default: "neovim"

Type: null or one of “neovim”, “file” or raw lua code

Default: null

Declared by:

plugins.presence-nvim.neovimImageText

Text displayed when hovered over the Neovim image.

Plugin default: "The One True Text Editor"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.presence-nvim.pluginManagerText

String rendered when managing plugins.

Can also be a lua function: function(plugin_manager_name: string): string

Plugin default: Managing plugins

Type: null or string or raw lua code

Default: null

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

Plugin default: Reading %s

Type: null or string or raw lua code

Default: null

Declared by:

plugins.presence-nvim.showTime

Show the timer.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

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

Plugin default: Working on %s

Type: null or string or raw lua code

Default: null

Declared by: