https://github.com/fireisgood/pond.nvim
Fishing mini game for Neovim
https://github.com/fireisgood/pond.nvim
neovim nvim-plugin
Last synced: about 2 months ago
JSON representation
Fishing mini game for Neovim
- Host: GitHub
- URL: https://github.com/fireisgood/pond.nvim
- Owner: FireIsGood
- License: mit
- Created: 2024-05-19T08:05:24.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-27T03:01:43.000Z (about 2 years ago)
- Last Synced: 2026-03-05T04:11:57.385Z (3 months ago)
- Topics: neovim, nvim-plugin
- Language: Lua
- Homepage:
- Size: 25.4 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pond.nvim
Fishing mini game. Wildly unbalanced.
> [!WARNING]
> Why though?
## Installation
```lua
-- 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` | `af` | Fish |
| `:FishBalance` | `ab` | Check your balance |
| `:FishResetAccount` | | Reset your account |
## Configuration
The `.setup()` call is optional if you are fine with the defaults below.
```lua
-- 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 (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:
```lua
-- 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????