presence.nvim/README.md

​

Discord Rich Presence plugin for Neovim

Features

• Simple and unobtrusive
• Support for macOS, Linux, and Windows*
• No Python/Node providers (or CoC) required
• Startup time is fast(er than other Rich Presence plugins, by kind of a lot)
• Written in Lua and configurable in Lua (but also configurable in VimL if you want)

Installation

Use your favorite plugin manager

• packer: use 'andweeb/presence.nvim'
• vim-plug: Plug 'andweeb/presence.nvim'

Notes

• Requires Neovim nightly (0.5)
• Windows is partially supported
  • Can update Rich Presence as expected
  • Does not yet properly handle multiple running nvim instances

Configuration

Rich Presence works right out of the box after installation by default, so configuration is optional. For those that do want to override default behaviors, however, configuration options are available in both Lua and VimL.

Lua

Require the plugin and call setup with a config table with any of the following keys:

Presence = require("presence"):setup({
    -- This config table shows all available config options with their default values
    auto_update       = true,                       -- Update activity based on autocmd events (if `false`, map or manually execute `:lua Presence:update()`)
    editing_text      = "Editing %s",               -- Editing format string (either string or function(filename: string|nil, buffer: string): string)
    workspace_text    = "Working on %s",            -- Workspace format string (either string or function(git_project_name: string|nil, buffer: string): string)
    neovim_image_text = "The One True Text Editor", -- Text displayed when hovered over the Neovim image
    main_image        = "neovim",                   -- Main image display (either "neovim" or "file")
    client_id         = "793271441293967371",       -- Use your own Discord application client id (not recommended)
    log_level         = nil,                        -- Log messages at or above this level (one of the following: "debug", "info", "warn", "error")
    debounce_timeout  = 15,                         -- Number of seconds to debounce TextChanged events (or calls to `:lua Presence:update(<buf>, true)`)
})

VimL

Or if global variables are more your thing, you can use any of the following instead:

let g:presence_auto_update       = 1
let g:presence_editing_text      = "Editing %s"
let g:presence_workspace_text    = "Working on %s"
let g:presence_neovim_image_text = "The One True Text Editor"
let g:presence_main_image        = "neovim"
let g:presence_client_id         = "793271441293967371"
let g:presence_log_level
let g:presence_debounce_timeout  = 15

Contributing

Pull requests are very welcome, feel free to open an issue! Here some open todo items:

• Manage workspace state across multiple nvim instances (e.g. tmux)
• Set activity on other autocommands (TextChanged, VimLeavePre)
• Use named pipes to support Windows
• Set idle activity (track using CursorMoved)
• Expose file assets table as a configurable option
• Fix peer-to-peer nvim instance communication in Windows
• Manage activity properly in buffers in windows and tabs
• Retry connection after initial setup or a closed pipe (i.e. after quitting Discord app)
• Attempt to connect to a range of pipes from discord-ipc-0 to discord-ipc-9 (see note)

Asset additions and changes are also welcome! Supported file types can be found in file_assets.lua and their assets can be found in this folder.