The plugin in question, cord.nvim, has been rewritten from scratch with a new client-server architecture in mind, bringing significant improvements in reliability and customization. Here's what you need to know when upgrading.

• We have switched to Cargo for building instead of directly calling rustc in build scripts, which often caused inconsistencies. But don't worry, the dependency count is still at zero! Plus, users can benefit from incremental builds.

• The plugin now runs as a server that handles all your Neovim instances. When you start Neovim, it launches a server in the background and connects to it. Any additional Neovim instances will connect to the same server, ensuring only one Rich Presence is shown. The most recent activity always takes priority.

• A new smart idle system has been implemented - you're only shown as idle when all your Neovim instances are actually idle. When an instance goes idle, it automatically switches back to show your most recent active one.

• The plugin is now event-driven, meaning changes are reflected instantly without any polling delays. When all instances disconnect, the server, as well as the connection to Discord, stay alive for a little while (configurable) before shutting down, which helps to avoid rate limiting issues.

• A new variables option allows users to define custom variables, including functions, for dynamic text templates. This enhances the flexibility and customization of the Rich Presence display.

• Many of the icons have been redesigned, and a new theme has been introduced. The previous style, now called "Pastel" has been replaced with the new default style, "Onyx" which features a sleek and modern dark theme. You can switch between themes by using the display.theme option.

The biggest change in v2 is the shift towards function-based configuration. Almost every string option can now be a Lua function! This unlocks powerful dynamic customization:

• Dynamic Text: Use functions in text options to create context-aware presence messages based on filetype, workspace, time, and more (see Examples).
• Dynamic Buttons: Create buttons with labels and URLs that change based on the current Neovim state.
• Dynamic Assets: Customize icons and asset text dynamically using functions in the assets table.
• Hooks for Advanced Logic: Use hooks to execute custom Lua code at various points in Cord's update cycle, enabling complex integrations and behaviors.

Example: Dynamic Editing Text based on Filetype

text = {
    editing = function(opts)
        if opts.filetype == 'rust' then
            return '🦀 Crafting in Rust' -- Fun Rust-specific text
        else
            return 'Editing ' .. opts.filename -- Default editing text
        end
    end,
}

Example: Dynamic Button Label

buttons = {
    {
        label = function(opts)
            return opts.repo_url and 'View Repository' or 'View cord.nvim'
        end,
        url = function(opts)
            return opts.repo_url or 'https://github.com/vyfor/cord.nvim'
        end
    }
}

1. Update Cord Plugin: Use your plugin manager to update cord.nvim.
2. Run :Cord update: In Neovim, run :Cord update to download the new server executable.
3. Review Your Configuration: Carefully review your cord.setup() configuration and update it to the v2 structure, taking into account the renamed and removed options.
4. Explore Examples & Documentation: Check out the Examples page and the Configuration Guide to learn about the new customization options and how to use functions and hooks.
5. Test and Customize: Start using Cord v2 and customize your presence to your liking! Use :checkhealth cord to verify your configuration.

Need Help?

If you encounter any issues during migration or have questions, please don't hesitate to:

• Check the Troubleshooting Guide
• Join our Discord Community
• Start a Discussion on GitHub

Welcome to the future of Neovim Rich Presence with Cord v2! We're confident you'll love the enhanced power and flexibility. Happy coding!