nnn/plugins/README.md

To extend the capabilities of `nnn`, plugins are introduced. Plugins are scripts which `nnn` can communicate with and trigger. This mechanism fits perfectly with the fundamental design to keep the core file manager lean and fast, by delegating repetitive (but not necessarily file manager-specific) tasks to the plugins.

The currently available plugins are listed below.

| Plugin (a-z) | Lang | Deps | Description |
| --- | --- | --- | --- |
| boom | sh | SMPlayer | Play random music from dir (modify `PLAYER`) |
| checksum | sh | md5sum,<br>sha256sum | Create and verify checksums |
| fzy-edit | sh | fzy | Fuzzy find a file in directory subtree and edit in vim |
| fzy-open | sh | fzy | Fuzzy find a file in directory subtree and open using xdg-open |
| getplugs | sh | wget | Update plugins |
| hexview | sh | xxd | View a file in hex in `$PAGER` |
| imgresize | sh | [imgp](https://github.com/jarun/imgp) | Resize images in directory to screen resolution |
| imgur | bash | - | Upload an image to imgur (from [imgur-screenshot](https://github.com/jomo/imgur-screenshot)) |
| ipinfo | sh | curl, whois | Fetch external IP address and whois information |
| kdeconnect | sh | kdeconnect-cli | Send selected files to an Android device |
| mocplay | sh | [moc](http://moc.daper.net/) | Appends (and plays, see script) selection/dir/file in moc|
| ndiff | sh | vimdiff | Diff for selection (limited to 2 for directories) |
| nmount | sh | pmount, udisks2 | Toggle mount status of a device as normal user |
| nwal | sh | nitrogen | Set the selected image as wallpaper using nitrogen |
| pastebin | sh | [pastebinit](https://launchpad.net/pastebinit) | Paste contents of (text) file to paste.ubuntu.com |
| pdfview | sh | pdftotext/<br>mupdf-tools | View PDF file in `$PAGER` |
| picker | sh | nnn | Pick files and pipe the newline-separated list to another utility |
| pywal | sh | pywal | Set selected image as wallpaper, change terminal color scheme |
| readit | sh | pdftotext, mpv,<br>pico2wave | Read a PDF or text file aloud |
| ringtone | sh | date, ffmpeg | Create a variable bitrate mp3 ringtone from file |
| splitjoin | sh | split, cat | Split file or join selection |
| sxiv | sh | sxiv | Browse images in a dir in sxiv, set wallpaper, copy path ([config](https://wiki.archlinux.org/index.php/Sxiv#Assigning_keyboard_shortcuts))|
| thumb | sh | [lsix](https://github.com/hackerb9/lsix) | View thumbnail of an image or dir of images |
| transfer | sh | curl | Upload file to transfer.sh |
| upgrade | sh | wget | Upgrade to latest nnn version manually on Debian 9 Stretch |
| viuimg | sh | [viu](https://github.com/atanunq/viu), less | View an image or images in a directory |

#### Installing plugins

Download the `getplugs` plugin and execute it anywhere to get all the plugins installed to `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`. You can run it again later to update the plugins. It backs up earlier plugins.

**NOTE:** `getplugs` also downloads the launcher `nlaunch` and tries to place it at `/usr/local/bin/` using `sudo`. If it fails you have to place `nlauch` manually somewhere in your `$PATH`.

#### File access from plugins

Plugins can access:
- all files in the directory (`nnn` switches to the dir where the plugin is to be run so the dir is `$PWD` for the plugin)
- the current file under the cursor (the file name is passed as the argument to a plugin)
- the current selection (by reading the file `.selection` in config dir, see the plugin `ndiff`)

Each script has a _Description_ section which provides more details on what the script does, if applicable.

#### Usage

Use the _pick plugin_ shortcut to visit the plugin directory and execute a plugin. Repeating the same shortcut cancels the operation and puts you back in the original directory.

#### Contributing plugins

Plugins are scripts and all scripting languages should work. However, POSIX-compliant shell scripts runnable in `sh` are preferred. If that's too rudimentary for your use case, use Python, Perl or Ruby. Please keep non-portable commands (like `notify-send`) commented so users from any other OS/DE aren't surprised.

The plugins should be executable. Please add an entry in the table above.
Update docs 2019-06-26 06:15:33 +00:00			To extend the capabilities of `nnn`, plugins are introduced. Plugins are scripts which `nnn` can communicate with and trigger. This mechanism fits perfectly with the fundamental design to keep the core file manager lean and fast, by delegating repetitive (but not necessarily file manager-specific) tasks to the plugins.

			`The currently available plugins are listed below.`

Plugins! 2019-04-18 14:57:35 +00:00			`\| Plugin (a-z) \| Lang \| Deps \| Description \|`
Update docs 2019-04-18 04:59:47 +00:00			`\| --- \| --- \| --- \| --- \|`
Update plugins 2019-06-07 03:14:49 +00:00			\| boom \| sh \| SMPlayer \| Play random music from dir (modify `PLAYER`) \|
Pretty table 2019-06-23 03:48:35 +00:00			`\| checksum \| sh \| md5sum,<br>sha256sum \| Create and verify checksums \|`
Plugin getplugs: update nnn plugins 2019-04-19 13:34:20 +00:00			`\| fzy-edit \| sh \| fzy \| Fuzzy find a file in directory subtree and edit in vim \|`
			`\| fzy-open \| sh \| fzy \| Fuzzy find a file in directory subtree and open using xdg-open \|`
			`\| getplugs \| sh \| wget \| Update plugins \|`
Update plugins, add mutool to view PDF 2019-05-31 18:47:19 +00:00			\| hexview \| sh \| xxd \| View a file in hex in `$PAGER` \|
Update docs 2019-04-18 04:59:47 +00:00			`\| imgresize \| sh \| [imgp](https://github.com/jarun/imgp) \| Resize images in directory to screen resolution \|`
Update docs 2019-04-18 15:28:14 +00:00			`\| imgur \| bash \| - \| Upload an image to imgur (from [imgur-screenshot](https://github.com/jomo/imgur-screenshot)) \|`
ipinfo shows external IP address 2019-05-24 17:44:19 +00:00			`\| ipinfo \| sh \| curl, whois \| Fetch external IP address and whois information \|`
Update docs 2019-04-18 04:59:47 +00:00			`\| kdeconnect \| sh \| kdeconnect-cli \| Send selected files to an Android device \|`
Add plugin to play music in MOC 2019-06-03 12:56:53 +00:00			`\| mocplay \| sh \| [moc](http://moc.daper.net/) \| Appends (and plays, see script) selection/dir/file in moc\|`
Refactored splitjoin and ndiff plugins, made them POSIX compliant 2019-06-20 08:45:24 +00:00			`\| ndiff \| sh \| vimdiff \| Diff for selection (limited to 2 for directories) \|`
Update plugins, add mutool to view PDF 2019-05-31 18:47:19 +00:00			`\| nmount \| sh \| pmount, udisks2 \| Toggle mount status of a device as normal user \|`
Update docs 2019-04-18 04:59:47 +00:00			`\| nwal \| sh \| nitrogen \| Set the selected image as wallpaper using nitrogen \|`
Update plugins 2019-06-07 03:14:49 +00:00			`\| pastebin \| sh \| [pastebinit](https://launchpad.net/pastebinit) \| Paste contents of (text) file to paste.ubuntu.com \|`
Pretty table 2019-06-23 03:48:35 +00:00			\| pdfview \| sh \| pdftotext/<br>mupdf-tools \| View PDF file in `$PAGER` \|
Update docs 2019-04-18 04:59:47 +00:00			`\| picker \| sh \| nnn \| Pick files and pipe the newline-separated list to another utility \|`
			`\| pywal \| sh \| pywal \| Set selected image as wallpaper, change terminal color scheme \|`
Pretty table 2019-06-23 03:48:35 +00:00			`\| readit \| sh \| pdftotext, mpv,<br>pico2wave \| Read a PDF or text file aloud \|`
Add an mp3 ringtone generator 2019-06-21 17:06:34 +00:00			`\| ringtone \| sh \| date, ffmpeg \| Create a variable bitrate mp3 ringtone from file \|`
Refactored splitjoin and ndiff plugins, made them POSIX compliant 2019-06-20 08:45:24 +00:00			`\| splitjoin \| sh \| split, cat \| Split file or join selection \|`
Update docs 2019-04-18 15:28:14 +00:00			`\| sxiv \| sh \| sxiv \| Browse images in a dir in sxiv, set wallpaper, copy path ([config](https://wiki.archlinux.org/index.php/Sxiv#Assigning_keyboard_shortcuts))\|`
Show image thumbnails with lsix 2019-07-11 18:33:10 +00:00			`\| thumb \| sh \| [lsix](https://github.com/hackerb9/lsix) \| View thumbnail of an image or dir of images \|`
Update plugins 2019-06-07 03:14:49 +00:00			`\| transfer \| sh \| curl \| Upload file to transfer.sh \|`
Update docs 2019-04-18 04:59:47 +00:00			`\| upgrade \| sh \| wget \| Upgrade to latest nnn version manually on Debian 9 Stretch \|`
Add plugin to view image and browse image dir 2019-05-31 19:29:59 +00:00			`\| viuimg \| sh \| [viu](https://github.com/atanunq/viu), less \| View an image or images in a directory \|`
Update docs 2019-04-18 04:59:47 +00:00
Update docs 2019-04-30 03:06:55 +00:00			`#### Installing plugins`

Fix #288 2019-06-20 13:40:47 +00:00			Download the `getplugs` plugin and execute it anywhere to get all the plugins installed to `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`. You can run it again later to update the plugins. It backs up earlier plugins.
Update docs 2019-04-30 03:06:55 +00:00
Update getplugs to set up nlauch 2019-05-05 02:50:35 +00:00			NOTE: `getplugs` also downloads the launcher `nlaunch` and tries to place it at `/usr/local/bin/` using `sudo`. If it fails you have to place `nlauch` manually somewhere in your `$PATH`.
Update docs 2019-04-30 03:06:55 +00:00
Update docs 2019-04-18 15:28:14 +00:00			`#### File access from plugins`
Update docs 2019-04-18 04:59:47 +00:00
Update docs 2019-04-18 15:28:14 +00:00			`Plugins can access:`
Plugins! 2019-04-18 14:57:35 +00:00			- all files in the directory (`nnn` switches to the dir where the plugin is to be run so the dir is `$PWD` for the plugin)
Update docs 2019-04-21 18:37:48 +00:00			`- the current file under the cursor (the file name is passed as the argument to a plugin)`
Fix #288 2019-06-20 13:40:47 +00:00			- the current selection (by reading the file `.selection` in config dir, see the plugin `ndiff`)
Update docs 2019-04-18 04:59:47 +00:00
Plugin ipinfo: fetch IP address and whois info 2019-04-20 07:37:04 +00:00			`Each script has a _Description_ section which provides more details on what the script does, if applicable.`

Update docs 2019-06-03 04:57:01 +00:00			`#### Usage`

			`Use the _pick plugin_ shortcut to visit the plugin directory and execute a plugin. Repeating the same shortcut cancels the operation and puts you back in the original directory.`

Update docs 2019-04-18 15:28:14 +00:00			`#### Contributing plugins`
Update docs 2019-04-18 04:59:47 +00:00
Plugins! 2019-04-18 14:57:35 +00:00			Plugins are scripts and all scripting languages should work. However, POSIX-compliant shell scripts runnable in `sh` are preferred. If that's too rudimentary for your use case, use Python, Perl or Ruby. Please keep non-portable commands (like `notify-send`) commented so users from any other OS/DE aren't surprised.
Update docs 2019-04-18 04:59:47 +00:00
Plugins! 2019-04-18 14:57:35 +00:00			`The plugins should be executable. Please add an entry in the table above.`