README.md

🐱 beastie.nvim

A fun and lightweight Neovim plugin that brings emoji as your beastie while coding.

cropped-beastie.mp4

Installation

Lazy

  {
    "Abizrh/beastie.nvim",
    lazy = false, -- needed so the your beastie can start at launch
    opts = {
      beasties = {
        {
          name = "cat",
          frames = { "🐱", "😺", "😸", "😹", "😼", "😽" }
        },
        {
          name = "dog",
          frames = { "🐶", "🐕", "🦮", "🐕" }
        },
        {
          name = "bird",
          frames = { "🐦", "🐤", "🐧", "🦜" }
        }
      },
      start_at_launch = true,
      animation_speed = 200, -- ms
      active_beastie = "cat", 
      animation = "random", -- "cursor" | "random"
    },
  },

Usage

Command	Description
:BeastieStart	Start your Beastie
:BeastieStop	Stop your Beastie
:BeastieSwitch name	Switch to a specific beastie [given name]

Configuration

Option	Type	Default	Description
beastie	table	{ {name = 'cat', frames = {'🐱', '😺', '😸', '😹', '😼', '😽'}} }	The list of beasties to choose from
animation_speed	number	200	The speed of the animation
start_at_launch	boolean	false	Start the animation at launch
active_beastie	string	"cat"	The name of the active beastie
animation	random or cursor	"random"	Type of animation to use