diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/pets.nvim.txt | 127 |
1 files changed, 0 insertions, 127 deletions
diff --git a/doc/pets.nvim.txt b/doc/pets.nvim.txt index 95eeacb..f28f62e 100644 --- a/doc/pets.nvim.txt +++ b/doc/pets.nvim.txt @@ -4,13 +4,6 @@ Table of Contents *pets.nvim-table-of-contents* 1. pets.nvim |pets.nvim-pets.nvim| - - π¦ Installation |pets.nvim-π¦-installation| - - βοΈ Configuration |pets.nvim-βοΈ-configuration| - - πΎ Available pets |pets.nvim-πΎ-available-pets| - - π Usage - commands |pets.nvim-π-usage---commands| - - β οΈ Limitations |pets.nvim-β οΈ-limitations| - - βοΈ Roadmap |pets.nvim-βοΈ-roadmap| - - π Credits |pets.nvim-π-credits| ============================================================================== 1. pets.nvim *pets.nvim-pets.nvim* @@ -23,127 +16,7 @@ terminal window. As you might know the plugin is heavily inspired by vscode-pets <https://github.com/tonybaloney/vscode-pets/tree/master/media>. If you like the art for the pets, check out the |pets.nvim-credits| section. -<div class="figure"> -<img src="./pets.gif" title="fig:"/> -<p class="caption">pets.gif</p> -</div> -π¦ INSTALLATION *pets.nvim-π¦-installation* - -Install with your favorite package manager! - -Examples: - -With packer: - -> - use({ - "giusgad/pets.nvim", - requires = { - "edluffy/hologram.nvim", - "MunifTanjim/nui.nvim", - } - }) -< - - -With lazy: - -> - { - "giusgad/pets.nvim", - dependencies = { "MunifTanjim/nui.nvim", "edluffy/hologram.nvim" }, - } -< - - -And then call - -> - require("pets").setup({ - -- your options here - }) -< - - -βοΈ CONFIGURATION *pets.nvim-βοΈ-configuration* - -This is the default configuration: - -> - { - row = 1, -- the row (height) to display the pet at (must be at least 1 and at most 10) - col = 0, -- the column to display the pet at (set to high number to have it stay still on the right side) - speed_multiplier = 1, -- you can make your pet move faster/slower. If slower the animation will have lower fps. - default_pet = "cat", -- the pet to use for the PetNew command - default_style = "brown", -- the style of the pet to use for the PetNew command - random = false, -- wether to use a random pet for the PetNew command, ovverides default_pet and default_style - death_animation = true, -- animate the pet's death, set to false to feel less guilt - popup = { -- popup options, try changing these if you see a rectangle around the pets - width = "30%", -- can be a string with percentage like "45%" or a number of columns like 45 - winblend = 100, -- winblend value - see :h 'winblend' - only used if avoid_statusline is false - hl = { Normal = "Normal" }, -- hl is only set if avoid_statusline is true, you can put any hl group instead of "Normal" - avoid_statusline = false, -- if winblend is 100 then the popup is invisible and covers the statusline, if that - -- doesn't work for you then set this to true and the popup will use hl and will be spawned above the statusline (hopefully) - } - } -< - - -β FAQ - IF THINGS DONβT WORK ~ - - -- If the pet is not at the height you desire change the row option -- If youβre seeing a square around the pets, try setting avoid_statusline to true and/or winblend to 0. - If this doesnβt work then open an issue and Iβll try to look into it when I can. - - -πΎ AVAILABLE PETS *pets.nvim-πΎ-available-pets* - - -- cat: - - black - - red - - brown - - dark_grey - - light_grey - - -π USAGE - COMMANDS *pets.nvim-π-usage---commands* - -These are all the available commands: - `PetsNew {name}`: creates a pet with -the style and type defined by the configuration, and name {name} - -`PetsNewCustom {type} {style} {name}`: creates a new pet with type, style and -name specified in the command - `PetsList`: prints the names of all the pets -that are currently alive - `PetsKill {name}`: kills the pet with given name, -which will immediately blink out of existence. Forever. - `PetsKillAll`: kills -all the pets, poor creatures. Works just as PetsKill but for every pet. - -`PetsPauseToggle`: pause/resume animations for all pets, leaving them on screen -as cute little statues - `PetsHideToggle`: pause the animation for all pets and -hide them / show all the pets again and resume animations - `PetsSleepToggle`: -basically a do-not-disturb mode, pets are still animated but do not move around - -β οΈ LIMITATIONS *pets.nvim-β οΈ-limitations* - -This plugin relies on hologram.nvim <https://github.com/edluffy/hologram.nvim> -to display the images, and shares all of its limitations. Here are the most -significant ones: - Only works with terminal emulators that support the kitty -graphics protocol <https://sw.kovidgoyal.net/kitty/graphics-protocol/> To be -more precise the only terminal I tested where I was able to have the protocol -working correctly is kitty itself. - Doesnβt currently work inside tmux - -βοΈ ROADMAP *pets.nvim-βοΈ-roadmap* - - -- β Handle window resizes -- β add more pets -- β add an option to change the petβs size - - -π CREDITS *pets.nvim-π-credits* - -All the beautiful cat assets were designed by SeethingSwarm -<https://seethingswarm.itch.io/catset> Generated by panvimdoc <https://github.com/kdheepak/panvimdoc> |