cord-nvim 2.0.1

cord-nvim-2.0.1 is not a library.

[!IMPORTANT] Cord no longer requires Rust to be installed. Rust component will be automatically downloaded from GitHub Releases.

💎 Features

🌐 Client-Server Design — Handles multiple Neovim instances with a single connection to Discord.
⚡ Performance in Mind — Lightweight, dependency-free, with blazingly-fast startup.
🚀 Event-Driven Architecture — Instant presence updates with zero delays.
🎨 Customizable Templates — Dynamic string templates with custom variables.
🔧 Unmatched Configurability — Function-based configuration for infinite customization possibilities.
🧠 Automated State Handling — Automatically manages activities across all instances.
💤 Smart Idle Detection — Identifies idle sessions and switches to the most recent non-idle session.
🛠️ Built-in Git Integration — Detects repositories and workspaces based on VCS files without relying on command-line tools.
🗃️ Custom Assets — Extendable with fully customizable assets for any file/buffer type.
⚙️ Robust User Commands - Quickly manage Cord and its features through user commands and easily create your own keybindings.
🔌 Plugin System — Extendable with custom plugins, with a plethora of built-in ones out of the box.
📦 Wide Compatibility - Compatible with various Discord installations (Snap, Flatpak) and able to work inside WSL and Discord in browser.
🌍 Cross-Platform — Supports Windows, Linux, macOS, and FreeBSD.
🌸 Rich Icon Collection — Features 120+ uniquely designed themed icons for 200+ file types and plugins.
🔁 Automatic Reconnection — Able to reconnect to Discord if the connection is lost.

📦 Install

Considerations

Cord requires the server executables to be present. To get it, you can either:

Fetch from GitHub: Invoking :Cord build [fetch] (async, recommended). Make sure you have curl installed.
Download from GitHub: Get latest release from https://github.com/vyfor/cord.nvim/releases/latest, rename it to cord[.exe] and place it under nvim-data-dir/cord/bin
Build from source

Installation

{
  'vyfor/cord.nvim',
  build = ':Cord update',
  -- opts = {}
}

use {
  'vyfor/cord.nvim',
  run = ':Cord update',
  -- config = function()
  --   require('cord').setup {}
  -- end
}

Cord is available on LuaRocks.

:Rocks install cord.nvim

Invoke :Cord update whenever the plugin is updated.

Unix:

git clone --single-branch https://github.com/vyfor/cord.nvim ~/.local/share/nvim/site/pack/plugins/start/cord.nvim

Windows:

git clone --single-branch https://github.com/vyfor/cord.nvim $LOCALAPPDATA/nvim-data/site/pack/plugins/start/cord.nvim

Invoke :Cord update whenever the plugin is updated.

🎨 Themes

Cord features over 120 beautifully designed icons for languages and components with distinct themes, with more to come!

👉 Explore the Showcase

📖 Documentation

Configuration Guide: Everything you need to customize Cord.
Examples: Creative ways to customize your Discord presence.
Migration Guide: Smooth migration from Cord v1.
Wiki: Examples, best practices, and FAQs.

🤝 Contributing

We welcome contributions to make Cord even better!

Check out our Contribution Guidelines.

❓ FAQ

Have questions or issues?

Troubleshooting Guide

🛠️ Build From Source

[!NOTE] Make sure you have Rust >= 1.85.0 installed.

To build Cord from source, you can run :Cord update build (async) which will install the server binary from crates.io by running the following command:

cargo install --path . --root path/to/nvim-data-dir/cord/bin --force

Alternatively, you can use cargo b --release to build the binary, then place it under nvim-data-dir/cord/bin.