https://github.com/sayanarijit/plugin-template1.xplr
xplr plugin template
https://github.com/sayanarijit/plugin-template1.xplr
Last synced: about 2 months ago
JSON representation
xplr plugin template
- Host: GitHub
- URL: https://github.com/sayanarijit/plugin-template1.xplr
- Owner: sayanarijit
- License: mit
- Created: 2021-06-24T04:39:11.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-09T10:02:38.000Z (almost 3 years ago)
- Last Synced: 2024-10-29T10:55:50.297Z (12 months ago)
- Language: Lua
- Homepage: https://xplr.dev/en/writing-plugins
- Size: 7.81 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# xplr plugin template
Use this template to [write your own xplr plugin](https://arijitbasu.in/xplr/en/writing-plugins.html).
> **NOTE:** The `src` directory is a symlink to `.` for compatibility reasons.
> It may be removed in the future.
## Requirements
- Some tool
## Installation
### Install manually
- Add the following line in `~/.config/xplr/init.lua`
```lua
local home = os.getenv("HOME")
package.path = home
.. "/.config/xplr/plugins/?/init.lua;"
.. home
.. "/.config/xplr/plugins/?.lua;"
.. package.path
```
- Clone the plugin
```bash
mkdir -p ~/.config/xplr/plugins
git clone https://github.com/{username}/{plugin}.xplr ~/.config/xplr/plugins/{plugin}
```
- Require the module in `~/.config/xplr/init.lua`
```lua
require("{plugin}").setup()
-- Or
require("{plugin}").setup{
mode = "action",
key = ":",
}
-- Type `::` and enjoy.
```
## Features
- Some cool feature