Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nsxiv/nsxiv-extra

Read-only mirror of nsxiv-extra
https://github.com/nsxiv/nsxiv-extra

Last synced: 3 months ago
JSON representation

Read-only mirror of nsxiv-extra

Awesome Lists containing this project

README 

        
# nsxiv-extra



[![Codeberg](https://img.shields.io/badge/Hosted_at-Codeberg-%232185D0?style=flat-square&logo=Codeberg)](https://codeberg.org/nsxiv/nsxiv-extra)



[This repo](https://codeberg.org/nsxiv/nsxiv-extra) is used for hosting

community patches, user scripts, tips and tricks, etc.



* For general information on nsxiv, please consult the

  [nsxiv readme](https://codeberg.org/nsxiv/nsxiv).

* For detailed information, please consult the [manpage](https://nsxiv.codeberg.page/man/).

* For information on how to manage patches and customization, please see

  [CUSTOMIZATION](CUSTOMIZATION.md).



- - -



NOTE: All patches and scripts in this repository are community submitted and

maintained. Mainline nsxiv does not make any guarantee that there won't be

merge conflicts or broken functionality on upgrade.



## Community patches



| Name | Comments |

| :--  | :--      |

| [alpha](patches/alpha) | Add alpha/transparency to nsxiv |

| [dmenu-mode](patches/dmenu-mode) | Add dmenu mode to nsxiv |

| [env-theme](patches/env-theme) | Change colors and font via env variables |

| [image-mode-cycle](patches/image-mode-cycle) | Cycle when viewing multiple images |

| [nav-dir](patches/nav-dir) | Jump to next/prev directory |

| [random-image](patches/random-image) | Switch to a random image |

| [toggle-winbg](patches/toggle-winbg) | Keybinding to toggle the window background color |

| [zoom-per-image](patches/zoom-per-image) | Remember what the zoom for image was |

| [cache-whitelist](patches/cache-whitelist) | Write thumbnail cache only on whitelisted directories |

| [dmenu-search](patches/dmenu-search) | Search the filelist using `dmenu` |

| [color-invert](patches/color-invert) | Invert image colors |

| [square-thumbs](patches/square-thumbs) | Toggleable square thumbnails |



For patch submissions please use the following format:



* name-[BASE].ext



`name` is simply the name of the patch and `.ext` is the extension, which

can be either `.diff` or `.patch`. `[BASE]` corresponds to either the version

or the seven chars git commit short hash corresponding to the last commit on

which the patch can be applied correctly and is tested to work with.



## User scripts



Some examples scripts which add new and commonly requested functionality to

nsxiv. These are meant to be minimal examples, users are encouraged to modify

them to fit their use-cases.



| Name | Comments |

| :--  | :--      |

| [nsxiv-env](scripts/nsxiv-env) | Pass arguments to nsxiv using environment variables. |

| [nsxiv-url](scripts/nsxiv-url) | Open remote files. |

| [nsxiv-rifle](scripts/nsxiv-rifle) | Open all images in a directory. |

| [nsxiv-saver](scripts/nsxiv-saver) | Use nsxiv as a xsecurelock screensaver. |

| [subtube](https://github.com/nagy135/subtube) | Watch subscribed youtubed videos. |

| [nsxiv-pipe](scripts/nsxiv-pipe) | Pipe images into nsxiv |

| [nsxiv-thumb](scripts/nsxiv-thumb) | Select videos to open in the current directory. |

| [nsxiv-anti-alias](scripts/nsxiv-anti-alias) | Automatically toggle anti-aliasing based on image resolutions. |

| [nsxiv-open](scripts/nsxiv-open) | Try to open every given file with nsxiv by transforming them. |

| [nsxiv-fill](scripts/nsxiv-fill) | Set nsxiv's window size equal to the image being opened. |

| [nsxiv-cb](scripts/nsxiv-cb) | Open image archives (comic books) |

| [sxiv-manga-reader](https://git.sr.ht/~q3cpma/sxiv-manga-reader) | Similar to `nsxiv-cb` but has a different set of dependencies and features (requires patching nsxiv) |

| [misc](scripts/MISC.md) | Misc oneliners and other useful scripts. |



For script submissions, it is highly encouraged (but not required) to use POSIX

`sh` rather than `bash`, `zsh`, `Python`, etc.



## Exec excerpts



The [exec](./exec) directory contains idioms, excerpts or full examples for

`image-info`, `key-handler`, `thumb-info` and `win-title`.



## Shell Completion



- [zsh](completion/zsh)

- fish: Can be auto-generated by running `fish -c fish_update_completions`



## Misc



| Name | Comments |

| :--  | :--      |

| [appstream](etc/appstream-metainfo) | metadata file that allows nsxiv to show up in appstream software centers. |



## Contributing



To contribute, sumbit a pull request at [Codeberg][pr].

Alternatively you may e-mail the patch (obtained via `git format-patch`) to any

of the [active maintainers][am] instead.



[pr]: https://codeberg.org/nsxiv/nsxiv-extra/pulls

[am]: https://nsxiv.codeberg.page/man/#CURRENT%20MAINTAINERS



One of easiest way to contribute is to look for failing patches and rebasing

them on `nsxiv` master. Take a look at the [Codeberg CI][ci] to get a list of

failing patches.



[ci]: https://ci.codeberg.org/nsxiv/nsxiv-extra/



Feel free to add yourself to the list of "Authors" if you contribute to

anything. You may also add some form of contact detail if you wish

(preferably email, but can be anything else).



## Issues



Since this repo is community maintained there's no guarantee that an issue will

be worked on. If you run into any problems with any of the patches/scripts, try to

fix it yourself and submit a pull request.



You may also open an issue for a request, but as stated above, there's no guarantee.



***NOTE***: Issues should be opened at [Codeberg](https://codeberg.org/nsxiv/nsxiv-extra/issues)