Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mertgunduz/yiffy
tui app for searching/downloading/fetching images from e621/e926
https://github.com/mertgunduz/yiffy
e621 e621-downloader e926 furry furry-app furry-fandom furry-linux linux terminal-user-interface tui tui-app yiff yiffy
Last synced: about 2 months ago
JSON representation
tui app for searching/downloading/fetching images from e621/e926
- Host: GitHub
- URL: https://github.com/mertgunduz/yiffy
- Owner: MertGunduz
- License: gpl-3.0
- Created: 2023-07-03T23:28:55.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-19T13:18:42.000Z (8 months ago)
- Last Synced: 2024-05-19T14:30:59.659Z (8 months ago)
- Topics: e621, e621-downloader, e926, furry, furry-app, furry-fandom, furry-linux, linux, terminal-user-interface, tui, tui-app, yiff, yiffy
- Language: C
- Homepage: https://mertgunduz.github.io/yiffy/
- Size: 10.8 MB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Roadmap: ROADMAP.md
Awesome Lists containing this project
README
# yiffy
## E621/E926 Search and Download TUI App
**Yiffy** is a basic Text User Interface (TUI) application developed to provide the process of searching, fetching, and downloading images from [e621](https://e621.net/) and [e926](https://e926.net/).
## Table of Contents
- [Dependencies](#dependencies)
- [Manual Build Instructions](#manual-build-instructions)
- [Guide to Yiffy Commands](#guide-to-yiffy-commands)
- [Search and TUI (Text User Interface)](#search-and-tui-text-user-interface)
- [API Fetch and Download](#api-fetch-and-download)
- [Information and Help](#information-and-help)
- [Data Management](#data-management)
- [Configuration and Settings](#configuration-and-settings)
## Dependencies
### Mandatory Dependencies:
- `gcc`: The [GNU Compiler Collection](https://gcc.gnu.org/)
- `ascii-image-converter`: Convert images to ASCII art with this [tool](https://github.com/TheZoraiz/ascii-image-converter)
- `aria2`: A versatile [command-line download utility](https://aria2.github.io/)
- `cmake`: Cross-platform tools for [software building](https://cmake.org/)
- `make`: A utility to maintain groups of programs
- `libncurses-dev`: Developer’s libraries for [ncurses](https://invisible-island.net/ncurses/ncurses.html)
### Optional Dependencies:
- `tiv`: [Terminal ImageViewer](https://github.com/stefanhaustein/TerminalImageViewer), a tool to display images in the terminal.
- `timg`: [Terminal Image and Video Viewer](https://github.com/hzeller/timg), a tool to display images/videos in the terminal.
## Manual Build Instructions
Follow these steps to compile and install Yiffy manually:
```text
git clone https://github.com/MertGunduz/yiffy.git
cd yiffy
mkdir build && cd build
cmake ..
make
sudo cmake --install .
```
## Guide to Yiffy Commands
### Search and TUI (Text User Interface)
*Interact with the application through a user-friendly interface*
- **yiffy search tui argument:**
- `--search "tag1+tag2"`: Enhance your search experience with an intuitive TUI.
### API Fetch and Download
*Quickly fetch and download images based on tags*
- **yiffy api fetch arguments:**
- `--fetch "tag1+tag2"`: Retrieve URLs based on specified tags.
- `--dfetch "tag1+tag2"`: Fetch URLs and download the images instantly.
### Information and Help
*Get help and information about Yiffy*
- **yiffy information menu arguments:**
- `--help`: Access a guide and list of commands.
- `--version`: Check the current version of Yiffy.
- `--github`: Visit the [Yiffy GitHub repository](https://github.com/MertGunduz/yiffy).
- `--config`: Open the configuration menu.
### Configuration
*Adjust settings and configurations as per your preference*
- **yiffy configuration and credential arguments:**
- `--nsfw "on/off"`: Toggle NSFW (Not Safe for Work) and SFW (Safe For Work) content.
- `--ivcommand "cmd"`: Set the command used to view images in search system.
- `--uname "uname"`: Set the uname used to send API requests.
- `--apikey "apikey"`: Set the API key used to send API requests.