Skip to content

circles-00/nvim-discord-status

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Neovim Discord Status

This plugin utilizes the Discord Rich Presence API to display your current Neovim status on your Discord profile.

The plugin is written in Lua and GoLang.

The GoLang part is used to create a binary that communicates with Neovim and Discord. The Lua part is used to call the binary and set the status. The GoLang application is a simple TCP server that listens for connections from Neovim and updates the status accordingly.

The lua part creates a TCP connection to the GoLang server and sends the status to be updated.

Installation

Using LazyVim

return { 'circles-00/nvim-discord-status' }

Using Packer

use("circles-00/nvim-discord-status")

Using Vim-Plug

Plug 'circles-00/nvim-discord-status'

Setup

You need to create a Discord application and get the client ID. You can do this by going to the Discord Developer Portal and creating a new application. Also make sure that you have enabled sharing your activity in your Discord Settings.

Once you have the client ID, you can set it in your init.vim or init.lua file.

You can also exclude certain directories from being displayed in the status by setting the excludedDirs option. If you're currently working in a directory that is included in the excludedDirs, the status will show [REDACTED], for that particular directory.

local nvim_discord_status = require("nvim-discord-status")

nvim_discord_status:setup({
   discordAppId  = "YOUR_APP_ID",
   excludedDirs = { "some_dir" },
   cmdBinding  = "<C-x>"
})

Usage

The plugin will automatically start when you open Neovim. The status will be updated when you open a new file or switch buffers.

The status will dissapear when you close all instances of Neovim.

Comands

  • Toggle the current repository to be REDACTED or not. You can overwrite a binding via opts, or use the default one (seen above), or call :Redact command

Screenshots

image

Redacted:

image

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published