vimsence.nvim

Getting Started

These instructions will get you a copy of the project up and running on your local machine. More help about the plugin itself can be found here.

Prerequisites

• Neovim: Requires Neovim 0.7+ with Lua support

Installing

lazy.nvim

{
  'codebam/vimsence.nvim',
  config = function()
    require('vimsence').setup()
  end
}

packer.nvim

use {
  'codebam/vimsence.nvim',
  config = function()
    require('vimsence').setup()
  end
}

vim-plug

Add to your init.lua or init.vim:

Plug 'codebam/vimsence.nvim'

Other Plugin Managers

Use the same plugin specification: 'codebam/vimsence.nvim'

Configuration

Configure vimsence.nvim using the setup() function:

require('vimsense').setup({
  client_id = '439476230543245312',
  small_text = 'Neovim',
  small_image = 'neovim',
  editing_details = 'Editing: {}',
  editing_state = 'Working on: {}',
  editing_large_text = 'Editing a {} file',
  file_explorer_text = 'In the file explorer',
  file_explorer_details = 'Looking for files',
  ignored_file_types = {'help', 'nerdtree'},
  ignored_directories = {'.git', 'node_modules'},
  custom_icons = {python = 'py', javascript = 'js'},
  discord_flatpak = false  -- Enable for Flatpak Discord on Linux
})

Commands

• :DiscordUpdatePresence - Manually update Discord presence
• :DiscordReconnect - Reconnect to Discord
• :DiscordDisconnect - Disconnect from Discord

Development

This plugin is written in Lua for Neovim. To develop:

1. Fork and clone the repository
2. Make changes to the Lua files in lua/vimsence/
3. Test with your Neovim configuration
4. Submit a pull request

Authors

Contributor	What has been done
Anne Douwe Bouma	Original work
Hugo Lageneste	Maintaining this fork

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details