README.md

   1 # Local nHentai
   2 This is a collection of Node.js scripts that can be used to manage a local nhentai library.
   3
   4 # Install instructions
   5 Dependencies:
   6
   7 - `fzf`: [repo](https://github.com/junegunn/fzf), or `sudo apt install fzf`
   8 - `ueberzug`: [repo](https://github.com/seebye/ueberzug), or `pip3 install ueberzug`
   9 - `nhentai`: [repo](https://github.com/RicterZ/nhentai)
  10 - `npm`
  11 - `firefox`
  12
  13 Remember to install NPM deps: `npm install`
  14
  15 # Usage
  16
  17 `nhentai --id ${id}`: Download a doujin.
  18
  19 `node symlinks.js`: Updates symlinks. Must be run whenever new doujins have been added, otherwise they will not be seen by the other scripts.
  20
  21 `node select.js`: Open fzf/überzug menu to select a doujin. Shows a list of tags first. When a tag is selected, shows all doujins with that tag and lets the user select one, displaying the thumbnails of the doujins at the side. The "\*" tag can be used to search/select from all doujins.
  22
  23 `node multiple-tags.js <tag1> <tag2> ...`: Open fzf/überzug menu with doujins that match all given tags (tags separated by whitespace).
  24
  25 `node stats-doujins.js`: Displays number of downloaded doujins, total size and average size per doujin
  26
  27 `node stats-tags.js`: Displays tags sorted by how many doujins are available for each tag. May produce long output, you might want to pipe it into `head`, `grep` or `less`.
  28
  29 `node scrape-wholesome.js`: Scrapes [wholesome hentais](https://wholesomelist.com/list). This takes a long time since it's about 2700 hentais in total (consumes about 32GB of disk space), but you can abort it any time (and resume it later).
  30
  31 `node scrape.js <criterium> <value>`: Scrapes doujins by criterium, where criterium can be tag, artist, character, parody or group and value is the value. E.g. `node scrape.js tag full-color` scrapes fully colored doujins.
  32
  33 Note: you might want to create a subdirectory and put the doujins into there, they will all be put into the current working directory. (Run the scripts from a different directory to prevent spamming this directory)
  34 Of course, you can also run these scripts in a directory where you already downloaded doujins using the `nhentai` tool, but make sure to run the symlinks script to "register" them all in the system.
  35
  36 # Notes
  37
  38 `./fzf-previews` taken from [fzf-ueberzogen](https://github.com/seebye/fzf-ueberzogen) with slight modifications.
  39
  40 Happy scraping and jerking!