README.md

party.nvim

Need a break from the monotony of standard syntax highlighting? Feeling too productive at work lately? Well, you can change all that with party.nvim! This plugin will turn your code editor into a party 🎉 transforming your text into a neon dance floor 🕺💃!

Instsallation

• Using lazy.nvim

{
    'neysanfoo/party.nvim'
}

• Using packer.nvim

use 'neysanfoo/party.nvim'

Quick Start

Setup

Setup the plugin in the appropriate file.

require('party').setup({})

Custom Mappings

You can configure the plugin by adding these settings to your configuration:

require('party').setup({
  background = 'current', -- 'current' (uses the background color of your current colorscheme) or 'default' (uses default Neovim background color)
	colors = {  -- These are the default colors
		"#FF0000", -- Red
		"#FF7F00", -- Orange
		"#FFFF00", -- Yellow
		"#7FFF00", -- Chartreuse
		"#00FF00", -- Green
		"#00FF7F", -- SpringGreen
		"#00FFFF", -- Cyan
		"#007FFF", -- Azure
		"#0000FF", -- Blue
		"#7F00FF", -- Violet
		"#FF00FF", -- Magenta
		"#FF007F", -- Rose
	},
  interval = 500 -- Set the interval (in milliseconds) for changing colors. Lowest possible value is 200.
})

For Terminals Without GUI Colors (termguicolors is not set)

If you wish to use custom colors, you must be running in an environment with termguicolors enabled. Otherwise, the plugin will default to the predefined terminal color set.

Usage

:PartyToggle - Toggle the party mode.

Recommended Keybinding

You can easily toggle the party on and off using this recommended keybinding:

vim.api.nvim_set_keymap('n', '<leader>lol', ':PartyToggle<CR>', { noremap = true, silent = true })

Enjoy the party! 🎉🌈🕺💃🎶