FireIsGood/pond.nvim

Fishing mini game for Neovim

★ 2Forks 0LuaGitHub ↗Compare
neovimnvim-plugin

README

pond.nvim

Fishing mini game. Wildly unbalanced.

Warning

Why though?

Installation

-- lazy.nvim
{
  "FireIsGood/pond.nvim",
  lazy = false,
  config = true,
},

-- packer
use "FireIsGood/pond.nvim"

Usage

Use the commands or the builtin keymaps.

Command Keymap Description
:Fish <leader>af Fish
:FishBalance <leader>ab Check your balance
:FishResetAccount Reset your account

Configuration

The .setup() call is optional if you are fine with the defaults below.

-- default config
require("pond-nvim").setup({
  -- Name of your fisher (cosmetic)
  name = "Unnamed Fisher",

  -- Cooldown for fishing in seconds
  cooldown = 5,

  -- Use the default keymaps (<leader>af, etc.)
  use_default_keymaps = true,

  -- Save data location
  data_path = vim.fn.stdpath("data") .. "/pond-data.json",
})

The data_path variable is expanded, so you can use ~ as short for your home directory.

Example configuration:

-- lazy.nvim
{
  "FireIsGood/pond.nvim",
  lazy = false,
  opts = {
    name = "The Coolest Fisher"
    cooldown = 0,
    use_default_keymaps = false,
    data_path = "~/Desktop/my_cool_fishery_data.json",
  }
},

-- packer
use {
  "FireIsGood/pond.nvim"
  config = function ()
    require("pont-nvim").setup({
      name = "The Coolest Fisher",
      cooldown = 0,
      use_default_keymaps = true,
      data_path = "~/Desktop/my_cool_fishery_data.json",
    })
  end,
}

Contributing

Huh????

Contributors

FireIsGood

Issues